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 you don’t know where to start, this page sets the route from 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 the 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 Platform architecture for how components are structured and how they interact.


Installation → First login → Providers → User access → First client cluster → Health monitoring

Step 1: Install the management cluster

Time: 20–90 minutes (depends on environment, provider, and number of nodes)

What you do: Choose the license edition, review requirements and installation preparation, then deploy the management cluster with the shtil utility following Installation process.

Key actions:

  1. License — how to obtain a CE or Enterprise license is described on License types.

  2. Requirements and preparation — platform requirements, installation preparation; for a closed environment — working with a mirror; for an open environment with public Ingress — TLS Let’s Encrypt.

  3. Installation — follow Installation process or installation with shtil (including with OpenStack and oVirt providers).

Step 2: First login and verification

Time: 5–10 minutes

What you do: Log in to the graphical interface, verify that the management cluster is in Ready status, and save the kubeconfig and credentials.

Key actions:

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

  2. Verify that the management cluster appears under Clusters with Ready status (green checkmark).

  3. Save the kubeconfig: arrow next to the username → Download Kubeconfig; see also kubeconfig access.

  4. Save the admin password; change it if needed using the instructions in access management.

If the temporary bootstrap cluster is no longer needed, remove it using Temporary cluster deinstallation.

Step 3: Configure providers and IP pool

Time: 20–60 minutes (depends on provider)

What you do: Following the provider overview, prepare the chain IP pool → provider instance → VM template so you can create client clusters.

Key actions:

  1. IP address pool: Providers → IP address pools → Add pool — see IP address pools.

  2. Provider: Providers → Provider configuration → Add instance. The full list of types is on About providers. Documentation by type: VMware vSphere, oVirt and oVirt-like platforms, OpenStack, VK Cloud, and Selectel, VMware vCloud Director, Yandex Cloud, Basis Dynamix, Shturval v2.

  3. VM template — follow the template preparation guide if your provider uses images or templates.

Step 4: Configure user access

Time: 15–45 minutes (depends on LDAP or OIDC)

What you do: Choose the user login scenario: LDAP or OIDC (Keycloak/Blitz), then assign permissions.

Options:

Key actions:

  1. Connect LDAP (Access management → LDAP integration) or OIDC in Platform authentication / via PatchSSC of the shturval-auth module (see connecting external providers).

  2. Create permission sets if needed: Access management → Access manager — see roles and permissions.

  3. Assign permissions on an object (platform, cluster, namespace) — access management.

Step 5: Create the first client cluster

Time: 20–60 minutes (cluster deployment)

What you do: Before starting the wizard, review client cluster requirements. Create a cluster via Clusters → Create cluster: provider, VIP/API, subnets, nodes, certificate, and services.

Step-by-step checklist — Creating a cluster; wizard fields by provider — providers.

Key actions:

  1. Clusters → Create cluster.

  2. Select provider and instance.

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

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

  5. Select certificate (including Let’s Encrypt for open environments) and services (monitoring, logging, Velero, and others).

  6. Start creation and wait for Cluster ready status.

Step 6: Monitor cluster health

Time: 5–15 minutes per day (regular checks)

What you do: Regularly check node and workload status on the cluster dashboard, preinstalled Grafana dashboards, and alert triggers and channel configuration in alerting.

Key locations:

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

  • Statistics — link to metrics (Grafana).

  • Alerts — rules and alert views for metrics and logs.

← Operating system requirements
Load balancer requirements →