2. Home
  4. Docs
  6. ClusterControl
  8. User Guide (GUI)
  10. Dashboard
  12. Deploy in the Cloud

Deploy in the Cloud

Opens a step-by-step modal dialog to deploy a new set of database clusters in the cloud. Supported cloud providers are:

  • Amazon Web Service
  • Google Cloud Platform
  • Microsoft Azure

The following database cluster types are supported:

Field Description
MySQL Replication
  • Percona Server 8.0
  • Oracle MySQL Server 8.0
  • MariaDB Server 10.3
  • MariaDB Server 10.4
  • MariaDB Server 10.5
MySQL Galera
  • Percona XtraDB Cluster 5.7
  • Percona XtraDB Cluster 8.0
  • MariaDB 10.2
  • MariaDB 10.3
  • MariaDB 10.4
  • MariaDB 10.5
MongoDB ReplicaSet
  • Percona Server for MongoDB 4.2
  • Percona Server for MongoDB 4.4
  • Percona Server for MongoDB 5.0
  • MongoDB 4.0
  • MongoDB 4.2
  • MongoDB 4.4
  • MongoDB 5.0
PostgreSQL
  • PostgreSQL 11 Streaming Replication
  • PostgreSQL 12 Streaming Replication
  • PostgreSQL 13 Streaming Replication
  • TimescaleDB 11 Streaming Replication

Some prerequisites need to be fulfilled before the deployment:

  • A working cloud credential profile on the supported cloud platform. See Cloud Providers.
  • The date and time for the ClusterControl node must be synced with the NTP server. See Timezone.
  • If the cloud instance is inside a private network, the network must support the auto-assign public IP address. ClusterControl only connects to the created cloud instance via a public network.

Under the hood, the deployment process does the following:

  1. Create cloud instances.
  2. Configure security groups and networking.
  3. Verify the SSH connectivity from ClusterControl to all created instances.
  4. Deploy a database on every instance.
  5. Configure the clustering or replication links.
  6. Register the deployment into ClusterControl.

ClusterControl will trigger a deployment job and the progress can be monitored under ClusterControl → Activity → Jobs.

 

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

Cluster Details

Field Description
Select Cluster Type
  • Choose a cluster.
Select Vendor and Version
  • MySQL Replication Cluster
    • Percona Server 8.0
    • Oracle MySQL Server 8.0
    • MariaDB Server 10.3, MariaDB 10.4 and MariaDB 10.5
  • MySQL Galera
    • Percona XtraDB Cluster 5.7 and 8.0
    • MariaDB 10.2, MariaDB 10.3, MariaDB 10.4 and MariaDB 10.5
  • MongoDB Replica Set
    • MongoDB 4.0, 4.2, 4.4 and 5.0 by MongoDB, Inc
    • Percona Server for MongoDB 4.2, 4.4 and 5.0 by Percona (replica set only)
  • PostgreSQL Streaming Replication
    • PostgreSQL 11.x, 12.x and 13.x (streaming replication only)
  • TimeScaleDB
    • TimeScaleDB 11.x (streaming replication only)

Configure Cluster

MySQL Replication

Field Description
Select Number of Nodes
  • How many nodes for the database cluster. You can start with one but two are recommended.
Cluster Name
  • This value will be used as the instance name or tag. No space is allowed.
MySQL Server Port
  • MySQL server port. The default is 3306.
MySQL Root Password
  • Specify MySQL root password. ClusterControl will configure the same MySQL root password for all instances in the cluster.
my.cnf Template
  • MySQL configuration template file under /etc/cmon/templates or /usr/share/cmon/templates. See Base Template Files for details.
MySQL Server Data Directory
  • Location of MySQL data directory. Default is /var/lib/mysql.

MySQL Galera Cluster

Field Description
Select Number of Nodes
  • How many nodes for the database cluster. You can start with one but three (or a bigger odd number) nodes are recommended.
