2. Home
  4. Docs
  6. ClusterControl
  8. User Guide (GUI)
  10. Dashboard
  12. Import an Existing Cluster

Import an Existing Cluster

Opens a wizard to import the existing database setup into ClusterControl. The following database cluster types are supported:

  • MySQL Replication
  • MySQL Galera
    • Percona XtraDB Cluster
    • MariaDB Galera Cluster
  • MySQL Cluster (NDB)
  • MongoDB ReplicaSet
  • MongoDB Shards
  • PostgreSQL (standalone or streaming replication)
  • TimeScaleDB (standalone or streaming replication)

Some prerequisites need to be fulfilled before adding the existing setup. The existing database cluster/server must:

  • Verify that sudo is working properly if you are using a non-root user. See Operating System User.
  • Passwordless SSH from ClusterControl node to database nodes has been configured correctly. See Passwordless SSH.
  • The target cluster must not be in a degraded state. For example, if you have a three-node Galera cluster, all nodes must be alive, accessible, and in sync.
    For more details, refer to the Requirements section. Each time you add an existing cluster or server, ClusterControl will trigger a job under ClusterControl → Settings → Cluster Jobs. You can see the progress and status under this page. A window will also appear with messages showing the progress.

 

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

Import Existing MySQL Replication

ClusterControl is able to manage and monitor an existing set of MySQL servers (standalone or replication). Individual hosts specified in the same list will be added to the same server group in the UI. ClusterControl assumes that you are using the same MySQL root password for all instances specified in the group and it will attempt to determine the server role as well (master, slave, multi or standalone).

When importing an existing MySQL Replication, ClusterControl will do the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Discover the database role of each node (master, slave, multi, standalone).
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

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 SSH User to perform passwordless SSH. See Passwordless SSH.
Sudo Password
  • Specify the password if the SSH user that you specified under SSH User requires sudo password to run super-privileged commands. Ignore this if SSH User is root or have no sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes

Define MySQL Servers

Field Description
Vendor
  • Percona for Percona Server
  • MariaDB for MariaDB Server
  • Oracle for MySQL Server
MySQL Version
  • Supported version:
    • Percona Server (5.5, 5.6, 5.7, 8.0)
    • MariaDB Server (10.1, 10.2, 10.3, 10.4, 10.5)
    • Oracle MySQL Server (5.7, 8.0)
Basedir
  • MySQL base directory. Default is /usr. ClusterControl assumes all MySQL nodes are using the same base directory.
Server Port
  • MySQL port on the target server/cluster. Default to 3306. ClusterControl assumes MySQL is running on the same port on all nodes.
Admin/Root User
  • MySQL user on the target server/cluster. This user must be able to perform the GRANT statement. Recommended using MySQL ‘root’ user.
Admin/Root Password
  • Password for MySQL User. ClusterControl assumes that you are using the same MySQL root password for all instances specified in the group.
“information_schema” Queries
  • Toggle on to enable information schema queries to track databases and table growth. Queries to the information schema may not be suitable when having many database objects (hundreds of databases, hundreds of tables in each database, triggers, users, events, stored procedures, etc). If disabled, the query that would be executed will be logged so it can be determined if the query is suitable in your environment.
  • This is not recommended for clusters with more than 2000 database objects.
Import as Standalone Nodes
  • Toggle on if you only importing a standalone node (by specifying only one node under the Add Nodes section).
Node AutoRecovery
  • ClusterControl will perform automatic recovery if it detects any of the nodes in the cluster is down.
Cluster AutoRecovery
  • ClusterControl will perform automatic recovery if it detects the cluster is down or degraded.
Add Nodes
  • Enter the MySQL single instances’ IP address or hostname that you want to group under this cluster.
Import
  • Click the button to start the import. ClusterControl will connect to the MySQL instances, import configurations, and start managing them.

Import Existing MySQL Galera

ClusterControl is able to manage and monitor an existing set of Galera Cluster. ClusterControl assumes that you are using the same MySQL root password for all instances specified in the group. If you have one or more asynchronous slaves attached to the Galera Cluster, specify it later on once the cluster is imported into ClusterControl by going to Add Replication Slave → Import Existing Replication Slave. Similarly, when importing the load balancers, go to Manage → Load Balancers to import them afterward.

When importing an existing Galera Cluster, ClusterControl will perform the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Detect the remaining nodes in the cluster, only if Automatic Node Discovery is ON.
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

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 SSH User to perform passwordless SSH. See Passwordless SSH.
Sudo Password
  • Specify the password if the SSH user that you specified under SSH User requires sudo password to run super-privileged commands. Ignore this if SSH User is a root or has no sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.

