Create Backup

ClusterControl provides an automated and centralized approach to managing backups for your database clusters. Creating a backup can be achieve by Backup on Demand and Schedule a Backup. In this page, the Create Backup focuses on Backup on Demand.

This guide covers the Steps to create a backup using ClusterControl's user interface.

Overview of Backup on Demand

Backup on demand can do the following actions:

Create a single backup instantly
Store backups on premise or in the cloud
Compress and encrypt backups for secure storage

Support Matrix

All database clusters that are supported by ClusterControl allows you to create a backup. For a complete list of our supported database clusters, see below:

Database	Vendor	Topology
MySQL	Percona, Percona Pro, Oracle	Standalone, replication
MariaDB	MariaDB	Standalone, replication
Galera Cluster	MariaDB, Percona	Galera certification-based replication
PostgreSQL	PostgreSQL, EnterpriseDB	Standalone, streaming replication
TimescaleDB	TimescaleDB	Standalone, streaming replication
MongoDB	MongoDB, Percona, MongoDB Enterprise	Replica set, sharded cluster
Redis	Redis, Valkey	Sentinel, cluster
Microsoft SQL Server for Linux	Microsoft	Standalone, Always On availability group
Elasticsearch	Elastic	Single-node cluster, high availability cluster

Prerequisites

When creating a backup, certain requirements should be met in order to create a backup. See below:

Only backup methods that ClusterControl supports can be use to create a backup.
Backup created in ClusterControl can only be stored locally either on the ClusterControl controller or to the registered database nodes available on that cluster. If you have external backup host but not registered in ClusterControl, you can use NFS and share the volume where your backup shall be stored.
You have sufficient storage space for the backup.
You have appropriate user permissions to manage backups.

Creating the backup

The steps on creating a backup can differ depending on the type of database cluster. Make sure you follow the instructions and guide based on the following sections per database cluster you are going to create the backup.

MySQL Replication

The following vendors and versions are supported for creating a backup:

Oracle MySQL - 8.0.
Percona Server for MySQL - 8.0.
Percona Server for MySQL Pro - 8.0.
MariaDB Server - 10.4, 10.5, 10.6 (LTS), 10.11 (LTS) and 11.4 (LTS).

Default configuration

Backup method supported are: mysqldump, xtrabackup by Percona for Percona Server and Oracle MySQL database clusters, mariabackup by MariaDB for MariaDB database clusters.
For mysqldump supports dump type for Schema only, MySQL DB Only, Data Only, Schema And Data, Complete PITR-compatible.
supports upload to the cloud of the following providers: Amazon Web Services, Google Cloud, Microsoft Azure, S3 Compatible storage provider (*upload backups to any AWS S3 compatible cloud storage provider by creating a custom S3 cloud storage credential*)
Compression is set to On.
Retention days is set to 31.
Compression level is set to 6 (System Default).
Use extended insert is set to On when mysqldump is choosen as the backup method.
Backup locks is set to On when xtrabackup is choosen as the backup method.
Xtrabackup parallel copy threads is set to 1.
Storage location is set to Store on controller.
Storage directory is set to /home/vagrant/backups as well as its Backup subdirectory is set to BACKUP-%I.

Steps to create a backup (Backup method: mysqldump)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Replication cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose mysqldump. Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Cannot be set to Off.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
5. Enable partial backup. If you want to have a partial backup, set it to On. This will show a field where you can fill-in the databases you want to backup only or select All Databases.
6. Use extended insert is set to On. If you do not want the extended inserts to generate in your mysqldump file, then set this to Off.
7. One dump file per DB is set to Off. If you want mysqldump to generate backup files per database, set this to On.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Steps to create a backup (Backup method: xtrabackup or mariabackup (full))

