ClusterControl User Guide
The User Guide covers everyday use of ClusterControl: deploying and importing database clusters, observability, cluster and node management, backup and restore, scaling, third-party integrations, and troubleshooting.
What's in this guide
- Overview: Using the ClusterControl GUI, CLI, RPC API, and available addons. See Overview.
- Deployment: Creating or importing database clusters and load balancers. See Deployment.
- Observability: Monitoring cluster and host health, query performance, logs, and audit trails. See Observability.
- Management: Failover and recovery, cluster and node management, configuration, upgrades, alerts, and certificates. See Management.
- Backup & Restore: Creating, scheduling, restoring, and verifying backups, including to and from cloud storage. See Backup & Restore.
- Scaling: Adding or removing database and replica nodes, and creating replica clusters. See Add Database Node.
- Integration: Connecting ClusterControl to Kubernetes, cloud providers, LDAP, Terraform, and more. See ClusterControl Ops-C.
- Troubleshooting: Diagnosing issues with ClusterControl and database clusters, and generating error reports. See Common Issues.
Who should use this guide
This guide is for DBAs, DevOps engineers, and SREs using ClusterControl to deploy, monitor, and manage database clusters day to day. If you're instead responsible for operating ClusterControl itself, such as upgrades and security hardening, see the Administration Guide.
For step-by-step deployment walkthroughs, see the Tutorials section.