1. Home
  2. Docs
  3. ClusterControl
  4. User Guide (GUI)
  5. Dashboard
  6. Deploy a Database Cluster
  7. Galera Cluster

Galera Cluster

Deploy a new MySQL/MariaDB Galera Cluster. The database cluster will be automatically added into ClusterControl once deployed. A minimal setup is comprised of one Galera node (no high availability, but this can later be scaled with more nodes). However, a minimum of three nodes is recommended for high availability. Garbd (an arbitrator) can be added later after the deployment is completed if needed.

By default, ClusterControl deploys MySQL Galera with the following configurations:

  • Use xtrabackup-v2 or mariabackup (depending on the vendor chosen) for wsrep_sst_method.
  • Performance Schema is disabled.
  • Binary logging is disabled.
  • ClusterControl will create and grant necessary privileges for two MySQL users – cmon for monitoring and management and backupuser for backup and restore purposes.
  • Generated account credentials are stored inside /etc/mysql/secrets-backup.cnf.

 

Attention

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).

General & SSH Settings

Field Description
SSH User
  • Specify root if you have root credentials.
  • If you use sudo to execute system commands, specify the name that you wish to use here. The user must exist on all nodes. See  Operating System User
SSH Key Path
  • Specify the full path of the SSH key (the key must exist in the ClusterControl node) that will be used by the SSH User to perform passwordless SSH. See Passwordless SSH
Sudo Password
  • If you use sudo with a password, specify it here. Ignore this if SSH User is root or sudoer does not need a sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.
Cluster Name
  • Specify a name for the cluster.
Install Software
  • Check the box if you use clean and minimal VMs. Existing MySQL dependencies will be removed. New packages will be installed and existing packages will be uninstalled when provisioning the node with the required software.
  •  If unchecked, existing packages will not be uninstalled, and nothing will be installed. This requires that the instances have already provisioned the necessary software.
Disable Firewall
  • Check the box to disable the firewall (recommended).
Disable AppArmor/SELinux
  • Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (RedHat/CentOS) if enabled (recommended).

Define MySQL Servers

Field Description
Vendor
  • Percona – Percona XtraDB Cluster by Percona
  • MariaDB – MariaDB Server (Galera embedded) by MariaDB
Version
Server Data Directory
  • Location of MySQL data directory. Default is /var/lib/mysql
Server Port
  • MySQL server port. The default is 3306
Configuration Template
  • MySQL configuration template file under /etc/cmon/templates or /usr/share/cmon/templates. See Base Template Files for details.
Admin/Root Password
  • Specify the MySQL root password. ClusterControl will configure the same MySQL root password for all instances in the cluster.
Repository
  • Use Vendor Repositories – Provision software by setting up and using the database vendor’s preferred software repository. ClusterControl will always install the latest version of what is provided by the database vendor repository.
  • Do Not Setup Vendor Repositories – Provision software by using repositories already set up on the nodes. The User has to set up the software repository manually on each database node and ClusterControl will use this repository for deployment. This is good if the database nodes are running without internet connections.
  • Use Mirrored Repositories – Create and mirror the current database vendor’s repository and then deploy using the local mirrored repository. This is a preferred option when you have to scale the Galera Cluster in the future, to ensure the newly provisioned node will always have the same version as the rest of the members
Add Node
  • Specify the IP address or hostname of the MySQL nodes. Press Enter once specified so ClusterControl can verify the node reachability via passwordless SSH. A minimum of three nodes is recommended.
Was this article helpful to you? Yes No 1