Cluster Management
This feature provides information and management options for database clusters managed by ClusterControl. Clicking on the Clusters (sidebar menu) will list out all database clusters on the main panel, each of the entries has a real-time summary of the cluster, together with the dropdown management menu (see Cluster Actions):
Each entry will have the following details:
- Cluster name: Configurable during import or deployment, also via the s9s command line.
- Cluster ID: Immutable ID assigned by ClusterControl after it is registered.
- Cluster type: The database cluster type, recognized by ClusterControl. See Supported Databases.
- Nodes: All nodes grouped under this particular cluster.
- Auto recovery: The ClusterControl automatic recovery settings. See Failover and Recovery.
- Load: Last 5 minutes of cluster load average.
- ...: Every supported database cluster has its own set of dropdown menus. See Cluster Actions.
Choose a database cluster from the expandable list on the left-side menu to drill down on the cluster-specific features. The navigation breadcrumbs (top panel) will reflect with the corresponding cluster when selecting a cluster.
Cluster Actions
Provides shortcuts to the main cluster functionality. Each database cluster has its own set of functionality as described below:
MySQL/MariaDB/Percona (replication/standalone)
| Feature |
Description |
| Add new → Replication node |
- Adds a new or existing replica database node into the cluster. The new replica will automatically join and synchronize with the rest of the cluster. See Add Replication Node.
|
| Add new → Load balancer |
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Encryption settings → Change SSL Certificate |
- Opens the SSL certificate management wizard which allows you to create or choose an existing certificate for database client-server encryption
|
| Encryption settings → SSL encryption |
- Toggles On to enable client-server SSL encryption. This action will restart the whole cluster, one node at a time
- Toggles Off to disable client-server SSL encryption. This action will restart the whole cluster, one node at a time
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Audit logging |
- Enable audit logging (MariaDB-based clusters only) using policy-based monitoring and logging of connection and query activity. This feature will enable audit logging on all nodes in the cluster. See Audit Logging.
|
| Readonly |
- Toggles On to enable cluster-wide read-only. ClusterControl will configure
read_only=ON and super_read_only=ON (except MariaDB) on all database nodes in the cluster - Toggles Off to disable cluster-wide read-only
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, for example from 8.0.x to 8.0.y, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades
|
| Create database |
- Create a new database schema on the primary node. For MySQL, the database name can contain letters, numbers,
$ and _ symbols. Maximum length is 64 characters.
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration
|
Galera Cluster (Percona XtraDB/MariaDB)
| Feature |
Description |
| Add new → Node |
- Adds a new or existing database node into the cluster. You can scale out your cluster by adding more database nodes. The new node will automatically join and synchronize with the rest of the cluster. See Add Node.
|
| Add new → Replication node |
- Adds a new or existing replica database node into the cluster. The new replica will automatically join and synchronize with the rest of the cluster. See Add Replication Node.
|
| Add new → Load balancer |
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Encryption settings → Change SSL Certificate |
- Opens the SSL certificate management wizard which allows you to create or choose an existing certificate for database client-server encryption
|
| Encryption settings → Change Galera SSL Certificate |
- Opens the SSL certificate management wizard which allows you to create or choose an existing certificate for Galera cluster nodes communication encryption
|
| Encryption settings → Galera SSL encryption |
- Toggles On to enable Galera SSL encryption. This action will restart the whole cluster, one node at a time
- Toggles Off to disable Galera SSL encryption. This action will restart the whole cluster, one node at a time
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Readonly |
- Toggles On to enable cluster-wide read-only. ClusterControl will configure
read_only=ON and super_read_only=ON (except MariaDB) on all database nodes in the cluster - Toggles Off to disable cluster-wide read-only
|
| Clone/Replicate the cluster → Clone cluster |
|
| Clone/Replicate the cluster → Create replica cluster |
|
| Find most advanced node |
- Finds which is the most advanced node in the cluster. This is useful to determine which node to bootstrap if the cluster doesn’t have any primary component or when ClusterControl automatic recovery is disabled.
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, for example from 8.0.x to 8.0.y, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades
|
| Create database |
- Create a new database schema on the primary node. For MySQL, the database name can contain letters, numbers,
$ and _ symbols. Maximum length is 64 characters.
|
| Rolling restart |
- Performs a cluster restart operation one node at a time. The rolling restart will be aborted if a node fails to be restarted
- For the Galera Cluster, toggle On Perform SST to force a full snapshot state transfer. The data directory will be removed from the cluster and the node will be completely resynced from another node. Note that this usually takes a longer time to complete depending on the dataset size
- It is also possible to reboot the host one at a time by toggling the Reboot hosts button.
|
| Bootstrap cluster |
- Launches the bootstrap cluster window. ClusterControl will stop all running nodes before bootstrapping the cluster from the selected Galera node. See Bootstrap Cluster.
|
| Stop Cluster |
- Stop all nodes in the cluster. This is the recommended way to perform a graceful shutdown to the cluster.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration.
|
PostgreSQL/TimescaleDB (streaming replication/standalone)
| Feature |
Description |
| Add new → Replication node |
- Adds a new or existing replica database node into the cluster. The new replica will automatically join and synchronize with the rest of the cluster. See Add Replication Node.
|
| Add new → Load balancer |
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Encryption settings → Change SSL Certificate |
- Opens the SSL certificate management wizard which allows you to create or choose an existing certificate for database client-server encryption
|
| Encryption settings → SSL encryption |
- Toggles On to enable client-server SSL encryption. This action will restart the whole cluster, one node at a time
- Toggles Off to disable client-server SSL encryption. This action will restart the whole cluster, one node at a time
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Audit logging |
- Enable audit logging using policy-based monitoring and logging of connection and query activity. This feature will enable audit logging on all nodes in the cluster. See Audit Logging.
|
| Create replica cluster |
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, for example from 8.0.x to 8.0.y, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades
|
| Enable TimescaleDB |
- Installs TimescaleDB database extension on every PostgreSQL node. The installation will be performed on one database node at a time, followed by a database restart to apply the changes
- Once the PostgreSQL is converted into TimescaleDB, this action will not be reversible. ClusterControl will treat the cluster as a TimescaleDB cluster onwards
|
| Create database |
- Create a new database schema on the primary node. For PostgreSQL, the database name must start with a letter or underscore, and can contain only letters, numbers and underscores. Maximum length is 63 characters.
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Setup logical replication |
- Set up logical replication between two existing PostgreSQL clusters using a publish-and-subscribe model. This is only supported for PostgreSQL 16 and later.
- Choose an existing PostgreSQL cluster from the Target cluster dropdown. The target cluster should not be part of another logical replication.
- This operation establishes a new logical cluster to manage publications and subscriptions. To enable bi-directional replication, configure both clusters with publications and subscriptions. See PostgreSQL Logical Replication.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration.
|
PostgreSQL Logical Replication
| Feature |
Description |
| Actions → Edit details |
- Edit the cluster’s name and tags.
|
| Actions → Remove cluster |
- Remove the logical replication grouping for all clusters connected to it. The PostgreSQL database nodes or streaming replication cluster will be ungrouped from the logical binding and will continue to operate as a normal standalone node or streaming replication cluster
- After the removal, the WAL level will remain as logical, which is usable for streaming replication as well (despite the WAL size will be bigger if compared to replica or hot_standby)
- One must explicitly type “REMOVE” in the text field before triggering the cluster removal job
|
|
Pubs & Subs → Create publication |
| Publisher cluster |
- Choose a database cluster from the dropdown list as the publisher cluster.
|
| Database |
- Choose a database from the list. The target database and its corresponding objects like tables must be created first in the publisher cluster. This list will be auto-populated by ClusterControl depending on the Publisher cluster
|
| Publication name |
- Specify a publication name
|
| Include all tables |
- Toggle on to include all tables under the chosen database
- Toggle off will open a dropdown editor where you can type the table name and press Enter. Multiple values are supported
|
|
Pubs & Subs → Create subscription |
| Subscriber cluster |
- Choose a database cluster from the dropdown list as the subscriber cluster
|
| Subscription name |
- Specify the subscription name
|
| Publication |
- Choose an existing publication from the list
|
| Database |
- Choose a database from the list. The target database and its corresponding objects like tables must be created first in the subscriber cluster. This list will be auto-populated by ClusterControl depending on the Subscriber cluster
|
| copy data |
- Toggle on to copy pre-existing data in the publications that are being subscribed to when the replication starts
- Toggle off will skip the initial snapshot stage. It is recommended for the user to manually perform the initial syncing before proceeding with this option
|
| Origin |
- None means the subscription will only replicate changes that do not have an associated origin (i.e., changes made locally), while Any means the subscription will replicate all changes regardless of their origin, including those already replicated from other nodes
- This operation establishes a new logical cluster to manage publications and subscriptions. To enable bi-directional replication, configure both clusters with publications and subscriptions. See PostgreSQL Logical Replication
|
|
Alarms |
| Actions → Details |
- Open the alarm details page presenting the alarm status, description, and recommendation
|
| Actions → Copy link |
- Copy the individual direct link to the alarm details
|
| Actions → Mute |
- Mute the alarm. Once muted, the individual direct link to the alarm details
|
|
Jobs |
| Actions → Details |
- Open the job details page presenting the job status, cluster information, job specifications, and job messages
- Click on Copy to clipboard to copy the whole information in this page into the clipboard. Useful for information sharing and troubleshooting.
|
| Actions → Copy link |
- Copy the individual direct link to the job details and messages.
|
| Actions → Delete |
- Delete the job from ClusterControl records for this cluster
|
Attention
For PostgreSQL logical replication, setting origin=any can lead to a potential infinite loop in bi-directional replication setups, as changes replicated from one node can be sent back to the originating node. To avoid this, users should carefully configure subscriptions and use origin=none to prevent such behavior.
MongoDB
| Feature |
Description |
| Add node |
- Scale the current MongoDB Replica Set or Sharded Cluster deployment by adding a single shard, Mongos, or config server.
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Convert to shard |
- Only for MongoDB Replica Set. Converts an existing MongoDB replica set to a sharded cluster by adding Mongos and config servers into the setup
|
| SSL encryption |
- Toggles On to enable client-server SSL encryption. This action will restart the whole cluster, one node at a time
- Toggles Off to disable client-server SSL encryption. This action will restart the whole cluster, one node at a time
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration
|
Redis
| Feature |
Description |
| Add node |
- Adds a new or existing node into the cluster. You can scale out your cluster by adding more database nodes. The new node will automatically join and synchronize with the rest of the cluster. See Add Node.
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, for example from 7.0.x to 7.0.y, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration
|
Microsoft SQL Server
| Feature |
Description |
| Add node |
- Adds a new or existing node into the cluster. You can scale out your cluster by adding more database nodes. The new node will automatically join and synchronize with the rest of the cluster. See Add Node.
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Upgrades |
- This feature is not available yet for MSSQL-based clusters
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration
|
Elasticsearch
| Feature |
Description |
| Add node |
- Adds a new Elasticsearch master, data, coordinator, or master-data node into the cluster. The new master or data node will automatically join and synchronize with the rest of the cluster. See Add Node.
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Upgrades |
- This feature is not available yet for Elasticsearch-based clusters
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration
|
Valkey
| Feature |
Description |
| Add node |
- Adds a new or existing node into the cluster. You can scale out your cluster by adding more database nodes. The new node will automatically join and synchronize with the rest of the cluster. See Add Node.
|
| Schedule maintenance |
- Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising alarms and notifications while the mode is active
- All nodes in the cluster (regardless of the role) will be marked as under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster
|
| Cluster/node recovery → Cluster recovery |
- Disables or enables cluster recovery
- If enabled, ClusterControl will attempt to recover the cluster if necessary. See Cluster Recovery.
|
| Cluster/node recovery → Node recovery |
- Disables or enables node recovery
- If enabled, ClusterControl will attempt to recover the node if necessary. See Node Recovery.
|
| Change RPC API token |
- Serves as the authentication string by ClusterControl UI to connect to the CMON RPC interface. Each cluster has its unique token
|
| Upgrades |
- Performs minor software upgrades for the database and load balancer software of this cluster, for example from 7.0.x to 7.0.y, in a rolling upgrade fashion. ClusterControl will perform the software upgrade based on what is available on the package repository for the particular vendor. See Upgrades.
|
| Edit details |
- Edit the cluster’s name and tags.
|
| Remove cluster |
- Removing the cluster will delete all metadata we have on it. The database nodes will not be affected and will continue to operate as normal.
- One has to explicitly type “REMOVE” in the text field before the cluster removal job is triggered. The cluster can be imported again in the future with fresh new metadata and configuration.
|
Cluster-specific actions
Bootstrap cluster
Bootstrap cluster refers to the process of bootstrapping or initializing a new Galera Cluster. When you’re setting up a new Galera Cluster or performing a full backup restoration, you typically need to bootstrap it, which involves designating one node as the initial primary component of the cluster. This bootstrap node serves as the starting point for the cluster, and other nodes will then join this initial node to form the cluster.
The following actions will be performed:
- The cluster will be initialized from the selected node.
- All nodes will be stopped unless they are already stopped.
- When the bootstrap command is successful, the selected node will be Synced. The rest of the nodes will be started as joiners, one node at a time.
| Field |
Description |
| Bootstrap node |
- Choose a database node from the list to be the reference node. If you are unsure, you may choose Auto Select from the dropdown where ClusterControl will determine the most suitable node to bootstrap based on the Galera node’s sequence number.
|
| Graceful shutdown timeout (in seconds) |
- ClusterControl will wait for this timeout to finish before forcing the node to stop.
|
| Force stop the nodes (after shutdown time) |
- Toggles On to force stop the database node if it takes longer than the shutdown time, specified in Graceful shutdown timeout (in seconds), defaulting to 1800 seconds (30 minutes). Commonly useful in the case of forcing a database cluster to bootstrap when database locking or long-running transactions are happening.
|
| Clear MySQL datadir on Joining nodes |
- Toggles On to clear the MySQL data directory on the joining nodes. This is often necessary after a restoration.
|