Table of Contents
Provides a summary of all database nodes in the cluster. This page is accessible only if there is a cluster deployed by ClusterControl via Deploy Database Cluster or imported into ClusterControl via Import Existing Server/Cluster.
Cluster Actions
Provides shortcuts to the main cluster functionality. For TimeScaleDB Streaming Replication, the action menu consists of:
Field | Description |
---|---|
Add Load Balancer |
|
Add Replication Slave |
|
Change RPC API Token |
|
Configure WAL |
|
Create Slave Cluster |
|
Disable/Enable Cluster Recovery |
|
Disable/Enable Node Recovery |
|
Schedule Maintenance Mode |
|
Delete Cluster |
|
Deregister Cluster from UI |
|
You can retrieve the RPC API Token value directly from respective /etc/cmon.d/cmon_{clusterID}.cnf
.
Add Replication Slave
TimeScaleDB replication slave requires at least a master node. The following must be true for the master:
- At least one master under the same cluster ID.
- Only TimeScaleDB 10.x, 11.x, 12.x or 13.x is supported.
- Master’s TimeScaleDB port is accessible by ClusterControl and slaves.
For the slave, you would need a separate host or VM, with or without TimeScaleDB installed. If you do not have a TimeScaleDB installed, and choose ClusterControl to install the TimeScaleDB on the slave, ClusterControl will perform the necessary actions to prepare the slave, for example, create a slave user, configure TimeScaleDB, start the server, and also start the replication. Prior to the deployment, you must perform the following actions:
- The slave node must be accessible using passwordless SSH from the ClusterControl server
- TimeScaleDB port (default 5432) on the slave is open for connections for at least the ClusterControl server and the other members in the cluster.
To prepare the TimeScaleDB configuration file for the slave, go to ClusterControl → Manage → Configurations → Template Configuration files. Later, specify this template file when adding a slave.
Add New Replication Slave
The slave will be set up from a streamed backup using pg_basebackup
from the master to the slave.
Field | Description |
---|---|
Master Server |
|
Slave Server |
|
Do you want to install the Slave server? |
|
Disable firewall |
|
Disable SELinux/AppArmor |
|
Existing TimeScaleDB server packages will be uninstalled.
Add Existing Replication Slave
Add an existing replication slave into ClusterControl. Use this feature if you have added a replication slave manually to your cluster and want it to be detected and managed by ClusterControl. ClusterControl will then detect the new database node as being part of the cluster and starts to manage and monitor it as with the rest of the cluster nodes. Useful if a node has been configured outside of ClusterControl e.g, through Puppet, Chef, or Ansible.
Field | Description |
---|---|
Hostname |
|
Port |
|
Create SSL Encryption
Enable encrypted SSL client-server connections for the database node(s). The same certificate will be used on all nodes. To enable SSL encryption the nodes must be restarted. Select ‘Restart Nodes’ to perform a rolling restart of the nodes.
Field | Description |
---|---|
Create Certificate |
|
Certificate Expiration (days) |
|
Use Certificate |
|
Restart Cluster |
|
Cluster-to-Cluster Replication
This feature allows you to create a new cluster that will be replicating from this cluster. One primary use case is for disaster recovery by having a hot standby site/cluster which can take over when the main site/cluster has failed. Clusters can be rebuilt with an existing backup or by streaming from a master on the source cluster.
For PostgreSQL-based clusters, ClusterControl will configure asynchronous streaming replication between a master cluster to a slave cluster.
Field | Description |
---|---|
Cluster Provisioning Data |
|
Replication Master |
|
Once the above options have been selected, the cluster deployment wizard will appear similar to deploying a new cluster. See Deploy Database Cluster.
A slave cluster will appear in the database cluster list after deployment finishes. You will notice the slave cluster entry is a bit indented in the list, with a pointed arrow coming from the source cluster, indicating the cluster-cluster replication is now active.
Configure WAL
Enabling Write-ahead Logging (WAL) makes it possible to support on-line backup and point-in-time recovery in PostgreSQL.
Field | Description |
---|---|
Archive Mode |
|
Compressed WAL Archive |
|
Custom WAL Archive Directory |
|
Nodes |
|
Changing the current value leads to loss of collected continuos WAL archive and thus loss of time frame to do point-in-time recovery (PITR).
Server Load
The Server Load graph provides an overview of aggregated load on your database server.
Field | Description |
---|---|
Dash Settings |
|
Filter by Host |
|
Connections |
|
Commits |
|
Fetched |
|
Inserted |
|
Updated |
|
Deleted |
|
Rollbacks |
|
Custom Dashboard
Customize your dashboard on the Overview page by selecting which metrics and graphs to display. For TimeScaleDB nodes, 2 graphs are configured by default:
Dashboard Name | Description |
---|---|
Server Load | Shows aggregated load on your database node. |
Cache hit ratio | Shows aggregated data on overall hit ratios. |
The created custom dashboards will appear as tabs beside Dash Settings.
Field | Description |
---|---|
Dashboard Name |
|
Metric |
|
Scale |
|
Selected as Default Graph |
|
You can rearrange dashboard order by drag and drop above.
Hosts/Nodes Statistics
Displays a summary of host and database-related stats for all database nodes.
Standalone Nodes Grid
Field | Description |
---|---|
Hostname |
|
Version |
|
Refresh |
|
Master Nodes Grid
This grid appears if ClusterControl detects master TimeScaleDB node, where select pg_is_in_recovery()
returns false.
Field | Description |
---|---|
Hostname |
|
Version |
|
Writable |
|
Refresh |
|
Slave Nodes Grid
This grid appears if ClusterControl detects any standby TimeScaleDB node, where select pg_is_in_recovery()
returns true.
Field | Description |
---|---|
Hostname |
|
Version |
|
Replication State |
|
Master Host |
|
Received Location |
|
Replay Location |
|
Lag (sec.) |
|
Writable |
|
Refresh |
|
Hosts
Shows collected system statistics in a table as below:
Field | Description |
---|---|
Ping |
|
CPU util/steal |
|
Loadavg (1/5/15) |
|
Net (tx/s / rx/s) |
|
Disk read/sec |
|
Disk writes/sec |
|
Uptime |
|
Last Updated |
|
Refresh |
|
Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. Note that the GUI v1 is considered a feature-freeze product with no future development. All new developments will be happening on ClusterControl GUI v2. See User Guide (GUI v2).