ClusterControl GUI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Replication cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose xtrabackup (full), or mariabackup (full). Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Enable partial backup. If you want to have a partial backup, set it to On. This will show a field where you can fill-in the databases you want to backup only or select All Databases.
2. Use ZSTD compression is set to Off. When enabled, will use Zstandard compression. For MySQL/Percona Server versions <8.0.34, it uses QPress.
3. Desync node during backup is set to Off. When enabled or On, this will desync the node that serves as the source of the backup. This is helpful especially when you do not want your cluster to experience large writesets and that let the flow control be manipulated and the node will catch up later once the backup is finished and wsrep_desync=OFF shall be set.
4. Backup locks is set to On by default. When enabled, Backup locks means that xtrabackup behavior uses "LOCK TABLES FOR BACKUP" where it is supported when making a backup. Backup Locks set to Off, it sets --no-backup-locks which use "FLUSH NO_WRITE_TO_BINLOG TABLES" and "FLUSH TABLES WITH READ LOCK" when making a backup.
5. Lock DDL per table is set to Off by default. When enabled, it sets --lock-ddl-per-table. Enable this flag if you have backup errors like InnoDB: An optimized (without redo logging) DDLoperation has been performed. This option is only applied to xtrabackup 2.4.8 and later version. Setting this flag may cause blocked updates to tables for highly loaded servers under some circumstances. Please see https://www.percona.com/blog/2017/08/08/avoiding-the-an-optimized-without-redo-logging-ddloperation-has-been-performed-error-with-percona-xtrabackup and https://jira.mariadb.org/browse/MDEV-14095 and https://jira.mariadb.org/browse/MDEV-5336
6. Xtrabackup parallel copy threads is set to 1. If you want more parallel threads especially for streaming the backup during copy, increase the threads > 1.
7. Network streaming throttle rate (MB/s) is 0. If you want to throttle the rate, specify the MB/s. Throttling the streaming for backup will use the "pv" tool.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

Steps to create a backup (Backup method: xtrabackup or mariabackup (incremental))

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Replication cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose xtrabackup (full), or mariabackup (full). Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Use ZSTD compression is set to Off. When enabled, will use Zstandard compression. For MySQL/Percona Server versions <8.0.34, it uses QPress.
2. Backup locks is set to On by default. When enabled, Backup locks means that xtrabackup behavior uses "LOCK TABLES FOR BACKUP" where it is supported when making a backup. Backup Locks set to Off, it sets --no-backup-locks which use "FLUSH NO_WRITE_TO_BINLOG TABLES" and "FLUSH TABLES WITH READ LOCK" when making a backup.
3. Desync node during backup is set to Off. When enabled or On, this will desync the node that serves as the source of the backup. This is helpful especially when you do not want your cluster to experience large writesets and that let the flow control be manipulated and the node will catch up later once the backup is finished and wsrep_desync=OFF shall be set.
4. Lock DDL per table is set to Off by default. When enabled, it sets --lock-ddl-per-table. Enable this flag if you have backup errors like InnoDB: An optimized (without redo logging) DDLoperation has been performed. This option is only applied to xtrabackup 2.4.8 and later version. Setting this flag may cause blocked updates to tables for highly loaded servers under some circumstances. Please see https://www.percona.com/blog/2017/08/08/avoiding-the-an-optimized-without-redo-logging-ddloperation-has-been-performed-error-with-percona-xtrabackup and https://jira.mariadb.org/browse/MDEV-14095 and https://jira.mariadb.org/browse/MDEV-5336
5. Xtrabackup parallel copy threads is set to 1. If you want more parallel threads especially for streaming the backup during copy, increase the threads > 1.
6. Network streaming throttle rate (MB/s) is 0. If you want to throttle the rate, specify the MB/s. Throttling the streaming for backup will use the "pv" tool.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

MySQL Galera

The following vendors and versions are supported for creating a backup:

Percona XtraDB Cluster - 8.0.
MariaDB Cluster - 10.4, 10.5, 10.6 (LTS), 10.11 (LTS) and 11.4 (LTS).

Default configuration

