Quick start

From installation to the first client cluster and basic monitoring in 6 steps.

Who is this page for?

If this is your first time working with the Shturval platform and don’t know where to start, this page sets the route from an empty infrastructure to a fully configured platform with client clusters.

General scheme

The Shturval platform is a management cluster that creates and manages client clusters (workload clusters). First, you install a management cluster, then configure infrastructure providers (VMware vSphere, oVirt and oVirt-like platforms, OpenStack, VK Cloud, Selectel, Shturval v2, and others) and create client clusters. See the Platform Architecture page to see how the components are structured and how they interact.


Installation → First Login → Providers → User Access → First Client Cluster → Health Control

Step 1: Installing the Management Cluster

Time: 20–90 minutes (depending on circuit, provider and number of nodes)

What you do: Select the edition and source of the license, check the requirements and prepare the environment for the selected installation type (open or closed), then deploy the shtil utility management cluster (scenarios with GUI, via CLI flags and via YAML are described in the “Installation Process” page of the corresponding circuit).

Key Actions:

  1. License — how to obtain a CE or Enterprise license: License types.

  2. Requirements and preparation - for an open loop: pages Requirements and Preparing for installation; for a closed loop: Requirements and Preparing for installation.

  3. Installation - Follow the Open Loop Installation Process or Closed Loop Installation Process page.

Step 2: First login and verification

Time: 5–10 minutes

What you do: Enter the GUI, make sure that the management cluster is in the “Ready” status, save kubeconfig and credentials. In order not to miss the required steps after the installer, see the “First steps after installation” block on the open loop process page (for your deployment type, see the table of contents installation).

Key Actions:

  1. Log in to the GUI using the URL (login admin, password - from the output shtil or the second line in $HOME/.shturval/installer/user.conf).

  2. Make sure that the management cluster is displayed in the Clusters section and has a status of “G"Otov” (green tick).

  3. Save kubeconfig: arrow next to username → Download Kubeconfig (clustername.conf); see also the overview of access methods from the console.

  4. Save the password admin; if necessary, change it according to the instructions How to change the password.

If the temporary bootstrap cluster is no longer needed, remove it using the instructions Uninstalling a temporary cluster.

Step 3: Configuring providers and IP pool

Time: 20–60 minutes (depending on provider)

What are you doing: According to the overview of working with providers, prepare a bunch of IP pool (section about address pools) → provider instance → VM template, in order to then create client clusters.

Key Actions:

  1. IP address pool (for scenarios with issuing VIP from a pool): Providers → IP address pools → Add pool; specify the range for VIP KubeAPI and Ingress (for example, 192.168.1.100–192.168.1.120).

  2. Provider: Providers → Providers Configuration → Add Instance. For the selected type, see the documentation: VMware vSphere, oVirt and similar, OpenStack and similar providers, VMware vCloud Director, Yandex Cloud, Basis Dynamix, Shturval v2.

  3. VM template - according to unified instructions for preparing a template, if your provider uses images or templates.

Step 4: Setting up user access

Time: 15–45 minutes (depending on the choice: LDAP or OIDC)

What you do: Based on the material “Where to start setting up access”, determine the user login scenario: LDAP (directory parameters) or OIDC (for example, Keycloak/Blitz - see external authentication providers), then assign rights.

Options:

Key Actions:

  1. Connect LDAP (Access Control → LDAP Integration) or OIDC through external provider setup / PatchSSC for the shturval-auth module.

  2. If necessary, create permission sets: Access Control → Access Manager.

  3. Assign rights: Assign access on the object (platform, cluster, notimespace) - the procedure is described in section on assigning access rights.

Step 5: Create the first client cluster

Time: 20–60 minutes (cluster deployment)

What you do: Before the wizard, check requirements for the client cluster (nodes, network, versions). Create a cluster via Clusters → Create Cluster: provider, VIP/API, subnets, nodes, certificate and services.

Step-by-step checklist and links to providers - in the scenario “First client cluster”; fields of the wizard by steps - on the provider pages inside cluster deployment and in the block “Details of installation wizard steps”.

Key Actions:

  1. Clusters → Create a cluster.

  2. Select a provider and instance.

  3. Fill in the name, Kubernetes version, API server address, VIP Ingress (from the pool, if applicable), pod and service subnets.

  4. Configure Control Plane (1 or 3 nodes) and Worker nodes (minimum 2).

  5. Select a certificate (including Let’s Encrypt for an open loop) and services (monitoring, logging, Velero, etc.).

  6. Start creation and wait for the “Cluster ready” status.

Step 6: Monitoring the status of clusters

Time: 5-15 minutes per day (regular check)

What you do: Regularly look at the status of nodes and loads on the cluster dashboard (Cluster, Nodes, Annotations, Events, Logs tabs), pre-installed Grafana dashboards, and triggers and channel settings in alert. A general monitoring checklist is in condition monitoring overview.

Key places:

  • Cluster dashboard - tabs Cluster, Nodes, Annotations, Events, Logs.

  • Statistics—go to metrics (Grafana).

  • Alerts — rules and viewing alerts based on metrics and logs.

← Tenant concept
Uninstalling the platform →