Define MySQL Servers

Field Description
Vendor
  • Percona XtraDB – Percona XtraDB Cluster by Percona
  • MariaDB – MariaDB Galera Cluster by MariaDB
Version
  • Supported versions:
    • Percona Server (5.5, 5.6, 5.7, 8.0)
    • MariaDB Server (10.1, 10.2, 10.3, 10.4, 10.5)
Basedir
  • MySQL base directory. Default is /usr. ClusterControl assumes MySQL is having the same base directory on all nodes.
Port
  • MySQL port on the target cluster. Default to 3306. ClusterControl assumes MySQL is running on the same port on all nodes.
Admin/Root User
  • MySQL user on the target cluster. This user must be able to perform the GRANT statement. Recommended using MySQL ‘root’ user.
Admin/Root Password
  • Password for MySQL User. The password must be the same on all nodes that you want to add into ClusterControl.
“information_schema” Queries
  • Toggle on to enable information_schema queries to track databases and table growth. Queries to the information_schema may not be suitable when having many database objects (hundreds of databases, hundreds of tables in each database, triggers, users, events, stored procedures, etc). If disabled, the query that would be executed will be logged so it can be determined if the query is suitable for your environment.
  • This is not recommended for clusters with more than 2000 database objects.
Node AutoRecovery
  • Toggle on so ClusterControl will perform automatic recovery if it detects any of the nodes in the cluster is down.
Cluster AutoRecovery
  • Toggle on so ClusterControl will perform automatic recovery if it detects the cluster is down or degraded.
Automatic Node Discovery
  • If toggled on, you only need to specify ONE Galera node and ClusterControl will discover the remaining nodes based on the hostname/IP addresses used for Galera’s intra-node communication. Replication slaves, load balancers, and other supported services connected to the Galera Cluster can be added after the import has finished.
Add Node
  • Specify the target node and press ‘Enter’ for each of them. If you have Automatic Node Discovery enabled, you only need to specify only one node.
Import
  • Click the button to start the import. ClusterControl will connect to the Galera node, discover the configuration for the rest of the members, and start managing/monitoring the cluster.

Import Existing MySQL Cluster

ClusterControl can manage and monitor an existing production deployed MySQL Cluster (NDB). A minimum of 2 management nodes and 2 data nodes is required.

When importing an existing MySQL Cluster, ClusterControl will perform the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

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 SSH User to perform passwordless SSH. See Passwordless SSH.
Sudo Password
  • Specify the password if the SSH user that you specified under SSH User requires sudo password to run super-privileged commands. Ignore this if SSH User is the root or has no sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.

Define Management Server

Field Description
Management server 1
  • Specify the IP address or hostname of the first MySQL Cluster management node.
Management server 2
  • Specify the IP address or hostname of the second MySQL Cluster management node.
Server Port
  • MySQL Cluster management port. The default port is 1186.

Define Data Nodes

Field Description
Port
  • MySQL Cluster data node port. The default port is 2200.
Add Nodes
  • Specify the IP address or hostname of the MySQL Cluster data node.

Define MySQL Servers

Field Description
Root Password
  • MySQL root password.
Server Port
  • MySQL port. Default to 3306.
MySQL Installation Directory
  • MySQL server installation path where ClusterControl can find the mysql binaries
Enable information_schema Queries
  • Toggle on to enable information_schema queries to track databases and table growth. Queries to the information_schema may not be suitable when having many database objects (hundreds of databases, hundreds of tables in each database, triggers, users, events, stored procedures, etc). If disabled, the query that would be executed will be logged so it can be determined if the query is suitable in your environment.
  • This is not recommended for clusters with more than 2000 database objects.
Enable Node AutoRecovery
  • ClusterControl will perform automatic recovery if it detects any of the nodes in the cluster is down.
Enable Cluster AutoRecovery
  • ClusterControl will perform automatic recovery if it detects the cluster is down or degraded.
Add Nodes
  • Specify the IP address or hostname of the MySQL Cluster API/SQL node.
Import
  • Click the button to start the import. ClusterControl will connect to the MySQL Cluster nodes, discover the configuration for the rest of the nodes, and start managing/monitoring the cluster.

Import Existing MongoDB ReplicaSet

ClusterControl is able to manage and monitor an existing MongoDB/Percona Server for MongoDB 3.x and 4.x replica set.

When importing an existing MongoDB ReplicaSet, ClusterControl will perform the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Discover the database role of each node (primary, secondary, arbiter).
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