Backup method supported are: mysqldump, xtrabackup by Percona for Percona Server and Oracle MySQL database clusters, mariabackup by MariaDB for MariaDB database clusters.
for mysqldump supports dump type for Schema only, MySQL DB Only, Data Only, Schema And Data, Complete PITR-compatible.
Supports upload to the cloud of the following providers: Amazon Web Services, Google Cloud, Microsoft Azure, S3 Compatible storage provider (*upload backups to any AWS S3 compatible cloud storage provider by creating a custom S3 cloud storage credential*)
Compression is set to On.
Retention days is set to 31.
Compression level is set to 6 (System Default).
Use extended insert is set to On when mysqldump is choosen as the backup method.
Backup locks is set to On when xtrabackup is choosen as the backup method.
Xtrabackup parallel copy threads is set to 1.
Storage location is set to Store on controller.
Storage directory is set to /home/vagrant/backups as well as its Backup subdirectory is set to BACKUP-%I.

Steps to create a backup (Backup method: mysqldump)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Galera cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose mysqldump. Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Cannot be set to Off.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
5. Enable partial backup. If you want to have a partial backup, set it to On. This will show a field where you can fill-in the databases you want to backup only or select All Databases.
6. Use extended insert is set to On. If you do not want the extended inserts to generate in your mysqldump file, then set this to Off.
7. One dump file per DB is set to Off. If you want mysqldump to generate backup files per database, set this to On.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Steps to create a backup (Backup method: xtrabackup or mariabackup (full))

ClusterControl GUI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Galera cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose xtrabackup (full), or mariabackup (full). Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Enable partial backup. If you want to have a partial backup, set it to On. This will show a field where you can fill-in the databases you want to backup only or select All Databases.
2. Use ZSTD compression is set to Off. When enabled, will use Zstandard compression. For MySQL/Percona Server versions <8.0.34, it uses QPress.
3. Desync node during backup is set to Off. When enabled or On, this will desync the node that serves as the source of the backup. This is helpful especially when you do not want your cluster to experience large writesets and that let the flow control be manipulated and the node will catch up later once the backup is finished and wsrep_desync=OFF shall be set.
4. Backup locks is set to On by default. When enabled, Backup locks means that xtrabackup behavior uses "LOCK TABLES FOR BACKUP" where it is supported when making a backup. Backup Locks set to Off, it sets --no-backup-locks which use "FLUSH NO_WRITE_TO_BINLOG TABLES" and "FLUSH TABLES WITH READ LOCK" when making a backup.
5. Lock DDL per table is set to Off by default. When enabled, it sets --lock-ddl-per-table. Enable this flag if you have backup errors like InnoDB: An optimized (without redo logging) DDLoperation has been performed. This option is only applied to xtrabackup 2.4.8 and later version. Setting this flag may cause blocked updates to tables for highly loaded servers under some circumstances. Please see https://www.percona.com/blog/2017/08/08/avoiding-the-an-optimized-without-redo-logging-ddloperation-has-been-performed-error-with-percona-xtrabackup and https://jira.mariadb.org/browse/MDEV-14095 and https://jira.mariadb.org/browse/MDEV-5336
6. Xtrabackup parallel copy threads is set to 1. If you want more parallel threads especially for streaming the backup during copy, increase the threads > 1.
7. Network streaming throttle rate (MB/s) is 0. If you want to throttle the rate, specify the MB/s. Throttling the streaming for backup will use the "pv" tool.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

Steps to create a backup (Backup method: xtrabackup or mariabackup (incremental))

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MySQL Galera cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose xtrabackup (full), or mariabackup (full). Other option to choose from the backup method available are logical backup [mysqldump] and physical backup [xtrabackup (full), xtrabackup (incremental), mariabackup (full), mariabackup (incremental)]
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Use ZSTD compression is set to Off. When enabled, will use Zstandard compression. For MySQL/Percona Server versions <8.0.34, it uses QPress.
2. Desync node during backup is set to Off. When enabled or On, this will desync the node that serves as the source of the backup. This is helpful especially when you do not want your cluster to experience large writesets and that let the flow control be manipulated and the node will catch up later once the backup is finished and wsrep_desync=OFF shall be set.
3. Backup locks is set to On by default. When enabled, Backup locks means that xtrabackup behavior uses "LOCK TABLES FOR BACKUP" where it is supported when making a backup. Backup Locks set to Off, it sets --no-backup-locks which use "FLUSH NO_WRITE_TO_BINLOG TABLES" and "FLUSH TABLES WITH READ LOCK" when making a backup.
4. Lock DDL per table is set to Off by default. When enabled, it sets --lock-ddl-per-table. Enable this flag if you have backup errors like InnoDB: An optimized (without redo logging) DDLoperation has been performed. This option is only applied to xtrabackup 2.4.8 and later version. Setting this flag may cause blocked updates to tables for highly loaded servers under some circumstances. Please see https://www.percona.com/blog/2017/08/08/avoiding-the-an-optimized-without-redo-logging-ddloperation-has-been-performed-error-with-percona-xtrabackup and https://jira.mariadb.org/browse/MDEV-14095 and https://jira.mariadb.org/browse/MDEV-5336
5. Xtrabackup parallel copy threads is set to 1. If you want more parallel threads especially for streaming the backup during copy, increase the threads > 1.
6. Network streaming throttle rate (MB/s) is 0. If you want to throttle the rate, specify the MB/s. Throttling the streaming for backup will use the "pv" tool.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

