Upload Backup to Cloud

Automated backups created using ClusterControl are supported to be offloaded from own premise to external cloud storage. By offloading your database backups to the cloud, you are ensured of redundancy, data durability, and potentially easier disaster recovery.

Supported clouds available are the following:

Amazon S3
Google Cloud Storage (GCS)
Azure Blob Storage (through an S3-compatible interface)
Other S3-compatible storage (for example, MinIO)

Enabling you to upload your backups to your cloud environment requires that you must have done integrating your Cloud Providers. If you have not done yet, please make sure you have added and setup integration for your cloud storage credentials.

Uploading backups to the cloud

All supported database clusters by ClusterControl shares the same approach when dealing with uploading of backups to the cloud. These procedures are tailored by ClusterControl to make it straightforward with usability through GUI clicks replacing those automated playbooks that DevOps or SysOps might have dealt with.

With that said, the step-by-step guide are provided thru the succeeding sections. Before moving forward thru the steps, there are important pointers for uploading backups to the cloud using ClusterControl as it has its limits. There are certain backup methods that are created using ClusterControl that does not provide the feature and this is tabulated in the next section.

Support Matrix

Most database clusters supported by ClusterControl include the backup verification feature. For the complete list, checkout below:

Database	Vendor	Topology	Backup Methods
MySQL	Percona, Oracle	Standalone, replication	`mysqldump`, `xtrabackup`
MariaDB	MariaDB	Standalone, replication	`mysqldump`, `mariabackup`
Galera Cluster	MariaDB, Percona	Galera certification-based replication	`mysqldump`, `xtrabackup`/`mariabackup`
PostgreSQL	PostgreSQL, EnterpriseDB	Standalone, streaming replication	`pgdumpall`, `pg_basebackup`
TimescaleDB	TimescaleDB	Standalone, streaming replication	`pgdumpall`, `pg_basebackup`
MongoDB	MongoDB, Percona, MongoDB Enterprise	Replica Set	`rdb, aof`
Redis	Redis, Valkey	Sentinel, cluster	`rdb, aof`
Microsoft SQL Server for Linux	Microsoft	Standalone, Always On availability group	`mssqlfull`

Prerequisites

Backup should be created using ClusterControl and from an existing cluster.
Must have done setting up your cloud storage credentials
supported cloud providers for object storage services are only AWS S3, Google Cloud Storage (GCS), Azure Blob Storage, and other S3-compatible storage (MinIO, DigitalOcean Spaces, etc.)
Ensure proper network connectivity and interoperability between the controller, your database clusters, and your cloud providers.
Ensure that you have appropriate user permissions and privileges to your bucket or target object storage location.

Default Configuration

Retention period is set to 180 days if not specified.

Steps to Upload a Backup

As mentioned above, all supported database clusters shares the same approach and the steps to do it are applicable for all of them based on the Support Matrix. Although, if a backup is uploaded to the cloud, the UI applies a slight change.

This slight change shows a different approach in the step-by-step guide which is tackled in the next section of uploading a backup.

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and make sure you click or set the view to All Backups (default).
Choose a backup you would like to restore and click the ellipsis button (...).
Select and click Upload option. This will display a prompt with all the procedures in one display to upload the backup.
In the prompt, the following elements are displayed:
- Backup ID: This displays the backup ID assigned for the selected backup and also when this was created.
- Cloud Storage: In this section, it will cover the elements required for all cloud storage information
  - Credentials: Select your named cloud credentials profile to use for authentication. This is the credentials you have already setup during setting up your integrations in Cloud storage credentials section.
  - Bucket: Select your existing bucket or type to create new.
  - Location path: Directory under bucket where backup will be stored. Backup will be stored in bucket root directory if location path is empty
  - Retention period: By default, it will set to 180 days. Specify a number to set the number of days you want your backup to retain.
  - Delete after upload: This is Off by default. When enabled, this means that delete local backup copy after it has been uploaded to the cloud.
Click Upload button to execute and upload the backup to the cloud.

To be added soon

Recommended Next Steps

Steps to Re-upload a Backup (for backups already in the cloud)

As mentioned in the previous step-by-step section, there are slight changes when a backup is already uploaded and present in the cloud. This also shows that backups can be downloaded as an option. Backups that are already in the cloud can still be re-uploaded. Take for an example, if the backup that is uploaded already in the cloud but was accidentally deleted, the backup copy stored in the ClusterControl premise means that it is still be re-uploaded to overwrite its existing directory or file.

As showed earlier in the Support Matrix, most of the clusters supported upload to the cloud. However, one cluster that does not affected by this is Microsoft SQL Server for Linux clusters. Although it supports uploading to the cloud but download options is not yet currently supported. See Download Backup From Cloud for more details.

Make sure to follow the steps below to get through the uploading or re-uploading of backup to the cloud.

ClusterControl GUIClusterControl CLI

Go to the Clusters dashboard. Choose your target source cluster then click.
Go to the Backups tab and make sure you click or set the view to All Backups (default).
Choose a backup you would like to restore and click the ellipsis button (...).
Select and click Cloud options, then select and click Upload option button.
In the prompt, the following elements are displayed:
- Backup ID: This displays the backup ID assigned for the selected backup and also when this was created.
- Cloud Storage: In this section, it will cover the elements required for all cloud storage information
  - Credentials: Select your named cloud credentials profile to use for authentication. This is the credentials you have already setup during setting up your integrations in Cloud storage credentials section.
  - Bucket: Select your existing bucket or type to create new.
  - Location path: Directory under bucket where backup will be stored. Backup will be stored in bucket root directory if location path is empty
  - Retention period: By default, it will set to 180 days. Specify a number to set the number of days you want your backup to retain.
  - Delete after upload: This is Off by default. When enabled, this means that delete local backup copy after it has been uploaded to the cloud.
Click Upload button to execute and upload the backup to the cloud.

To be added soon

Recommended Next Steps