Home

The default start-up page after a user has successfully logged in. The page provides a summary of database clusters and nodes managed by ClusterControl. In the main panel, you will see 2 main sections for clusters and nodes.

Product Tour

Starting from ClusterControl 2.3.0, we are excited to introduce the Product Tour feature an interactive walkthrough of the ClusterControl interface designed to guide you through the fundamental features and tools of ClusterControl, so you can efficiently navigate and optimize your database management experience. The Product Tour provides an interactive, guided experience to help you get started with confidence.

It highlights key components of the UI, explains their purpose, and provides links to documentation on essential tasks. The feature is designed to make the onboarding process seamless, ensuring users can navigate and utilize ClusterControl effectively:

The Product Tour covers:

• Deploying Clusters:

• Monitor deployment jobs:

• Cluster list and cluster Overview:

 

• Creating a backup schedule:

With the new Product Tour, we have made it easier to discover and use ClusterControl’s powerful database management capabilities. However, the product tour can be disabled by setting a parameter in the <webroot>/clustercontrol2/cconfig.js file:

ONBOARDING_ENABLED: false

Clusters

The pie chart on the left panel provides a status summary of all clusters managed by ClusterControl. The color indicates the cluster status:

• Green – The cluster is operational.
• Blue – The cluster is operational with maintenance mode activated.
• Yellow – The cluster is partially operational and requires attention.
• Red – The cluster is not operational.

The right panel provides the database cluster list managed by ClusterControl. Rollover on each database cluster name in the list will pop up more detailed cluster information with database vendor, versions, tags, scheduled maintenance, and its topology. The following screenshot shows what the popup looks like:

The pop-up color reflects on the cluster status, with the same color indicator as explained above.

Nodes

The pie chart on the left panel provides a status summary of all nodes managed by ClusterControl for all clusters. This includes all database nodes, ClusterControl nodes, Prometheus (if agent-based monitoring is enabled), and load balancer nodes. The color indicates the node status:

• Green – The node is operational.
• Blue – The node is operational with maintenance mode activated.
• Yellow – The node is partially operational and requires attention. It might be in a shutdown or rebooting state, recovering or lagging behind.
• Red – The node is not operational.

The honeycomb diagram visualizes the database node managed by ClusterControl. Rollover on each honeycomb cell will pop up more detailed node information with database cluster, port, hostname, role, cluster type, status, and when it was last seen. The following screenshot shows what the popup looks like:

 

The pop-up color reflects on the node status, with the same color indicator as explained above. If a node is not in a green status (operational), the honeycomb cell will reveal an icon according to the node’s role to catch the user’s attention.

Deploy a Cluster

Clicking on the Deploy a Cluster button at the top-right corner will give users two more options, as shown in the following screenshot:

1. Create a database cluster – Use this deployment wizard to deploy a new database cluster or server. See Create a Database Cluster.
2. Import a database cluster – Use this deployment wizard to import your existing database cluster or server. See Import a Database Cluster.