1. Home
  2. Docs
  3. ClusterControl Staging
  4. User Guide

User Guide

ClusterControl provides 3 user interfaces to interact with the ClusterControl Controller (CMON) service:

Interface Description Package name
ClusterControl GUI Graphical user interface running as a web application clustercontrol
ClusterControl GUI v2 The next-generation web application, currently in the Technology Preview phase clustercontrol2
ClusterControl CLI The command-line user interface, also known as “s9s” s9s-tools

ClusterControl GUI

Starting from ClusterControl 1.9.0, ClusterControl provides two graphical-user interfaces:

ClusterControl GUI ClusterControl GUI v2


The ClusterControl GUI (a.k.a v1) is the feature-complete, primary graphical user interface for MySQL/MariaDB Replication, Galera Cluster, MongoDB, PostgreSQL and TimescaleDB. It comes with the standard ClusterControl installation and is accessible via https://{ClusterControl_host}/clustercontrol. The documentation section User Guide (GUI) is meant to be for this version.

We are transitioning the ClusterControl GUI to a new web framework called ClusterControl v2, or ClusterControl GUI v2 and it is accessible via https://{ClusterControl_host}:9443/. This new completely re-written web application will continue to improve on the user experience and ease of use that our users are accustomed to. It will take some time in order to become feature-complete compared with the current released version of ClusterControl GUI, and once it is ready, it shall replace the ClusterControl GUI (v1) as the primary graphical user interface for all database clusters. Both GUIs communicate to the same controller process (CMON) via the RPC interface. The documentation section User Guide (GUI v2) is meant to be for this version.

Starting from ClusterControl 1.9.0, both ClusterControl GUI (v1) and ClusterControl GUI v2 are available in tandem, however, additional steps are required to install and enable ClusterControl GUI v2. See this page for details. All new database management systems that we are going to support will be developed only in the ClusterControl GUI v2. For instance, we introduced support for Redis Sentinel on 1.9.0 and Microsoft SQL Server on 1.9.1, and these database systems can only be managed from the ClusterControl GUI v2 (as well as ClusterControl CLI). In terms of new management features (backup, restore, failover, configuration) for existing clusters, nearly all of those features will be available on both GUIs.

ClusterControl CLI

Also known as s9s, ClusterControl CLI is a command-line tool to interact, control, and manage database clusters using the ClusterControl Database Platform. Installation using the installer script will include ClusterControl CLI installation as well, in a package called s9s-tools. You can also install it on another host or workstation to manage the database cluster remotely. The commands are basically JSON messages being sent over to the ClusterControl Controller (CMON) RPC interface. Communication between the s9s (the command-line tool) and the controller process (CMON) is encrypted using TLS and requires port 9501 to be opened on the controller to be reached by the client host.

The following screenshot shows an example of ClusterControl CLI output from the terminal:

Not all functionalities are available on both user interfaces. For instance, there is no practicality for the command-line client (ClusterControl CLI) to have all the advanced monitoring features offered by the web application client (ClusterControl GUI). The command-line client is focused on automation and adoption in management, deployment, and scaling operations while the web UI client, focuses more on structural visualization with a guided approach. Occasionally, new management features will be introduced in the CLI before being incorporated into ClusterControl UI to turn it into a polished, finalized feature.

Installation using the installer script will include ClusterControl CLI installation as well on the ClusterControl server. The default “admin” user will be created automatically and is configured only for the root user.


Was this article helpful to you? Yes No