-
Notifications
You must be signed in to change notification settings - Fork 459
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update for managed backups cloud 2.0 (#18919)
- Loading branch information
Showing
62 changed files
with
664 additions
and
695 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
CockroachDB supports two types of backups: | ||
|
||
- **Managed-service backups**: Cockroach Labs takes automated backups of CockroachDB {{ site.data.products.serverless }} and CockroachDB {{ site.data.products.dedicated }} clusters that are stored in Cockroach Labs' cloud storage. {% if page.name != "use-managed-service-backups.md" %} See [Use Managed-Service Backups]({% link cockroachcloud/use-managed-service-backups.md %}) to learn more about the type and frequency of backups supported for both CockroachDB {{ site.data.products.cloud }} clusters. {% else %} {% endif %} | ||
- {% if page.name == "take-and-restore-customer-owned-backups.md" %} **Customer-owned backups**: {% else %} **[Customer-owned backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %})**: {% endif %} You can take manual backups and store them in your [cloud storage buckets]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}) using the [`BACKUP`]({% link {{site.current_cloud_version}}/backup.md %}) statement. Customer-owned backups are supported in CockroachDB {{ site.data.products.serverless }}, CockroachDB {{ site.data.products.dedicated }}, and CockroachDB {{ site.data.products.core }}. | ||
- **Managed backups**: Cockroach Labs takes automated backups of CockroachDB {{ site.data.products.cloud }} clusters that are stored in Cockroach Labs' cloud storage. {% if page.name != "managed-backups.md" %} Refer to [Managed Backups]({% link cockroachcloud/managed-backups.md %}) to learn more about the type and frequency of backups supported for both CockroachDB {{ site.data.products.cloud }} clusters. {% else %} {% endif %} | ||
- {% if page.name == "take-and-restore-self-managed-backups.md" %} **Self-managed backups**: {% else %} **[Self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %})**: {% endif %} You can take manual backups and store them in your [cloud storage buckets]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}) using the [`BACKUP`]({% link {{site.current_cloud_version}}/backup.md %}) statement. Self-managed backups are supported in CockroachDB {{ site.data.products.serverless }}, CockroachDB {{ site.data.products.dedicated }}, and CockroachDB {{ site.data.products.core }}. |
65 changes: 65 additions & 0 deletions
65
src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
You can use the [CockroachDB Cloud API]({% link cockroachcloud/cloud-api.md %}) to [view](#get-information-on-backup-settings) and [modify](#modify-backup-settings-on-a-cluster) managed backup settings in **{{ site.data.products.standard }} and {{ site.data.products.advanced }}** clusters. | ||
|
||
{{site.data.alerts.callout_info}} | ||
The [service account]({% link cockroachcloud/authorization.md %}#service-accounts) associated with the secret key must have the [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) role. | ||
{{site.data.alerts.end}} | ||
|
||
### Get information on backup settings | ||
|
||
To retrieve information about a specific cluster, make a `GET` request to the `/v1/clusters/{cluster_id}/backups/config` endpoint. | ||
|
||
{% include_cached copy-clipboard.html %} | ||
~~~ shell | ||
curl --request GET \ | ||
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups/config \ | ||
--header 'Authorization: Bearer {secret_key}' | ||
~~~ | ||
|
||
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. | ||
|
||
If the request was successful, the API will return details about the managed backup settings: | ||
|
||
~~~json | ||
{ | ||
"enabled": true, | ||
"retention_days": 30, | ||
"frequency_minutes": 240 | ||
} | ||
~~~ | ||
|
||
- `{enabled}` shows whether managed backups are enabled or disabled. | ||
- `{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 | ||
|
||
{{site.data.alerts.callout_info}} | ||
{% include cockroachcloud/backups/full-backup-setting-change.md %} | ||
{{site.data.alerts.end}} | ||
|
||
{% 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 %} | ||
~~~ shell | ||
curl --request PUT \ | ||
--url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/backups/config \ | ||
--header 'Authorization: Bearer {secret_key}' \ | ||
--data '{"enabled": true, "frequency_minutes": 30, "retention_days": 2}' | ||
~~~ | ||
|
||
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 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]({% link {{site.current_cloud_version}}/support-resources.md %}). | ||
- `{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 receive an empty HTTP 200 OK status response. |
6 changes: 6 additions & 0 deletions
6
src/current/_includes/cockroachcloud/backups/frequency-settings.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
- 5 minutes | ||
- 10 minutes | ||
- 30 minutes | ||
- 1 hour (default) | ||
- 4 hours | ||
- 24 hours |
1 change: 1 addition & 0 deletions
1
src/current/_includes/cockroachcloud/backups/full-backup-setting-change.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
1 change: 1 addition & 0 deletions
1
src/current/_includes/cockroachcloud/backups/managed-backup-description.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
[_Managed backups_]({% link cockroachcloud/backup-and-restore-overview.md %}) are automated backups of CockroachDB {{ site.data.products.cloud }} clusters that are stored by Cockroach Labs in cloud storage. By default, Cockroach Labs takes and retains managed backups in all {{ site.data.products.cloud }} clusters. In {{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters, you can adjust the default managed backup settings to meet your organization's disaster recovery requirements. |
44 changes: 0 additions & 44 deletions
44
src/current/_includes/cockroachcloud/backups/managed-service-backups-frequency.md
This file was deleted.
Oops, something went wrong.
5 changes: 5 additions & 0 deletions
5
src/current/_includes/cockroachcloud/backups/retention-deleted-cluster.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
When a cluster is deleted, Cockroach Labs will retain the managed backups for for the {% if page.name == "managed-backups.md" %} configured retention time, {% else %} [configured retention time]({% link cockroachcloud/managed-backups.md %}#managed-backup-settings), {% endif %}after which the backups will be deleted. | ||
|
||
If a customer’s agreement with Cockroach Labs has terminated, all managed backups will be retained for a maximum of 30 days and then deleted. If a backup's retention time was set to **less** than 30 days, Cockroach Labs will retain the managed backups for the configured retention time, after which the backups will be deleted. | ||
|
||
To restore a backup from a deleted cluster, you must contact the [Cockroach Labs Support team]({% link {{site.current_cloud_version}}/support-resources.md %}). |
7 changes: 7 additions & 0 deletions
7
src/current/_includes/cockroachcloud/backups/retention-settings.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
- 2 days | ||
- 7 days | ||
- 30 days (default) | ||
- 90 days | ||
- 365 days | ||
|
||
You'll be able to modify the retention setting once for a cluster. To modify the setting again, contact the [Cockroach Labs Support team]({% link {{site.current_cloud_version}}/support-resources.md %}). |
1 change: 1 addition & 0 deletions
1
src/current/_includes/cockroachcloud/backups/review-settings.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.