Take or Schedule a Cluster Backup
- Capella Operational
- how-to
You can take an on-demand cluster backup to back up your entire Couchbase Capella cluster, or schedule backups.
Prerequisites
-
You have the Project Owner role for the project with the cluster you want to back up. If you have the Organization Owner role, you have Project Owner permissions.
For more information about roles in Capella, see Manage Organizations and Access.
Take an On-Demand Cluster Backup
To take an on-demand backup on your Capella cluster:
-
On the Operational Clusters page, select the cluster you want to back up.
-
Go to
. -
Click Take Backup Now.
-
In the Backup Retention list, choose how long to keep your backup on your cluster.
The default retention period for cluster backups is 7 days.
-
Click Start Backup.
To take a cluster backup from the Capella Management API, see management-api-reference:index.adoc#tag/Cloud-Snapshot-Backups-and-Restore/operation/createCloudSnapshotBackup. |
Schedule Cluster Backups
To create a schedule for cluster backups on your Capella cluster:
-
On the Operational Clusters page, select the cluster where you want to schedule regular backups.
-
Go to
. -
Click Set Schedule or Edit Schedule.
-
Enter the time you want your cluster backups to start.
-
Choose how frequently Capella should take a cluster backup, and how long scheduled backups should be retained on your cluster.
By default, Capella takes Cloud Snapshots backups every 4 hours and keeps them for 7 days.
-
(Optional) If you change your backup retention while editing your schedule, choose whether Capella should apply the new retention to existing scheduled cluster backups.
-
Click Set Backup Schedule or Save Backup Schedule.
If you have an Azure cluster, Capella displays the estimated number of cluster backups that will be taken by your schedule. Azure limits your total number of incremental backups to a maximum of 500. After 500 incremental snapshot backups, Azure starts using full cluster backups and your cluster backup costs will greatly increase. |
To schedule cluster backups from the Capella Management API, see management-api-reference:index.adoc#tag/Cloud-Snapshot-Backups-Schedule/operation/upsertCloudSnapshotBackupSchedule. |
Next Steps
If you set a schedule for your cluster backups, Capella starts your schedule at the time you specified in UTC. Using your Cloud Service Provider’s snapshot service, Capella takes a backup of your cluster at the interval set in the schedule.
If you want to stop taking cluster backups on a schedule, click Delete Schedule.
You can change your cluster backup schedule at any time.
For more information about how to restore a cluster backup, see Restore a Cluster Backup.