PostgreSQL/TimescaleDB

The following vendors and versions are supported for creating a backup:

PostgreSQL from postgresql.org repository - 12, 13, 14, 15, and 16.
PostgreSQL from EDB repository - 12, 13, 14, 15, and 16 (requires a valid EDB repository token).

Default configuration

Backup method supported are: pgdumpall for logical backup, and for binary or physical backups pg_basebackup, pgbackrestfull, pgbackrestdiff, pgbackrestincr
With pgdumpall, PITR is not possible with the selected backup method.
pg_basebackup PITR is disabled when pgbackuprest is configured and setup to manage WAL.
Upload to cloud is not supported if pgbasebackup is selected.
Supports upload to the cloud of the following providers: Amazon Web Services, Google Cloud, Microsoft Azure, S3 Compatible storage provider (*upload backups to any AWS S3 compatible cloud storage provider by creating a custom S3 cloud storage credential*)
Compression is set to On.
Retention days is set to 31.
Compression level is set to 6 (System Default).
Storage location is set to Store on controller.
Storage directory is set to /home/vagrant/backups as well as its Backup subdirectory is set to BACKUP-%I.

Steps to create a backup (Backup method: pgdumpall)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the PostgreSQL/TimescaleDB cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose pgdumpall. Other option to choose from are physical backups: pg_basebackup, pgbackrestfull (full backup), pgbackrestdiff (differential backup), pgbackrestincr (incremental backup)
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Enable partial backup. If you want to have a partial backup, set it to On. This will show a field where you can fill-in the databases you want to backup only or select All Databases.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Steps to create a backup (Backup method: pg_basebackup)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the PostgreSQL/TimescaleDB cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose pg_basebackup. Other option to choose from are logical backup pgdumpall, and physical backups pg_basebackup, pgbackrestfull (full backup), pgbackrestdiff (differential backup), pgbackrestincr (incremental backup)
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Steps to create a backup (Backup method: pgbackrestfull, pgbackrestdiff, pgbackrestincr)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the PostgreSQL/TimescaleDB cluster chosen.
2. Backup method. Choose pgbackrestfull if you want full backup, pgbackrestdiff for differential, and pgbackrestincr for incremental. Other option to choose from are logical backup pgdumpall, and physical backups pg_basebackup.
  1. If pgbackrest is not installed, it will show and display a panel to install the tool. Click Continue button to install the tool
    1. Configuration method shows the following options for your target installation.
      1. Primary. Install on the current master but not on slaves. The backup repository (storing backup data) will be configured to be on the master. There will be no ssh configuration for PgBackRest.
      2. All DB nodes. Install on all database hosts. The backup repository will be created on the current master. Backup will be made by using standby node. PgBackRest will use ssh for communicating between hosts.
      3. All DB nodes and dedicated repository host. All DB nodes and dedicated repository host
        
        Specify your Dedicated repository host using IP or valid hostname or FQDN of your target dedicated repository/backup host.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2 Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
1. Compression level is set to 6 (System default)
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

MongoDB Replica Set

The following vendors and versions are supported for creating a backup:

