Table of Contents
ClusterControl provides several user interfaces to interact with the ClusterControl Controller (CMON) service:
| Interface | Description | Package name |
|---|---|---|
| ClusterControl GUI | The graphical user interface runs as a web application, also known as ClusterControl GUI v1. | clustercontrol |
| ClusterControl GUI v2 | The next-generation web application supersedes ClusterControl GUI v1. | 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 (v1) | ClusterControl GUI v2 |
Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. For new installations, the installer script will only install GUI v2, skipping GUI v1. If you would like to run GUI v1, see Installing ClusterControl GUI v1 over GUI v2. If you are upgrading from an older version, the GUI v1 will remain available and usable as usual.
Starting from ClusterControl 1.9.7 (September 2023), upon logging in to ClusterControl GUI v2, make sure you use the username you have assigned or set during the User Registration page. Whereas in CC GUI v1, you can use e-mail address when logging in to the login page, but in CC v2, make sure you use the username and password combination in order to login to the home page.
The ClusterControl GUI (a.k.a v1) is the feature-complete, graphical user interface for MySQL/MariaDB Replication, Galera Cluster, MongoDB, PostgreSQL, and TimescaleDB. It came with the standard ClusterControl installation and was accessible via https://{ClusterControl_host}/clustercontrol. However, since version 1.9.7, the installer script will no longer install this GUI v1 automatically. The documentation section User Guide (GUI) is meant to be for this version. Note that the GUI v1 is considered a feature-freeze product with no future development.
In past years, we have been 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/ (if upgraded to 1.9.7) or https://{ClusterControl_host}/ for new installation. This new completely rewritten web application will continue to improve the user experience and ease of use that our users are accustomed to. Starting from ClusterControl 1.9.7 (September 2023), the GUI v2 is considered feature-complete, effectively superseding GUI v1. 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.7, for new installations, the installer script will only install GUI v2, skipping GUI v1. All new developments will be happening on ClusterControl GUI v2.
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. See User Guide (CLI).