Quick start
Where to begin if you operate a client cluster.
Who is this page for?
You are working as a cluster administrator in the Shturval platform for the first time, or you need to find documentation for a specific operational task quickly.
This section covers the client cluster (workload cluster): cluster state, nodes, networking, access, quotas, storage, backup, services, and maintenance. Platform installation, infrastructure providers, and the management cluster are platform administrator tasks; see Platform architecture for the overall layout.
How to work with the platform
The primary workflow for a cluster administrator is the web UI. In-cluster navigation, the dashboard, namespaces, and manifest import are described on Graphical interface.
For command-line work, use kubectl, kubeconfig, or kubectl-shturval-plugin. Access options are listed in kubectl-shturval-plugin. For HTTP API automation, see Swagger: reference and scenarios.
Typical cluster administrator tasks
Monitor cluster state and respond to issues
- Start with the cluster dashboard: deployment and update status, Kubernetes version, node groups, events, logs, certificates, metering, and service availability.
- When investigating incidents, see logs and metrics, alerting troubleshooting, and cluster troubleshooting.
Configure alerts and application monitoring
- For metrics, configure alert rules.
- For log events, configure log-based alerting.
- To deliver alerts to your team, configure alert receivers.
- For application metrics, use application monitoring.
Manage nodes and scaling
- For Control Plane and Worker groups, machine templates, and autoscaling, use node groups.
- For individual node operations—Cordon, Drain, deletion, taints, and diagnostics—see the node page.
- To configure OS and runtime on nodes, use node configuration.
- To automatically recover unhealthy machines, configure MachineHealthCheck.
- To isolate workloads and control pod placement, use Taints and Tolerations.
Operate Shturval v2 and hybrid clusters
- To add physical hosts and expand a node group, use Adding hosts.
- To shrink a Shturval v2 node group, see Removing hosts.
- To release a specific host, use Release a specific host.
Configure networking and application access
- For inbound traffic and load balancing, configure Ingress controllers.
- For outbound traffic, use Egress Gateway.
- To isolate pods and namespaces, configure network policies.
- For additional interfaces and Multus, use additional networks.
Manage access and responsibilities
- Cluster- and namespace-level assignments are configured on Cluster access management.
- The general assignment procedure is in platform access management.
- For temporary pod diagnostics access, use the debug role.
Limit resources for teams and workloads
- For CPU, memory, and other namespace limits, configure Resource Quotas and LimitRanges.
- For cluster-level CPU reservation, see CPU pinning.
Manage storage and protect data
- For storage classes, use StorageClasses.
- For persistent volumes, see PersistentVolumes.
- For clusters with OpenStack, VK Cloud, or Selectel providers, see CSI OpenStack (Cinder).
- For volume snapshots, use snapshots.
Configure backup and recovery
- First connect S3 storage for backups.
- For one-time and scheduled backups, use creating backups.
- For disaster recovery or migration, see restore from backup.
Install services and connect repositories
- To install Helm charts through the platform, follow How to deploy a new service.
- For platform services, see the Shturval repository.
- To work with platform CRDs, see Custom resources.
Upgrade and maintain the cluster
- To upgrade Kubernetes, use the update map.
- Before upgrading, review the update configuration.
- To maintain etcd, use ETCD backup.
- For TLS in the cluster, configure ClusterIssuer and Issuer; for public endpoints, see Let’s Encrypt certificates.
Where to start
- Open the cluster dashboard and check status on the Cluster and Nodes tabs.
- Configure basic alerts: rules, log alerting, and receivers.
- Review node groups, MachineHealthCheck, and, if needed, node configuration.
- Configure cluster access for users and teams.
- Connect S3 storage for backups and create backups on the Creating backups page.
- After the baseline check, move on to specialized tasks: networking, quotas, storage, or services.