MongoDB Enterprise - 4.4, 5.0, 6.0 and 7.0
MongoDB Community - 4.4, 5.0, 6.0 and 7.0
Percona Server for MongoDB - 4.4, 5.0, 6.0 and 7.0

Default configuration

Supports only mongodump as backup method.
Retention days is enabled and defaults to 31 days.
Storage location is set to Store on controller.
Storage directory is set to /home/vagrant/backups as well as its Backup subdirectory is set to BACKUP-%I.

Steps to create a backup

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MongoDB Replica Set cluster chosen.
2. Backup method cannot be changed but defaults to mongodump as the sole backup method supported.
3. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Retention is set to On and defaults to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
2. Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

MongoDB Sharded Cluster

The following vendors and versions are supported for creating a backup:

MongoDB - 4.4, 5.0, 6.0 and 7.0
MongoDB Enterprise - 4.4., 5.0, 6.0 and 7.0
Percona - 4.4, 5.0, 6.0 and 7.0

Default configuration

Supports only percona-backup-mongodb or PBM as backup method. PBM is Percona Backup for MongoDB is available for MongoDB 4.0 or later versions.
Retention days is enabled and defaults to 31 days.

Steps to create a backup

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the MongoDB Sharded cluster chosen.
2. Backup method. Defaults to percona-backup-mongodb and is the sole backup method. Option to choose is disabled. By default, it displays a Continue button allowing you to install the backup tool package.
  1. Click Continue button to proceed on installing the percona-backup-mongodb backup tool
    1. Specify the Backup directory. Make sure that the backup directory path is existent. Once ready, hit Install button. Hit Cancel if you are not ready to install yet. If installing the tool, make sure that the job has to be done successfully.
Click Continue.
Second step is Advanced settings.
1. Retention is set to On and defaults to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Redis Sentinel Cluster

The following vendors and versions are supported for creating a backup:

Redis Sentinel - 6 and 7

Default configuration

Uses rdb and aof as backup method.
Backup host points to the primary node as default selection.
Backup runs on the cluster and saves the backup copy in the ClusterControl controller host. You will determine the directory of the backup location in the backup logs once its requested to run.
Compression is set to true or On.
Uses socat command to transfer the file using port 9999 as the default port for transfer or copy. The port 9999 can be changed if you need other port number by going to the Backup Settings.

Steps to create a backup

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the Redis/Valkey cluster chosen.
2. Backup host is set to the primary node. You can opt to choose from primary to replica nodes.
3. Backup method is set to rdb, aof as it's the sole backup method and is disabled for selection.
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5. Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

Redis/Valkey Cluster

The following vendors and versions are supported for creating a backup:

Redis Cluster - 6 and 7
Valkey Cluster - 7 and 8 (only RHEL 8/9 are supported)

Default configuration

Uses rdb and aof as backup method.
Backup runs on the cluster and saves the backup copy in the ClusterControl controller host. You will determine the directory of the backup location in the backup logs once its requested to run.
Compression is set to true or On.
Uses socat command to transfer the file using port 9999 as the default port for transfer or copy. The port 9999 can be changed if you need other port number by going to the Backup Settings.

Steps to create a backup

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the Redis/Valkey cluster chosen.
2. Backup method is set to rdb, aof as it's the sole backup method and is disabled for selection.
3. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Compression level is set to 6 (System default)
4. Use PIGZ for parallel gzip field is set to Off by default. Setting to On will use PIGZ and this shall speed up your compression especially if your data to be back up is huge.
5. Enable encryption is set to Off. When set to On, ClusterControl will automate the generation of encryption key. This key shall be in the /etc/cmon.d/cmon_<cluster_id>.cnf config file.
Click Continue.
Third step is Local storage.
1. In Storage location, you can choose from Store on controller or Store on node, where the node pertains to the source of the backup data being taken and executed.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

SQL Server

The following vendors and versions are supported for creating a backup:

Microsoft SQL Server for Linux - 2019 and 2022

ClusterControl does not use external tool to backup. It relies on the internal backup engine from Microsoft SQL Server itself.

Default configuration

