Installation process

Installation from GUI #

GUI installation consists of two stages: first shtil creates a local installation cluster, then the administrator configures the management cluster in the browser-based installation wizard.

The install-gui command is also available through the create-cluster and create synonyms.

Step 1: Start a local installation cluster #

For a closed loop, be sure to indicate the license and mirror address:

./shtil install-gui \
  --bootstrap-license="YOUR-LICENSE" \
  --bootstrap-registry="MIRROR ADDRESS"

If the mirror has a self-signed certificate, use one of the options.

Skip TLS mirror check:

./shtil install-gui \
  --bootstrap-license="YOUR-LICENSE" \
  --bootstrap-registry="MIRROR-ADDRESS" \
  --bootstrap-insecure

Pass the directory with trusted mirror certificates:

./shtil install-gui \
  --bootstrap-license="YOUR-LICENSE" \
  --bootstrap-registry="MIRROR-ADDRESS" \
  --bootstrap-registry-certs-dir="/path/to/certs"

Note: Important for Docker: if Docker is used on the shtil machine, the --bootstrap-insecure flag does not disable TLS checking at the primary stage docker pull: this check is performed by the Docker daemon before the bootstrap cluster is launched. Before running shtil configure mirror trust: add CA to /etc/docker/certs.d/<registry-host:port>/ca.crt or configure insecure-registries to /etc/docker/daemon.json, then restart Docker.

To immediately set the platform administrator password, add --password. The password must be at least 8 characters and contain a lowercase letter, an uppercase letter and a number.

./shtil install-gui \
  --bootstrap-license="YOUR-LICENSE" \
  --bootstrap-registry="MIRROR-ADDRESS" \
  --password="PASSWORD-ADMIN"

Basic launch parameters:

After a successful launch, the command displays a message about the start of the installer, the administrator account and the URL of the GUI.

Browser for the GUI - see browser requirements.

If shtil install-gui is launched on a remote Linux machine, open the installation wizard in a browser using the IP address or hostname of this machine, without first forwarding ports, for example, http://10.11.12.13:30080/.

Going by hostname is only possible if the DNS is configured to resolve the domain name to an IP address.

Life cycle of a local installer: the “Cancel installation” button in the installation wizard resets the completed cluster creation form and returns to the initialization screen; refreshing a page without canceling field data usually doesn’t reset. After successful installation of a permanent cluster, the temporary (bootstrap) cluster is not deleted automatically - if necessary, clean it according to the instructions Uninstalling a temporary cluster. If there is an error without --debug, the local installer container may be deleted; for diagnostics use ./shtil install-gui ... --debug.

Step 2: Open the installation wizard and fill out the parameters #

1. Open the GUI URL from the output of shtil.
2. Log in as an administrator.
3. Click Create Management Cluster.
4. Complete the installation wizard and click Create cluster at the data verification step.
5. Wait for the deployment to complete. Installation usually takes 20-60 minutes.

Do not close the browser tab until the installation is complete.

Step 1. Selecting a provider #

Note: the provider with which the platform is deployed will be installed in the platform as a critical service - it cannot be disabled. The remaining infrastructure providers in the platform will be disabled.

Before filling out the form, check the requirements of the selected provider: Shturval v2, VMware vSphere, oVirt and similar providers.

Step 2. Provider configuration #

Shturval v2 #

The Shturval v2 provider uses pre-prepared physical or virtual hosts. A VM template is not needed for this provider: the installation wizard connects to hosts via SSH and installs components on the selected hosts.

VMware vSphere #

For the VMware vSphere provider, use vCenter and the settings prepared before installation. Management cluster nodes will be created from VM template; if the template was not created in advance, prepare it according to the instructions and return to installation.

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

For oVirt and similar providers, use the Engine, network, and virtualization settings prepared before installation. Management cluster nodes will be created from VM template; if the template was not created in advance, prepare it according to the instructions and return to installation.

Step 3. Basic data #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Step 4. Configuring Control Plane nodes #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Step 5. Configuration of Worker nodes #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Step 6. Install the certificate #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Step 7. Selecting services #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Step 8. Data verification #

Shturval v2 #

VMware vSphere #

oVirt, zVirt, HostVM, ED Virtualization, ROSA Virtualization #

Management cluster installation status #

For a detailed description of status stages, color indication, node and service tables, see Cluster Deployment Status.

After the deployment starts, the management cluster installation status and stages are displayed on the screen.

Upon completion of the installation, you will automatically move to the “Cluster ready” stage. At this stage the following are available:

• static kubeconfig of the persistent management cluster - download and save it;
• link to switch to the permanent management cluster. To log in, use the platform administrator login and password received when you started the installation.

The management cluster installation is considered complete when the minimum requirements are met:

• infrastructure is ready;
• at least 1 Control Plane node is ready;
• services shturval-backend, shturval-auth, shturval-frontend, shturval-ingress-controller were successfully installed.

When kubeconfig and the link to the persistent cluster interface are already available, certain steps may still be in progress: for example, not all services may be installed or not all NCIs may be applied. You can wait for all stages to complete in the temporary cluster interface or check the status in the permanent cluster: NCI - on the Node Configuration page, if necessary, edit nodes through creating and working with NCI; services - on the Installed services page.

Installation of Shturval repository services is carried out in two stages: first, critical services are installed, then the services selected in the “Selecting services” step. The installation of Shturval repository services stage is considered completed only after installation of all services: critical and user-selected (for the composition and updating of registry artifacts, see repository services). For the management cluster, the status also displays the “Replication” stage with a list of replication conditions.