This documentation covers ClusterControl version 2.1.0 which was released on June 24th, 2024. This release contains key new features along with performance improvements and bug fixes. The release changelog is available at Changelogs.
ClusterControl is an agentless management and automation software for database clusters. It helps deploy, monitor, manage, and scale your database server/cluster directly from the ClusterControl user interface.
ClusterControl consists of a number of components:
Component | Package Name | Role |
---|---|---|
ClusterControl Controller (cmon) | clustercontrol-controller | The brain of ClusterControl. A backend service performing automation, management, monitoring, and scheduling tasks. All the collected data will be stored directly inside the CMON database. |
ClusterControl GUI v2 | clustercontrol2 | A web-based graphical user interface (GUI) to visualize and manage the clusters provisioned by ClusterControl. It interacts with the CMON controller via remote procedure calls (RPC). This next-generation web application supersedes ClusterControl GUI v1. |
ClusterControl GUI v1 | clustercontrol | The first generation of web-based graphical user interface (GUI) to visualize and manage the clusters provisioned by ClusterControl. It interacts with the CMON controller via remote procedure calls (RPC). As of v1.9.7, this is considered a feature-freeze product with no future development. |
ClusterControl SSH | clustercontrol-ssh | Optional module for web SSH console via WebSocket. It only works with Apache 2.4+. |
ClusterControl Notifications | clustercontrol-notifications | Optional module for integration to third-party messaging, notification, and incident management services. |
ClusterControl Cloud | clustercontrol-cloud | Optional module for integration with cloud providers. |
ClusterControl Cloud File Manager | clustercontrol-clud | Optional module to interact with storage objects on the cloud, with dependency on clustercontrol-cloud package. |
ClusterControl Multi-Controller | clustercontrol-mcc | An optional package introduced in ClusterControl 2.0.0 providing a centralized management of multiple ClusterControl Controller instances, also known as ClusterControl Operations Center. |
ClusterControl Proxy | clustercontrol-proxy | An optional package introduced in ClusterControl 2.0.0 providing a controller proxying service for ClusterControl Operations Center. |
ClusterControl CLI | s9s-tools | A command-line interface (CLI) to manage and monitor clusters provisioned by ClusterControl. It interacts with the CMON controller via remote procedure calls (RPC). |
To learn more about ClusterControl and its components, see Components.
Articles
- Getting Started
- Requirements
- Installation
- User Guide (GUI)
- User Guide (GUI v2)
- User Guide (CLI)
- Components
- Administration
- Upgrading ClusterControl
- Backing Up and Restoring ClusterControl
- Resetting ClusterControl Admin Login
- Securing ClusterControl
- Housekeeping
- Health Checks
- Migrating IP Address or Hostname
- High Availability ClusterControl (CMON HA)
- Standby ClusterControl Server for High Availability
- Changing ‘cmon’ or ‘root’ Password
- Disabling mod_proxy
- Graceful Shutdown
- Uninstall/Reinstall
- Troubleshooting
- FAQs
- Developer Guide
- Changelogs
- Changes in ClusterControl GUI v2
- Changes in v2.2.0
- Changes in v2.1.0
- Changes in v2.0.0
- Changes in v1.9.8
- Changes in v1.9.7
- Changes in v1.9.6
- Changes in v1.9.5
- Changes in v1.9.4
- Changes in v1.9.3
- Changes in v1.9.2
- Changes in v1.9.1
- Changes in v1.9.0
- Changes in v1.8.2
- Changes in v1.8.1
- Changes in v1.8.0
- Changes in v1.7.6
- Changes in v1.7.5
- Changes in v1.7.4
- Changes in v1.7.3
- Changes in v1.7.2
- Changes in v1.7.1
- Changes in v1.7.0
- Changes in v1.6.2
- Changes in v1.6.1
- Changes in v1.6.0
- Changes in v1.5.1
- Changes in v1.5.0
- Changes in v1.4.2
- Changes in v1.4.1
- Changes in v1.4.0
- Changes in v1.3.2
- Changes in v1.3.1
- Changes in v1.3.0
- Changes in v1.2.12
- Changes in v1.2.11
- Changes in v1.2.10
- Changes in v1.2.9
- Changes in v1.2.8
- Changes in v1.2.6
- Changes in v1.2.5
- Changes in v1.2.4c
- Changes in v1.2.4
- Changes in v1.2.3
- Changes in v1.2.2
- Changes in v1.2.1
- Changes in v1.2.0
- Changes in v1.1.33
- Changes in v1.1.32