Skip to content

Download Backup from Cloud

ClusterControl offers downloading backup from the cloud. Only existing backups that are allowed to be downloaded from the cloud. This means that downloading of backups are tightly coupled or source-bounded. It is locked only to that uploaded backuptaken using ClusterControl.

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

Prerequisites

  • Backups uploaded from ClusterControl can only be downloaded.
  • Download only to the same cluster where the backup was uploaded.
  • 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 Download a Backup

  1. Go to the Clusters dashboard. Choose your target source cluster then click.

  2. Go to the Backups tab and make sure you click or set the view to All Backups (default).

  3. Choose a backup you would like to restore and click the ellipsis button (...).

  4. Select and click Cloud options, then select and click Download option button.

  5. 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.
    • Download from: This shows where the backup was uploaded and to what cloud it was stored too, which might also linked to your cloud storage credentials already setup.
    • Download to: This is a drop-down element which shows you the nodes in your cluster including the controller. This allows you to choose what node shall store the backup to be downloaded.
    • Backup dir in host: Specify the location of your backup directory to be stored. For example, /opt/backps/aws-backups-download/
    • 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.
  6. Click Download button to execute and download the backup from the cloud.

Recommended Next Steps