If SSL/TLS is required, ClusterControl only supports a proper CAFile configuration, as shown in the MongoDB documentation, and does not support the --allowInvalidCertificates flag.

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
  • Specify the password if the SSH user that you specified under SSH User requires sudo password to run super-privileged commands. Ignore this if SSH User is the root or has no sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.

Define MongoDB Servers

Field Description
Vendor
  • Percona – Percona Server for MongoDB by Percona.
  • MongoDB – MongoDB Server by MongoDB Inc (formerly 10gen).
Version
  • The supported MongoDB version is 3.4, 3.6, 4.0, and 4.2.
Server Port
  • MongoDB server port. The default is 27017.
Admin User
  • MongoDB admin user.
Admin Password
  • Password for MongoDB Admin User.
MongoDB Auth DB
  • MongoDB database to authenticate against. Default is admin.
Hostname
  • Specify one IP address or hostname of the MongoDB replica set member. ClusterControl will automatically discover the rest.
Import
  • Click the button to start the import. ClusterControl will connect to the specified MongoDB node, discover the configuration for the rest of the nodes, and start managing/monitoring the cluster.

Import Existing MongoDB Shards

ClusterControl can manage and monitor an existing MongoDB/Percona Server for MongoDB 3.x and 4.x sharded cluster setup.

When importing an existing MongoDB Sharded Cluster, ClusterControl will perform the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Discover the database role of each node (mongos, mongoconfig, primary, secondary, arbiter).
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

If SSL/TLS is required, ClusterControl only supports a proper CAFile configuration, as shown in the MongoDB documentation and does not support the --allowInvalidCertificates flag.

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 Number
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.

Set Routers/Mongos

Configuration Server

Field Description
Server Port
  • MongoDB mongos server port. The default is 27017.
Add More Routers
  • Specify the IP address or hostname of the MongoDB mongos.

Database Settings

Field Description
Vendor
  • Percona – Percona Server for MongoDB by Percona
  • MongoDB – MongoDB Server by MongoDB Inc
Version
  • The supported MongoDB version is 3.4, 3.6, 4.0, and 4.2.
Admin User
  • MongoDB admin user.
Admin Password
  • Password for MongoDB Admin User.
MongoDB Auth DB
  • MongoDB database to authenticate against. Default is admin.
Import
  • Click the button to start the import. ClusterControl will connect to the specified MongoDB mongos, discover the configuration for the rest of the members, and start managing/monitoring the cluster.

Import Existing PostgreSQL & TimescaleDB

ClusterControl is able to manage/monitor an existing set of PostgreSQL or TimeScaleDB for Streaming Replication version 9.6 and later. Individual hosts specified in the same list will be added to the same server group in the UI. ClusterControl assumes that you are using the same database admin password for all instances specified in the group.

When importing an existing PostgreSQL or TimescaleDB Streaming Replication, ClusterControl will perform the following:

  • Verify SSH connectivity to all nodes.
  • Detect the host environment and operating system.
  • Discover the database role of each node (master, slave, TimescaleDB extension).
  • Pull the configuration files.
  • Generate the authentication key and register the nodes into ClusterControl.

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 SSH User to perform passwordless SSH. See Passwordless SSH.
Sudo Password
  • Specify the password if the SSH user that you specified under SSH User requires sudo password to run super-privileged commands. Ignore this if SSH User is root or has no sudo password.
SSH Port
  • Specify the SSH port for target nodes. ClusterControl assumes SSH is running on the same port on all nodes.

Define PostgreSQL Servers

Field Description
Server Port
  • PostgreSQL port on the target server/cluster. Default to 5432. ClusterControl assumes PostgreSQL/TimeScaleDB is running on the same port on all nodes.
User
  • PostgreSQL user on the target server/cluster. Recommended to use PostgreSQL/TimeScaleDBdbapostgreadmuser.
Password
  • Password for User. ClusterControl assumes that you are using the same admin password for all instances under this group.
Version
  • PostgreSQL/TimeScaleDB server version on the target server/cluster. Supported versions are 9.6, 10.x, 11.x and 12.x.
Basedir
  • PostgreSQL/TimeScaleDB base directory. Default is /usr. ClusterControl assumes all PostgreSQL/TimeScaleDB nodes are using the same base directory.
Add Node
  • Specify all PostgreSQL/TimeScaleDB instances that you want to group under this cluster.
Import
  • Click the button to start the import. ClusterControl will connect to the PostgreSQL/TimeScaleDB instances, import configurations and start managing them.
Was this article helpful to you? Yes No 1