Cluster Name
  • This value will be used as the instance name or tag. No space is allowed.
MySQL Server Port
  • MySQL server port. The default is 3306.
MySQL Root Password
  • Specify MySQL root password. ClusterControl will configure the same MySQL root password for all instances in the cluster.
my.cnf Template
  • MySQL configuration template file under /etc/cmon/templates or /usr/share/cmon/templates. See Base Template Files for details.
MySQL Server Data Directory
  • Location of MySQL data directory. Default is /var/lib/mysql.

MongoDB Replica Set

Field Description
Select Number of Nodes
  • How many nodes for the database cluster. You can start with one but three (or a bigger odd number) nodes are recommended.
Cluster Name
  • This value will be used as the instance name or tag. No space is allowed.
Admin User
  • MongoDB admin user. ClusterControl will create this user and enable authentication.
Admin Password
  • Password for MongoDB Admin User.
Server Data Directory
  • Location of MongoDB data directory. Default is /var/lib/mongodb.
Server Port
  • MongoDB server port. The default is 27017.
mongodb.conf Template
  • MongoDB configuration template file under /etc/cmon/templates or /usr/share/cmon/templates. See Base Template Files for details.
ReplicaSet Name
  • Specify the name of the replica set, similar to replication.replSetName option in MongoDB.

PostgreSQL Streaming Replication

Field Description
Select Number of Nodes
  • How many nodes for the database cluster. You can start with one but two or more are recommended.
Cluster Name
  • This value will be used as the instance name or tag. No space is allowed.
User
  • Specify the PostgreSQL superuser, for example, dbapostgreadm.
Password
  • Specify the password for the User.
Server Port
  • PostgreSQL server port. The default is 5432.

TimescaleDB Streaming Replication

Field Description
Select Number of Nodes
  • How many nodes for the database cluster. You can start with one but two or more are recommended.
Cluster Name
  • This value will be used as the instance name or tag. No space is allowed.
User
  • Specify the TimeScaleDB superuser, for example, dbapostgreadm.
Password
  • Specify the password for the User.
Server Port
  • TimeScaleDB server port. The default is 5432.

Select Credential

Select one of the existing cloud credentials or you can create a new one by clicking on the Add New Credential button.

Field Description
Add New Credential

 

Select Virtual Machine

Most of the settings in this step are dynamically populated from the cloud provider by the chosen credentials.

Field Description
Operating System
  • Choose a supported operating system from the dropdown.
Instance Size
  • Choose an instance size for the cloud instance.
Virtual Private Cloud (VPC)
  • Exclusive for AWS. Choose a virtual private cloud network for the cloud instance.
Add New
  • Opens the Add VPC wizard. Specify the tag name and IP address block.
SSH Key
  • SSH key location on the ClusterControl host. This key must be able to authenticate to the created cloud instances passwordless.
Storage Type
  • Choose the storage type for the cloud instance.
Allocate Storage
  • Specify the storage size for the cloud instance in GB.

Load Balancer

Field Description
Select Number of Loadbalancers
  • How many nodes for the load balancer nodes. You can start with one but two or more are recommended.
Instance Size
  • Choose an instance size for the cloud instance.
Listen Port (Read/Write)
  • Specify the HAProxy listening port for read-write connections.
Listen Port (Read-Only)
  • Specify the HAProxy listening port for read-only connections.
Policy
  • Choose one of these load balancing policy:
    • leastconn – The server with the lowest number of connections receives the connection.
    • round-robin – Each server is used in turns, according to their weights.
    • source – The same client IP address will always reach the same server as long as no server goes down.

Deployment Summary

Field Description
Subnet
  • Choose one existing subnet for the selected network.
Add New Subnet
  • Opens the Add Subnet wizard. Specify the subnet name, availability zone, and IP CIDR block address. E.g: 10.0.10.0/24
Was this article helpful to you? Yes No