diff --git a/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md b/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md index d7f43cdcd4c..0432da32f5a 100644 --- a/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md +++ b/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md @@ -36,6 +36,8 @@ If the request was successful, the API will return details about the managed bac ### Modify backup settings on a cluster +{% include cockroachcloud/backups/review-settings.md %} + To configure the frequency and retention of managed backups, send a `PUT` request to the `/v1/clusters/{cluster_id}/backups/config` endpoint. {% include_cached copy-clipboard.html %} diff --git a/src/current/_includes/cockroachcloud/backups/full-backup-setting-change.md b/src/current/_includes/cockroachcloud/backups/full-backup-setting-change.md new file mode 100644 index 00000000000..1ad6e4292aa --- /dev/null +++ b/src/current/_includes/cockroachcloud/backups/full-backup-setting-change.md @@ -0,0 +1 @@ +Following a change to the backup frequency or retention setting, the cluster will take a full backup immediately, which may impact CPU usage on the cluster. If you are disabling managed backups, the cluster will not take a backup following the change. \ No newline at end of file diff --git a/src/current/_includes/cockroachcloud/backups/review-settings.md b/src/current/_includes/cockroachcloud/backups/review-settings.md new file mode 100644 index 00000000000..8e70be13e2d --- /dev/null +++ b/src/current/_includes/cockroachcloud/backups/review-settings.md @@ -0,0 +1 @@ +Before modifying cluster backup settings, review details on backup settings for [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#standard-and-advanced-clusters). \ No newline at end of file diff --git a/src/current/cockroachcloud/managed-backups.md b/src/current/cockroachcloud/managed-backups.md index 08cb5bd62d5..e3e3f393c0a 100644 --- a/src/current/cockroachcloud/managed-backups.md +++ b/src/current/cockroachcloud/managed-backups.md @@ -20,15 +20,15 @@ In addition to managed backups, you can take manual backups to your own storage ## Managed backup settings -You can modify the settings of managed backups for [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#standard-and-advanced-clusters). +You can modify the settings of managed backups in [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#standard-and-advanced-clusters). -[{{ site.data.products.basic }} clusters](#basic-clusters) have a default configuration that you cannot modify. +[{{ site.data.products.basic }} clusters](#basic-clusters) have default settings that you cannot modify. ### Basic clusters Cockroach Labs will take a managed backup every 24 hours. By default, managed backups will be retained for 30 days in {{ site.data.products.basic }} clusters. -Once a cluster is deleted, Cockroach Labs retains the backup for 30 days. If an organization is deleted, you will lose access to all of the managed backups that Cockroach Labs has taken of the cluster after 30 days. +Once a cluster or organization is deleted, Cockroach Labs retains the backup for 30 days. For more details on restoring a managed backup, refer to the [Cloud Console](#restore-a-basic-cluster) section. To restore a backup from a deleted cluster, you must contact the [Cockroach Labs Support team](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/support-resources). @@ -36,11 +36,17 @@ For more details on restoring a managed backup, refer to the [Cloud Console](#re In {{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters you can configure the [frequency](#frequency) and [retention](#retention) of managed backups. +{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters take a combination of full and incremental backups in order to meet the set frequency. The type of managed backup the cluster takes is **not** configurable. Each incremental backup is dependent on the last full backup, which has an effect on the managed backups that you can restore in the set retention period. + +Full backups in the cluster will be deleted when they reach the set retention period. At this point, any incremental backups dependent on the deleted full backup will also be deleted. The Cloud Console will not list any backups that are beyond the set retention period, or incremental backups that cannot be restored. + For instructions on how to view and configure managed backup settings, use: -- The [Cloud Console](#cloud-console) for {{ site.data.products.standard }} or {{ site.data.products.advanced }}. +- The [Cloud Console](#cloud-console) for [{{ site.data.products.standard }}]({% link cockroachcloud/managed-backups.md %}?filters=standard#cloud-console) or [{{ site.data.products.advanced }}]({% link cockroachcloud/managed-backups.md %}?filters=advanced#cloud-console). - The [Cloud API]({% link cockroachcloud/cloud-api.md %}) for [{{ site.data.products.standard }}]({% link cockroachcloud/managed-backups.md %}?filters=standard#cloud-api-for-standard-clusters) or [{{ site.data.products.advanced }}]({% link cockroachcloud/managed-backups.md %}?filters=advanced#cloud-api-for-advanced-clusters). +{% include cockroachcloud/backups/full-backup-setting-change.md %} + #### Frequency You can configure how frequently Cockroach Labs takes backups, which will determine the cluster's [RPO]({% link {{site.current_cloud_version}}/disaster-recovery-overview.md %}#resilience-strategy). @@ -143,6 +149,12 @@ For each backup, the following details display: ### Modify backup settings +{{site.data.alerts.callout_info}} +{% include cockroachcloud/backups/full-backup-setting-change.md %} +{{site.data.alerts.end}} + +{% include cockroachcloud/backups/review-settings.md %} + Click on **Settings** and the **Backup Settings** module will open. The **Enable backups** switch allows you to enable or disable backups. @@ -151,7 +163,6 @@ To modify the [frequency](#frequency) of backups, click on the dropdown under ** {% include cockroachcloud/backups/frequency-settings.md %} - To modify the [retention](#retention) of backups, click on **Retain backups for**. This will display the following options to select: {% include cockroachcloud/backups/retention-settings.md %} @@ -189,6 +200,8 @@ To restore a cluster: {% include cockroachcloud/backups/cloud-api-get-put.md %} +{% include cockroachcloud/backups/full-backup-setting-change.md %} +
@@ -230,6 +243,12 @@ To [restore a table](#restore-a-table), click **Restore** in the corresponding r ### Modify backup settings in an Advanced cluster +{{site.data.alerts.callout_info}} +{% include cockroachcloud/backups/full-backup-setting-change.md %} +{{site.data.alerts.end}} + +{% include cockroachcloud/backups/review-settings.md %} + On the **Backup and Restore** page, click on **Settings** and the **Backup Settings** module will open. The **Enable backups** switch allows you to enable or disable backups. @@ -367,6 +386,8 @@ For each restore job, the tab will display: {% include cockroachcloud/backups/cloud-api-get-put.md %} +{% include cockroachcloud/backups/full-backup-setting-change.md %} +