From f65d2bf64c9af7097a626fa19fbdea2e49e616bb Mon Sep 17 00:00:00 2001 From: Kathryn Hancox Date: Fri, 20 Sep 2024 14:11:04 -0400 Subject: [PATCH] Feedback --- .../backups/cloud-api-get-put.md | 10 +++++----- src/current/cockroachcloud/managed-backups.md | 18 +++++++++++------- 2 files changed, 16 insertions(+), 12 deletions(-) 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 0432da32f5a..75c77928c13 100644 --- a/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md +++ b/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md @@ -18,7 +18,7 @@ curl --request GET \ Set the following: - `{cluster_id}` is the unique ID of the cluster. Use this ID when making API requests. You can find the cluster ID in the cluster's Cloud Console page. Find your cluster ID in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. The ID should resemble `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. -- `{secret_key}`: is your API key. Refer to [API Access]({% link cockroachcloud/managing-access.md %}#api-access) for more details. +- `{secret_key}` is your API key. Refer to [API Access]({% link cockroachcloud/managing-access.md %}#api-access) for more details. If the request was successful, the API will return details about the managed backup settings: @@ -31,7 +31,7 @@ If the request was successful, the API will return details about the managed bac ~~~ - `{enabled}` shows whether managed backups are enabled or disabled. -- `{frequency_minutes}` is [how often](#frequency) the managed backup will run in minutes. Possible values are: `5`, `10`, `15`, `30`, `60`, `240`, `1440`. +- `{frequency_minutes}` is [how often](#frequency) the managed backup will run in minutes. - `{retention_days}` is the number of days Cockroach Labs will [retain](#retention) the managed backup in storage. ### Modify backup settings on a cluster @@ -51,11 +51,11 @@ curl --request PUT \ Set the following: - `{cluster_id}` is the unique ID of the cluster. Use this ID when making API requests. You can find the cluster ID in the cluster's Cloud Console page. Find your cluster ID in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. The ID should resemble `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. -- `{enabled}` controls whether managed backups run or are disabled. If you are disabling managed backups, you cannot set backup frequency or retention. Possible values are: `true`, `false`. +- `{enabled}` controls whether managed backups are enabled or disabled. If you are disabling managed backups, you cannot set backup frequency or retention. Possible values are: `true`, `false`. - `{frequency_minutes}` determines [how often](#frequency) the managed backup will run in minutes. Possible values are: `5`, `10`, `15`, `30`, `60`, `240`, `1440`. - `{retention_days}` sets the number of days Cockroach Labs will [retain](#retention) the managed backup in storage. You can change `retention_days` for the cluster **once** (whether in the Cloud API or [Cloud Console](#cloud-console)). Possible values are: `2`, `7`, `30`, `90`, `365`. If `{retention_days}` has previously been modified (in the Cloud API or Cloud Console), you will receive the message "cluster already has a retention policy set, open a support ticket to change it". To modify the setting again, contact the [Cockroach Labs Support team](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/support-resources). -- `{secret_key}`: is your API key. Refer to [API Access]({% link cockroachcloud/managing-access.md %}#api-access) for more details. +- `{secret_key}` is your API key. Refer to [API Access]({% link cockroachcloud/managing-access.md %}#api-access) for more details. -If the request was successful, the client will not receive a response payload. \ No newline at end of file +If the request was successful, the client will receive an empty HTTP 200 OK status response. \ No newline at end of file diff --git a/src/current/cockroachcloud/managed-backups.md b/src/current/cockroachcloud/managed-backups.md index e3e3f393c0a..2d4d35ab511 100644 --- a/src/current/cockroachcloud/managed-backups.md +++ b/src/current/cockroachcloud/managed-backups.md @@ -12,7 +12,7 @@ You can configure the following in [{{ site.data.products.standard }} and {{ sit - The frequency of the backups to meet [recovery point objective (RPO)]({% link {{site.current_cloud_version}}/disaster-recovery-overview.md %}#resilience-strategy) requirements. - The retention of the backups to set how long Cockroach Labs retains the backups. -In [{{ site.data.products.basic }} clusters](#basic-clusters), you can view the default daily managed backups in the Cloud Console. +[{{ site.data.products.basic }} clusters](#basic-clusters) have a default non-configurable schedule. {{site.data.alerts.callout_info}} In addition to managed backups, you can take manual backups to your own storage bucket with self-managed backups. Refer to the [Take and Restore Self-Managed Backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) page. @@ -28,13 +28,13 @@ You can modify the settings of managed backups in [{{ site.data.products.standar 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 or organization is deleted, Cockroach Labs retains the backup for 30 days. +When you delete a {{ site.data.products.basic }} cluster or the [organization]({% link cockroachcloud/authorization.md %}#overview-of-the-cockroachdb-cloud-authorization-model) is deleted, the cluster's managed backups will follow the default retention period of 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). ### Standard and Advanced clusters -In {{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters you can configure the [frequency](#frequency) and [retention](#retention) of managed backups. +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. @@ -198,9 +198,11 @@ To restore a cluster: ## Cloud API for Standard clusters -{% include cockroachcloud/backups/cloud-api-get-put.md %} - +{{site.data.alerts.callout_info}} {% include cockroachcloud/backups/full-backup-setting-change.md %} +{{site.data.alerts.end}} + +{% include cockroachcloud/backups/cloud-api-get-put.md %} @@ -384,9 +386,11 @@ For each restore job, the tab will display: ## Cloud API for Advanced clusters -{% include cockroachcloud/backups/cloud-api-get-put.md %} - +{{site.data.alerts.callout_info}} {% include cockroachcloud/backups/full-backup-setting-change.md %} +{{site.data.alerts.end}} + +{% include cockroachcloud/backups/cloud-api-get-put.md %}