Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Back Up and Restore An Entire Cluster

  • Capella Operational
  • concept
    +
    With a Cloud Snapshot cluster backup, you can backup and restore an entire cluster and all of its buckets in a single backup.

    Specifically, Couchbase Capella uses the following snapshot services, based on your chosen Cloud Service Provider (CSP) for your cluster:

    Backup Types

    Each Cloud Snapshot cluster backup stands on its own as a full, complete backup of your cluster’s storage. This is different from bucket backups, which can be full or incremental. You can restore or delete a backup independently - each cluster backup does not depend on other backups to be restored.

    Your CSP’s backup service, which is the underlying backup mechanism for your cluster backups, takes incremental storage snapshots for any backup after your first cluster backup. Even though the incrementality of your backups is determined by your CSP, each of your backups can still be restored or deleted independently through Capella. When you delete a cluster backup or it expires, your CSP manages the deletion so that only the data that’s no longer needed to restore another backup is removed.

    The incrementality of your backups, or how much data has changed between each of your backups, is determined by your CSP’s backup service. Your backup size and backup retention policies determine your backup costs. Capella bases your billing for your cluster backups on the backup storage usage reports from your CSP.

    If you use Cloud Snapshot backups on an Azure cluster, Azure limits your total number of incremental backups to a maximum of 500. After 500 snapshot backups, Azure starts using full cluster backups. If you exceed 500 snapshot backups stored on your Azure-hosted cluster, your cluster backup costs will greatly increase.

    Bucket Backups and Cloud Snapshot Cluster Backups

    Similar to bucket backups, you can take on-demand cluster backups. You can also choose to schedule cluster backups.

    Cloud Snapshots back up and restore the entire storage for your cluster. Use bucket backups to back up and restore the data in a single bucket. For example, an on-demand bucket backup can back up data from a single bucket for data migration and granular backups and restores of data.

    You cannot download cluster backups. If you need to download a backup to use with cbbackupmgr, use a bucket backup.

    Cluster backups do not capture Memory Only bucket data. Use a bucket backup to back up a Memory Only bucket.

    Backup Encryption

    If your cluster uses customer-managed encryptions keys (CMEK) for cluster storage encryption, any cluster backups you create for that cluster use your CMEK. Otherwise, Capella uses its standard encryption for cluster backups.

    You cannot choose to use CMEK for a cluster backup if your cluster is not already encrypted with a CMEK. Bucket backups still do not support CMEK.

    Do not delete a Key Management System (KMS) Key ID until any cluster backups using that Key ID have expired. If you delete the Key ID, your backup becomes unusable. Encryption Key IDs must be enabled and available to restore an encrypted backup to a Capella cluster.

    If you delete your CMEK ID from Capella, contact Couchbase Capella Support to use your backups.

    To view the CMEK ID and Key IDs currently used by your backups, use the Management API or go to Backup  Cluster Backups and expand the entry for a backup.

    For more information about CMEK in Capella, see Use Customer-Managed Encryption Keys (CMEK) at Rest.

    Restoring Cluster Backups

    You can only restore cluster backups to the same cluster with an identical configuration to the time of the cluster backup.

    Before Capella restores a cluster backup, all existing data on the destination cluster is destroyed. You cannot use your cluster while you’re restoring a cluster backup. Restore operations can take time to complete.

    The time it takes to restore your cluster is not considered to be downtime based on the Capella Cloud Service Availability agreement.

    If the number of nodes deployed in your cluster changed between your backup and restore operations, Capella reverts your cluster configuration to the number of nodes present in the backup. Take care when restoring backups to make sure you do not lose necessary node configuration changes.

    Restoring a cluster backup also deletes all cluster access credentials and allowed IP addresses on your cluster.

    Before you restore a cluster backup, use version 4 of the Management API to get a list of all available cluster access credentials and get a list of all allowed IP addresses on your cluster.

    You can use the list to recreate your cluster access credentials and allowed IP addresses later.

    For more information about cluster access credentials, see Configure Cluster Access Credentials. For more information about allowed IP addresses, see Configure Allowed IP Addresses.

    See Also