Cluster dashboard

The main cluster page in the GUI.

The cluster dashboard shows key cluster information and changes with the cluster lifecycle. Before deployment completes, a reduced view is shown. After deployment, when infrastructure is ready and all control plane and worker nodes are up, the full dashboard with all tabs and blocks is available.

Dashboard before deployment is complete #

When creating a client cluster, open Cluster → Client Clusters and select the cluster being created. Until deployment completes, the Dashboard page is available under Administration.

The cluster name appears at the top. Only the Cluster tab is available.

In the upper-left part of the Cluster tab, the Cluster deployment status block shows infrastructure readiness, control plane and worker node status, service installation, and NCI application on nodes (Node Configuration (NCI)). Data refreshes automatically. Click a stage to open the State block with details. See Cluster deployment status. The stages of installing services and applying NCI on the dashboard are displayed for tracking, but do not affect the transition to the Ready status and on the dashboard of deployed cluster. If the cluster reached a ready state before all services were installed or all NCIs were applied, completion can be verified in Node Configuration (NCI) and on the Installed Services page.

Dashboard of a deployed cluster #

The upper part displays the cluster name, creation date and time, status and conditions. Available tabs:

• Cluster
• Annotations
• Events
• Logs
• Certificates
• Metering
• Availability of services (with metrics collection enabled)

All tabs are updated automatically.

Navigation buttons (Statistics, Argo CD) #

Buttons for accessing external modules (with SSO authorization) are available on the dashboard:

• Statistics — opens Grafana (metrics visualization).
• Argo CD — opens the continuous delivery module (Argo CD). Buttons are displayed only if the corresponding services are installed and running, and the user has access rights to these services.

Administrator communication #

The cluster administrator can share announcements with users (a dashboard banner), set a cluster tag for lists (tag annotation), and apply color coding so environments are easy to tell apart.

A banner is shown to all users who work with the cluster in the Shturval GUI. Use it for scheduled maintenance, access changes, or other important notices.

For visual emphasis (for example, by environment), use Visual marking — see the Visual marking tab below.

Where the message is created #

The message is created and edited on the Dashboard page of the cluster. The icon for posting an information message is located in the upper right corner of the dashboard page (next to the buttons for going to Statistics, Argo CD, etc.).

How to add or change a banner #

1. Open the cluster and go to the Dashboard page.
2. In the upper right corner of the page, click the icon for adding or editing an information message (banner).
3. In the window that opens, enter or change the text of the message.
4. Save your changes.

After saving, the banner appears in the GUI for all users with access to this cluster.

Screenshot: adding an information message (banner)

Screenshot: displaying a banner for users

Recommendations #

• Use short and clear text.
• For scheduled work, indicate the window date and time and expected duration.
• To remove a message, open the editing form, clear the text and save.

The cluster tag is an annotation with key tag. The value appears in the general cluster list and supports filtering by purpose or environment (for example, prod, test). Russian and English values are supported.

How to set a tag #

1. On the cluster dashboard, open the Annotations tab.
2. Click + to add an annotation.
3. In the dialog, set Key to tag and Value to the tag you want (for example, prod).
4. Click Save.

How to remove a tag #

Click the cross next to the annotation, confirm, and click Save.

Example. To distinguish prod and test, add tag: prod on one cluster and tag: test on another.

Screenshot: adding a cluster annotation (feature)

Screenshot: sorting clusters by criteria

Visual cluster marking #

Color marking (bar) helps to distinguish clusters at first glance, for example, by environment (production, test, etc.). The bar is displayed to the right of the left side menu on all pages of a given cluster in the GUI.

How to set up #

1. On the cluster dashboard, open the Annotations tab.
2. Add an annotation with the key color-<hex-code> and the value - the text that will be shown on the strip (see the table below for an example).
3. If you need to change the text color, add the text-color annotation with the hex code of the text color in the value.
4. Click Save.

To remove markings, delete the associated annotations in the Annotations tab and save your changes.

Annotation Key	Annotation value	Description	Example
color-<hex-code>	YOUR TEXT	Sets the background color of the bar and the text that appears on the bar. Hex code is specified without #.	Key: color-ff4d4f Value: PROD
text-color	<hex-code>	Sets the color of the text on the bar. Hex code is specified without #. If the annotation is not specified, the default text color in the dark interface theme is white, and in the light interface it is black.	Key: text-color Value: ffffff

#

Cluster tab #

Cluster node groups #

The “Cluster Node Groups” block contains information about node groups. When you click on the block name, you go to the Node Management page.

The block displays: group name, provider, number of nodes, readiness of nodes in the form of indicators (green - Ready, red - NotReady), number of pods. If there is a large number of nodes in the group, the ratio of healthy nodes to the requested number is shown.

Description #

The “Description” block contains the main parameters of the cluster:

• Service subnet;
• Pod subnet;
• Provider;
• Advanced security settings (enabled/disabled);
• API server;
• Provider template;
• Ingress-domain;
• Created (user who created the cluster).

In the same block, the actions “Pause” infrastructure reconciliation and “Delete cluster” are available.

Cluster update #

The Cluster Update block shows the installed version of Kubernetes. Manual and automated start update are available.

Services #

The “Services” block contains counters of installed, enabled and running services (total and critical). When you click on the block name or number, you go to the Installed services page of the cluster.

Alerting #

The “Alerting” block shows triggered alerts by importance level. When you click on a block or a counter value, you go to the View Alerts page. The block is not displayed if metrics collection is not enabled in the cluster or if the metrics storage module is not enabled in the management cluster.

Pausing reconciliation (Paused) #

Pausing infrastructure reconciliation temporarily stops changes and checks on machines and nodes in the cluster. Pending changes are queued and applied when reconciliation resumes. Cluster administrators and platform administrators can manage this from the cluster dashboard. For background, see How Shturval controls the clouds.

Example: with MachineHealthCheck enabled for a group of nodes, you can pause reconciliation, change the machine sizing, and resume reconciliation so that MachineHealthCheck does not respond to a node being temporarily unavailable.

Annotations Tab #

The Annotations tab lists cluster annotations. You can add, edit, and delete them; click Save after changes.

Tagging (tag), color bar, and related annotations are covered in Administrator communication.

Events tab #

The “Events” tab displays cluster object events: date and time, source, object, event type, text.

“Logs” tab #

If the Local Log Collection Module (shturval-log-collector) is enabled in the cluster and the shturval-metrics-collector is running in the management cluster, the collected logs are displayed on the “Logs” tab. More information about viewing and filtering: View logs.

Certificates tab #

The Certificates tab displays information about the cluster certificates (based on API Certificate Validator Kubernetes): expiration date and number of days remaining.

Metering tab #

Metering is a simplified representation of resource consumption by namespace (CPU/hour, RAM/hour). Data is stored for up to a year. On the tab, you can get information for the last hour, week, month, year, or for a selected time range.

“Service Availability” tab #

The Service Availability tab shows cards for key cluster system services: availability status (color), availability percentage for the last hour, Helm chart name, and namespace. Manage opens the service view page.

The tab is available when shturval-metrics-collector is enabled in the cluster and shturval-monitoring is enabled in the management cluster.

You can also check service status on the Installed services page.