Uses internal backup engine.
Can create backup using methods Full, Differential, and Transaction Log.
Runs backup on the primary node regardless of backup method choosen.
Stores the backup directory in /var/lib/backups.
Stores backup data only in the primary node.
Cannot run backup if primary is down as it cannot find a candidate server.
If backup method choosen not equal to Full, and directory is does not find any previous full backup, it will upgrade its method to Full, making it as the first full backup for that job request.

Steps to create a backup (Full, Differential, Transaction Log)

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the Microsoft SQL Server cluster chosen.
2. Backup host. It is a drop-down element where you can choose where the backup to be taken and executed. Optionally, you can also choose Auto Select which it will choose the best node to execute the backup with least traffic and low load.
3. Backup method. Choose Full if you want full backup. Choose Differential if you want a differential backup. Lastly, choose Transaction Log if you want transaction log backup.
4. Upload backup to cloud is set to Off. If you already setup cloud storage credentials and want to upload to the cloud we support, set this to On.
Click Continue.
Second step is Advanced settings.
1. Compression is set to On as default. Setting to Off will not compress the backup when stored.
2. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
3. Include system databases is set to On by default. Set to Off if you do not want.
Click Continue.
Third step is Local storage.
1. In Storage location field is disabled as backup storage location defaults to the primary node.
2. Storage directory is set to /home/vagrant/backups. Set to a different path if you desire it somewhere else or on a volume where it has large storage space or an NFS volume.
3. Backup subdirectory is set to BACKUP-%I. Basically, the value here is a sub-directory of the path set in Storage directory where %I is an integer that is the backup ID assigned for every process of backup jobs.
Click Continue.
Fourth step is Cloud storage. This step is only visible whenever Upload backup to cloud is set. Otherwise, this step is skipped and fourth step shall proceed to Preview, the last step.
1. In Credentials field is the available credentials you've created in Settings → Cloud storage credentials.
2. Specify in the Bucket field for your target bucket in your S3 storage. For new bucket, make sure to hit the + (plus) sign button and make sure to confirm and hit OK button.
3. Specify the Location path which location you want the backup to be stored under your Bucket assigned.
4. Retention period is set to On. Specify the number of days you want the retention of your backup. Otherwise, set to Off if you do not need retention of your backup.
5. Delete after upload is set to Off. For some instances, you want your backup stored locally to be removed or wipe immediately to reclaim the disk space since backup is already stored safely in the cloud. Turn it On if that is the condition of your environment and setup.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon

ElasticSearch

The following vendors and versions are supported for creating a backup:

Elasticsearch by Elastic versions 7.17, 8.3, 8.15

ClusterControl does not use external tool to backup. It relies on elasticsearch-snapshot tool to backup the data.

Default configuration

Uses Elasticsearch built-in backup engine elasticsearch-snapshot
Repository defaults to the repository assigned or created during deployment or importing of the cluster. This can also be found and modified using parameter elastic_snapshot_repository on the ClusterControl controller host through config file /etc/cmon.d/cmon_<CLUSTER_ID>.cnf, where <CLUSTER_ID> is the cluster id of the Elasticsearch cluster.
Retention days is set to 31.
Backup data shall be stored on the shared location set in the config file /etc/cmon.d/cmon_<CLUSTER_ID>.cnf through parameter elastic_shared_filesystem.

Steps to create a backup

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and click Create backup button.
Choose Backup on Demand
First step is Configuration.
1. Cluster is set to the name of the Elasticsearch cluster chosen.
2. Repository. By default, points to your repository assigned in your /etc/cmon.d/cmon_<CLUSTER_ID>.cnf config file through parameter elastic_snapshot_repository. If you have other repository created, this will show up in the drop-down list.
3. Backup method. This is constant and sets to elastlicsearch-snapshot.
Click Continue.
Second step is Advanced settings.
1. Retention is set to 31 days. Input your desired number if you want less than or greater than the default. Also set to Off if you do not want retention.
Click Continue to proceed the last step Preview.
The last step is Preview, this is the last step where it shows all the values and choosen options for the ClusterControl to use for setting up the backup.

To be added soon