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 f48f337dedf..5e5be826b9a 100644 --- a/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md +++ b/src/current/_includes/cockroachcloud/backups/cloud-api-get-put.md @@ -1,4 +1,4 @@ -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. +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. {{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. diff --git a/src/current/_includes/cockroachcloud/backups/managed-backup-upgrade-downgrade.md b/src/current/_includes/cockroachcloud/backups/managed-backup-upgrade-downgrade.md new file mode 100644 index 00000000000..45e1ebd0b5f --- /dev/null +++ b/src/current/_includes/cockroachcloud/backups/managed-backup-upgrade-downgrade.md @@ -0,0 +1,3 @@ +If you have upgraded from a {{ site.data.products.basic }} cluster to a {{ site.data.products.standard }} cluster, the existing backup schedules will still apply, but you can then configure the frequency and retention of future managed backups in the {{ site.data.products.standard }} cluster. + +If you have downgraded from a {{ site.data.products.standard }} cluster to a {{ site.data.products.basic }} cluster, existing managed backups will be retained for the configured retention duration. The default managed backups in {{ site.data.products.basic }} clusters will be taken every 24 hours and have a 30-day retention. \ 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 index 8e70be13e2d..68ea5c6157d 100644 --- a/src/current/_includes/cockroachcloud/backups/review-settings.md +++ b/src/current/_includes/cockroachcloud/backups/review-settings.md @@ -1 +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 +Before modifying cluster backup settings, review details on backup settings for [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#managed-backup-settings). \ No newline at end of file diff --git a/src/current/_includes/cockroachcloud/filter-tabs/managed-backups.md b/src/current/_includes/cockroachcloud/filter-tabs/managed-backups.md new file mode 100644 index 00000000000..ea7e9f305ea --- /dev/null +++ b/src/current/_includes/cockroachcloud/filter-tabs/managed-backups.md @@ -0,0 +1,4 @@ +{% assign tab_names_html = "CockroachDB Basic;CockroachDB Standard;CockroachDB Advanced" %} +{% assign html_page_filenames = "managed-backups-basic.html;managed-backups.html;managed-backups-advanced.html" %} + +{% include filter-tabs.md tab_names=tab_names_html page_filenames=html_page_filenames page_folder="cockroachcloud" %} \ No newline at end of file diff --git a/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json b/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json index 9887a885f81..5615c443dcb 100644 --- a/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json @@ -516,8 +516,25 @@ }, { "title": "Managed Backups", - "urls": [ - "/cockroachcloud/managed-backups.html" + "items": [ + { + "title": "Managed Backups for Basic Clusters", + "urls": [ + "/cockroachcloud/managed-backups-basic.html" + ] + }, + { + "title": "Managed Backups for Standard Clusters", + "urls": [ + "/cockroachcloud/managed-backups.html" + ] + }, + { + "title": "Managed Backups for Advanced Clusters", + "urls": [ + "/cockroachcloud/managed-backups-advanced.html" + ] + } ] }, { diff --git a/src/current/cockroachcloud/managed-backups-advanced.md b/src/current/cockroachcloud/managed-backups-advanced.md new file mode 100644 index 00000000000..c32d281df36 --- /dev/null +++ b/src/current/cockroachcloud/managed-backups-advanced.md @@ -0,0 +1,242 @@ +--- +title: Managed Backups in CockroachDB Advanced Clusters +summary: Learn about CockroachDB Cloud managed backups. +toc: true +docs_area: manage +cloud: true +--- + +{% include cockroachcloud/backups/managed-backup-description.md %} + +{% include cockroachcloud/filter-tabs/managed-backups.md %} + +This page describes managed backups in {{ site.data.products.advanced }} clusters. You can configure the following: + +- The [frequency](#frequency) of the backups to meet [recovery point objective (RPO)]({% link {{site.current_cloud_version}}/disaster-recovery-overview.md %}) requirements. +- The [retention](#retention) of the backups to set how long Cockroach Labs retains the backups. + +{{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. +{{site.data.alerts.end}} + +## Managed backup settings + +{{site.data.alerts.callout_info}} +Configurable managed backup settings are available in all [supported versions]({% link releases/release-support-policy.md %}#supported-versions) of CockroachDB on {{ site.data.products.advanced }} clusters. +{{site.data.alerts.end}} + +{{ 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). +- The [Cloud API](#cloud-api). + +{% 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 %}). + +You can set backup frequency to one of the following options: + +{% include cockroachcloud/backups/frequency-settings.md %} + +### Retention + +You can set your retention duration **once**. After you have adjusted the retention, the duration will only apply to new backups. The available retention options are: + +{% include cockroachcloud/backups/retention-settings.md %} + +{% include cockroachcloud/backups/retention-deleted-cluster.md %} + +## Considerations + +- Every backup will be stored entirely in a single region, which is chosen at random from the list of cluster regions at the time of cluster creation. This region will be used indefinitely to store backups. +- You can perform a cross-cluster restore across {{ site.data.products.advanced }} clusters that belong to the same organization. However, this cross-cluster restore is not supported for {{ site.data.products.standard }} and {{ site.data.products.basic }} clusters. +- You cannot restore a backup of a multi-region database into a single-region database. +- For details on managed backups and enabling CMEK in {{ site.data.products.advanced }} clusters, refer to [Backup and restore operations on a cluster with CMEK]({% link cockroachcloud/cmek.md %}#backup-and-restore-operations-on-a-cluster-with-cmek). + +## Cloud Console + +### View backups + +Click on **Backup and Restore** in the **Data section** of the left-side navigation to access the **Backup Recovery** page. + +The **Backups** tab displays a list of your full and incremental cluster backups. Use the calendar drop-down to view all backups taken on a certain date. + +For each backup, the following details display: + +- **Data From**: The date and time the backup was taken. +- **Status**: The backup's status, `In Progress` or `Complete`. +- **Type**: Whether the backup is a full or incremental backup. +- **Expires In**: The remaining number of days Cockroach Labs will retain the backup. +- [**Databases**](#databases): The number of databases included in the backup. +- **Restore**: [Restore a particular cluster backup](#restore-an-advanced-cluster), click **Restore** in the corresponding row. + +#### Databases + +To view the databases included in the backup, click the number in the **Databases** column on the **Backups** tab. + +For each database in the backup, the following details display: + +- The **Name** of the database. +- The number of [**Tables**](#tables) in the database. If a database does not contain tables, it will not display in the **Databases** view. +- **Restore**: To [restore a database](#restore-a-database), click **Restore** in the corresponding row. + + To view the tables in the database, click the number in the [**Tables**](#tables) column. + +#### Tables + +To view the tables in a database, click the number in the **Tables** column on the [**Databases**](#databases) page for a particular backup. + +For each table in the database, the **Name** of the table displays. + +To [restore a table](#restore-a-table), click **Restore** in the corresponding row. + +### 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 %} + +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. + +To modify the [frequency](#frequency) of backups, click on the dropdown under **Schedule backups every**. This will display the option to select one of the following: + +{% 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 %} + +### Incomplete Backups + +To view any failed or pending backups, click the **Incomplete Backups** tab on the **Backup and Restore** page. + +For each incomplete backup, the following details display: + +- **Started**: The date and time the backup job began. +- **Duration**: The amount of time the backup job ran for. +- **Status**: The error code and message for failed backup jobs. +- **Description**: The SQL command corresponding to the failed or pending backup job. + +### Restore data + +Users with the [Org Administrator]({% link cockroachcloud/authorization.md %}#org-administrator), [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator), or [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) roles can perform the following from the Console: + +- [Restore a cluster](#restore-an-advanced-cluster) +- [Restore a database](#restore-a-database) +- [Restore a table](#restore-a-table) + +#### Restore an Advanced cluster + +{{site.data.alerts.callout_danger}} +The restore completely erases all data in the destination cluster. All cluster data is replaced with the data from the backup. The destination cluster will be unavailable while the job is in progress. + +This operation is disruptive and is to be performed with caution. Use the [Principle of Least Privilege (PoLP)](https://wikipedia.org/wiki/Principle_of_least_privilege) as a golden rule when designing your system of privilege grants. +{{site.data.alerts.end}} + +To restore a cluster: + +1. Find the cluster backup on the **Backups** tab. +1. Click **Restore** for the cluster you want to restore. + + The **Restore cluster** module displays with backup details. + +1. Select the cluster to restore to. You can restore to either the same cluster or a different {{ site.data.products.advanced }} cluster in the same organization. Incompatible versions cannot be selected. By default, the option shows the current cluster. The dropdown displays options to restore to a different cluster. + + Select the **Skip localities check** box if you want to skip checking localities of a cluster before a restore when there are mismatched cluster regions between the backup's cluster and the destination cluster. + +1. Click **Continue**. + +1. Enter the name of the destination cluster. + +1. Once you have reviewed the restore details, click **Restore**. + + The [**Restore Jobs** tab](#restore-jobs) will show you the status of your restore and update when the restore job has been created successfully. + +#### Restore a database + +To restore a database: + +1. On the **Backups** tab, find the cluster backup containing the database you want to restore, and click the number in the corresponding **Databases** column. +1. In the **Databases** view, click **Restore** for the database you want to restore. + + The **Restore database** module displays with backup details. + +1. In the **Restore to** fields: + - Select the name of the destination cluster. + - Type the name of the destination database. + + {{site.data.alerts.callout_info}} + Resolve any naming conflicts by using [`DROP`]({% link {{site.current_cloud_version}}/drop-database.md %}) or [`RENAME`]({% link {{site.current_cloud_version}}/alter-database.md %}#rename-to) on the existing database. If you enter a unique name in the **Restore to** field, a new database will be created. + {{site.data.alerts.end}} + +1. Select any of the **Dependency options** to skip. You can: + - **Skip missing foreign keys**, which will remove missing [foreign key]({% link {{site.current_cloud_version}}/foreign-key.md %}) constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring. + - **Skip missing sequences**, which will ignore [sequence]({% link {{site.current_cloud_version}}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence). + - **Skip missing views**, which will skip restoring [views]({% link {{site.current_cloud_version}}/views.md %}) that cannot be restored because their dependencies are not being restored at the same time. + - **Skip localities check**, which will skip checking localities of a cluster before a restore when there are mismatched cluster regions between the backup's cluster and the destination cluster. + +1. Click **Continue**. +1. Once you have reviewed the restore details, click **Restore**. + + When the restore job has been created successfully, you will be taken to the [**Restore Jobs** tab](#restore-jobs), which will show you the status of your restore. + +When the restore is complete, be sure to set any database-specific [zone configurations]({% link {{site.current_cloud_version}}/configure-replication-zones.md %}) and, if applicable, [grant privileges]({% link {{site.current_cloud_version}}/grant.md %}). + +#### Restore a table + +To restore a table: + +1. Find the cluster backup containing the table you want to restore, and click the number in the corresponding **Databases** column. +1. In the **Databases** view, find the database containing the table you want to restore, and click the number in the corresponding **Tables** column. + + The **Tables** view displays. + +1. Click **Restore** for the table you want to restore. + + The **Restore table** module displays with backup details. + +1. In the **Restore to** fields: + - Select the name of the destination cluster. + - Type the name of the destination database. (Before restoring, ensure that you do not have an existing table with the same name.) + + {{site.data.alerts.callout_info}} + If you enter the name of an existing database, the table will be restored into that existing database. To use the name of an existing database, first resolve any naming conflicts with existing tables by using [`DROP`]({% link {{site.current_cloud_version}}/drop-table.md %}) or [`RENAME`]({% link {{site.current_cloud_version}}/alter-table.md %}#rename-to) on the table. If you enter a unique name in the **Restore to** field, a new database will be created. + {{site.data.alerts.end}} + +1. Select any of the **Dependency options** to skip. You can: + - **Skip missing foreign keys**, which will remove missing [foreign key]({% link {{site.current_cloud_version}}/foreign-key.md %}) constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring. + - **Skip missing sequences**, which will ignore [sequence]({% link {{site.current_cloud_version}}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence). + - **Skip missing views**, which will skip restoring [views]({% link {{site.current_cloud_version}}/views.md %}) that cannot be restored because their dependencies are not being restored at the same time. + +1. Click **Continue**. +1. Once you have reviewed the restore details, click **Restore**. + + When the restore job has been created successfully, you will be taken to the [**Restore Jobs** tab](#restore-jobs), which will show you the status of your restore. + +#### Restore Jobs + +To view the status of your restore, click on the **Restore Jobs** tab from the cluster **Backup and Restore** page. + +For each restore job, the tab will display: + +- **Source > Destination**: The source cluster, database, or table to the destination cluster, database, or table. +- **Restore type**: Whether the job is a cluster, database, table restore. +- **Backup taken on**: The date the backup was originally taken. +- **Status**: The status of the restore job `Preparing`, `Running`, `Succeeded`, `Failed`. +- **Restore start**: The date the restore job was initiated. +- **Restore end**: The date the restore job ened (whether successful or unsuccessful). +- **Job ID**: The job ID of the restore job. + +## Cloud API + +{% include cockroachcloud/backups/cloud-api-get-put.md %} \ No newline at end of file diff --git a/src/current/cockroachcloud/managed-backups-basic.md b/src/current/cockroachcloud/managed-backups-basic.md new file mode 100644 index 00000000000..1bdcf942f01 --- /dev/null +++ b/src/current/cockroachcloud/managed-backups-basic.md @@ -0,0 +1,71 @@ +--- +title: Managed Backups in CockroachDB Basic Clusters +summary: Learn about CockroachDB Cloud managed backups. +toc: true +docs_area: manage +cloud: true +--- + +{% include cockroachcloud/backups/managed-backup-description.md %} + +{% include cockroachcloud/filter-tabs/managed-backups.md %} + +This page describes managed backups in {{ site.data.products.basic }} clusters, which 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. +{{site.data.alerts.end}} + +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. + +When a {{ site.data.products.basic }} cluster is deleted, or the customer’s agreement with Cockroach Labs has terminated, managed backups taken on the cluster will be retained for 30 days, after which the backups will be deleted. + +For details on viewing and managing the backups, refer to the [Cloud Console](#restore-a-cluster) section. + +## Upgrades and downgrades + +{% include cockroachcloud/backups/managed-backup-upgrade-downgrade.md %} + +## Considerations + +- Every backup will be stored entirely in a single region, which is chosen at random from the list of cluster regions at the time of cluster creation. This region will be used indefinitely to store backups. + +## Cloud Console + +### View backups + +Click on **Backup and Restore** in the **Data section** of the left-side navigation to access the **Backup Recovery** page. + +This page displays a list of your cluster backups. Use the calendar drop-down to view all backups taken on a certain date. + +For each backup, the following details display: + +- **Data From**: The date and time the backup was taken. +- **Status**: The backup's status, `In Progress` or `Complete`. +- **Expires In**: The remaining number of days Cockroach Labs will retain the backup. +- **Restore**: Restore a particular cluster backup, click [**Restore**](#restore-a-cluster) in the corresponding row. + +### Restore a cluster + +{{site.data.alerts.callout_danger}} +The restore completely erases all data in the destination cluster. All cluster data is replaced with the data from the backup. The destination cluster will be unavailable while the job is in progress. + +This operation is disruptive and is to be performed with caution. Use the [Principle of Least Privilege (PoLP)](https://wikipedia.org/wiki/Principle_of_least_privilege) as a golden rule when designing your system of privilege grants. +{{site.data.alerts.end}} + +Performing a restore will cause your cluster to be unavailable for the duration of the restore. All current data is deleted, and the cluster will be restored to the state it was in at the time of the backup. + +To restore a cluster: + +1. Find the cluster backup on the **Backup Recovery** page. +1. Click **Restore** for the cluster you want to restore. + + The **Restore cluster** module displays with backup details. + +1. You can restore a backup to the same cluster. + + {{site.data.alerts.callout_info}} + If you need to restore data into a new or different cluster, use [self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) or [contact support]({% link {{site.current_cloud_version}}/support-resources.md %}). + {{site.data.alerts.end}} + +1. Click **Restore**. \ No newline at end of file diff --git a/src/current/cockroachcloud/managed-backups.md b/src/current/cockroachcloud/managed-backups.md index 60cdf2b0e21..42ce3f4358e 100644 --- a/src/current/cockroachcloud/managed-backups.md +++ b/src/current/cockroachcloud/managed-backups.md @@ -1,18 +1,19 @@ --- -title: Managed Backups +title: Managed Backups in CockroachDB Standard Clusters summary: Learn about CockroachDB Cloud managed backups. toc: true docs_area: manage +cloud: true --- {% include cockroachcloud/backups/managed-backup-description.md %} -You can configure the following in [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#standard-and-advanced-clusters): +{% include cockroachcloud/filter-tabs/managed-backups.md %} -- The frequency of the backups to meet [recovery point objective (RPO)]({% link {{site.current_cloud_version}}/disaster-recovery-overview.md %}) requirements. -- The retention of the backups to set how long Cockroach Labs retains the backups. +This page describes managed backups in {{ site.data.products.standard }} clusters. You can configure the following: -[{{ site.data.products.basic }} clusters](#basic-clusters) have a default non-configurable schedule. +- The [frequency](#frequency) of the backups to meet [recovery point objective (RPO)]({% link {{site.current_cloud_version}}/disaster-recovery-overview.md %}) requirements. +- The [retention](#retention) of the backups to set how long Cockroach Labs retains the backups. {{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. @@ -20,38 +21,22 @@ 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 in [{{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters](#standard-and-advanced-clusters). - -[{{ 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. - -When a {{ site.data.products.basic }} cluster is deleted, or the customer’s agreement with Cockroach Labs has terminated, managed backups taken on the cluster will be retained for 30 days, after which the backups will be deleted. - -Refer to the [Cloud Console](#restore-a-basic-cluster) section for details on viewing and managing the backups. - -### Standard and Advanced clusters - {{site.data.alerts.callout_info}} Configurable managed backup settings are available in all [supported versions]({% link releases/release-support-policy.md %}#supported-versions) of CockroachDB on {{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters. {{site.data.alerts.end}} -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. +{{ site.data.products.standard }} 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 }}]({% 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). +- The [Cloud Console](#cloud-console). +- The [Cloud API](#cloud-api). {% include cockroachcloud/backups/full-backup-setting-change.md %} -#### Frequency +### 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 %}). @@ -59,7 +44,7 @@ You can set backup frequency to one of the following options: {% include cockroachcloud/backups/frequency-settings.md %} -#### Retention +### Retention You can set your retention duration **once**. After you have adjusted the retention, the duration will only apply to new backups. The available retention options are: @@ -69,9 +54,7 @@ You can set your retention duration **once**. After you have adjusted the retent ## Upgrades and downgrades -If you have upgraded from a {{ site.data.products.basic }} cluster to a {{ site.data.products.standard }} cluster, the existing backup schedules will still apply, but you can then configure the frequency and retention of future managed backups in the {{ site.data.products.standard }} cluster. - -If you have downgraded from a {{ site.data.products.standard }} cluster to a {{ site.data.products.basic }} cluster, existing managed backups will be retained for the configured retention duration. The default managed backups in {{ site.data.products.basic }} clusters will be taken every 24 hours and have a 30-day retention. +{% include cockroachcloud/backups/managed-backup-upgrade-downgrade.md %} ## Considerations @@ -82,58 +65,6 @@ If you have downgraded from a {{ site.data.products.standard }} cluster to a {{ ## Cloud Console -Select the cluster tier to view its Cloud Console functionality: - -
- - - -
- -
- -### View backups in a Basic cluster - -Click on **Backup and Restore** in the **Data section** of the left-side navigation to access the **Backup Recovery** page. - -This page displays a list of your cluster backups. Use the calendar drop-down to view all backups taken on a certain date. - -For each backup, the following details display: - -- **Data From**: The date and time the backup was taken. -- **Status**: The backup's status, `In Progress` or `Complete`. -- **Expires In**: The remaining number of days Cockroach Labs will [retain](#retention) the backup. -- **Restore**: Restore a particular cluster backup, click [**Restore**](#restore-a-basic-cluster) in the corresponding row. - -### Restore a Basic cluster - -{{site.data.alerts.callout_danger}} -The restore completely erases all data in the destination cluster. All cluster data is replaced with the data from the backup. The destination cluster will be unavailable while the job is in progress. - -This operation is disruptive and is to be performed with caution. Use the [Principle of Least Privilege (PoLP)](https://wikipedia.org/wiki/Principle_of_least_privilege) as a golden rule when designing your system of privilege grants. -{{site.data.alerts.end}} - -Performing a restore will cause your cluster to be unavailable for the duration of the restore. All current data is deleted, and the cluster will be restored to the state it was in at the time of the backup. - -To restore a cluster: - -1. Find the cluster backup on the **Backup Recovery** page. -1. Click **Restore** for the cluster you want to restore. - - The **Restore cluster** module displays with backup details. - -1. You can restore a backup to the same cluster. - - {{site.data.alerts.callout_info}} - If you need to restore data into a new or different cluster, use [self-managed backups]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) or [contact support]({% link {{site.current_cloud_version}}/support-resources.md %}). - {{site.data.alerts.end}} - -1. Click **Restore**. - -
- -
- ### View backups Click on **Backup and Restore** in the **Data section** of the left-side navigation to access the **Backup Recovery** page. @@ -192,204 +123,6 @@ To restore a cluster: 1. Click **Restore**. -## Cloud API for Standard clusters - -{% include cockroachcloud/backups/cloud-api-get-put.md %} - -
- -
- -### View backups in an Advanced cluster - -Click on **Backup and Restore** in the **Data section** of the left-side navigation to access the **Backup Recovery** page. - -The **Backups** tab displays a list of your full and incremental cluster backups. Use the calendar drop-down to view all backups taken on a certain date. - -For each backup, the following details display: - -- **Data From**: The date and time the backup was taken. -- **Status**: The backup's status, `In Progress` or `Complete`. -- **Type**: Whether the backup is a full or incremental backup. -- **Expires In**: The remaining number of days Cockroach Labs will retain the backup. -- [**Databases**](#databases): The number of databases included in the backup. -- **Restore**: [Restore a particular cluster backup](#restore-an-advanced-cluster), click **Restore** in the corresponding row. - -#### Databases - -To view the databases included in the backup, click the number in the **Databases** column on the **Backups** tab. - -For each database in the backup, the following details display: - -- The **Name** of the database. -- The number of [**Tables**](#tables) in the database. If a database does not contain tables, it will not display in the **Databases** view. -- **Restore**: To [restore a database](#restore-a-database), click **Restore** in the corresponding row. - - To view the tables in the database, click the number in the [**Tables**](#tables) column. - -#### Tables - -To view the tables in a database, click the number in the **Tables** column on the [**Databases**](#databases) page for a particular backup. - -For each table in the database, the **Name** of the table displays. - -To [restore a table](#restore-a-table), click **Restore** in the corresponding row. - -### 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. - -To modify the [frequency](#frequency) of backups, click on the dropdown under **Schedule backups every**. This will display the option to select one of the following: - -{% 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 %} - -### Incomplete Backups - -To view any failed or pending backups, click the **Incomplete Backups** tab on the **Backup and Restore** page. - -For each incomplete backup, the following details display: - -- **Started**: The date and time the backup job began. -- **Duration**: The amount of time the backup job ran for. -- **Status**: The error code and message for failed backup jobs. -- **Description**: The SQL command corresponding to the failed or pending backup job. - -### Restore data in Advanced clusters - -Users with the [Org Administrator]({% link cockroachcloud/authorization.md %}#org-administrator), [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator), or [Cluster Administrator]({% link cockroachcloud/authorization.md %}#cluster-administrator) roles can perform the following from the Console: - -- [Restore a cluster](#restore-an-advanced-cluster) -- [Restore a database](#restore-a-database) -- [Restore a table](#restore-a-table) - -#### Restore an Advanced cluster - -{{site.data.alerts.callout_danger}} -The restore completely erases all data in the destination cluster. All cluster data is replaced with the data from the backup. The destination cluster will be unavailable while the job is in progress. - -This operation is disruptive and is to be performed with caution. Use the [Principle of Least Privilege (PoLP)](https://wikipedia.org/wiki/Principle_of_least_privilege) as a golden rule when designing your system of privilege grants. -{{site.data.alerts.end}} - -To restore a cluster: - -1. Find the cluster backup on the **Backups** tab. -1. Click **Restore** for the cluster you want to restore. - - The **Restore cluster** module displays with backup details. - -1. Select the cluster to restore to. You can restore to either the same cluster or a different {{ site.data.products.advanced }} cluster in the same organization. Incompatible versions cannot be selected. By default, the option shows the current cluster. The dropdown displays options to restore to a different cluster. - - Select the **Skip localities check** box if you want to skip checking localities of a cluster before a restore when there are mismatched cluster regions between the backup's cluster and the destination cluster. - -1. Click **Continue**. - -1. Enter the name of the destination cluster. - -1. Once you have reviewed the restore details, click **Restore**. - - The [**Restore Jobs** tab](#restore-jobs) will show you the status of your restore and update when the restore job has been created successfully. - -#### Restore a database - -To restore a database: - -1. On the **Backups** tab, find the cluster backup containing the database you want to restore, and click the number in the corresponding **Databases** column. -1. In the **Databases** view, click **Restore** for the database you want to restore. - - The **Restore database** module displays with backup details. - -1. In the **Restore to** fields: - - Select the name of the destination cluster. - - Type the name of the destination database. - - {{site.data.alerts.callout_info}} - Resolve any naming conflicts by using [`DROP`]({% link {{site.current_cloud_version}}/drop-database.md %}) or [`RENAME`]({% link {{site.current_cloud_version}}/alter-database.md %}#rename-to) on the existing database. If you enter a unique name in the **Restore to** field, a new database will be created. - {{site.data.alerts.end}} - -1. Select any of the **Dependency options** to skip. You can: - - **Skip missing foreign keys**, which will remove missing [foreign key]({% link {{site.current_cloud_version}}/foreign-key.md %}) constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring. - - **Skip missing sequences**, which will ignore [sequence]({% link {{site.current_cloud_version}}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence). - - **Skip missing views**, which will skip restoring [views]({% link {{site.current_cloud_version}}/views.md %}) that cannot be restored because their dependencies are not being restored at the same time. - - **Skip localities check**, which will skip checking localities of a cluster before a restore when there are mismatched cluster regions between the backup's cluster and the destination cluster. - -1. Click **Continue**. -1. Once you have reviewed the restore details, click **Restore**. - - When the restore job has been created successfully, you will be taken to the [**Restore Jobs** tab](#restore-jobs), which will show you the status of your restore. - -When the restore is complete, be sure to set any database-specific [zone configurations]({% link {{site.current_cloud_version}}/configure-replication-zones.md %}) and, if applicable, [grant privileges]({% link {{site.current_cloud_version}}/grant.md %}). - -#### Restore a table - -To restore a table: - -1. Find the cluster backup containing the table you want to restore, and click the number in the corresponding **Databases** column. -1. In the **Databases** view, find the database containing the table you want to restore, and click the number in the corresponding **Tables** column. - - The **Tables** view displays. - -1. Click **Restore** for the table you want to restore. - - The **Restore table** module displays with backup details. - -1. In the **Restore to** fields: - - Select the name of the destination cluster. - - Type the name of the destination database. (Before restoring, ensure that you do not have an existing table with the same name.) - - {{site.data.alerts.callout_info}} - If you enter the name of an existing database, the table will be restored into that existing database. To use the name of an existing database, first resolve any naming conflicts with existing tables by using [`DROP`]({% link {{site.current_cloud_version}}/drop-table.md %}) or [`RENAME`]({% link {{site.current_cloud_version}}/alter-table.md %}#rename-to) on the table. If you enter a unique name in the **Restore to** field, a new database will be created. - {{site.data.alerts.end}} - -1. Select any of the **Dependency options** to skip. You can: - - **Skip missing foreign keys**, which will remove missing [foreign key]({% link {{site.current_cloud_version}}/foreign-key.md %}) constraints (i.e., when the referenced table is not in the backup or is not being restored) before restoring. - - **Skip missing sequences**, which will ignore [sequence]({% link {{site.current_cloud_version}}/show-sequences.md %}) dependencies (i.e., the `DEFAULT` expression that uses the sequence). - - **Skip missing views**, which will skip restoring [views]({% link {{site.current_cloud_version}}/views.md %}) that cannot be restored because their dependencies are not being restored at the same time. - -1. Click **Continue**. -1. Once you have reviewed the restore details, click **Restore**. - - When the restore job has been created successfully, you will be taken to the [**Restore Jobs** tab](#restore-jobs), which will show you the status of your restore. - -#### Restore Jobs - -To view the status of your restore, click on the **Restore Jobs** tab from the cluster **Backup and Restore** page. - -For each restore job, the tab will display: - -- **Source > Destination**: The source cluster, database, or table to the destination cluster, database, or table. -- **Restore type**: Whether the job is a cluster, database, table restore. -- **Backup taken on**: The date the backup was originally taken. -- **Status**: The status of the restore job `Preparing`, `Running`, `Succeeded`, `Failed`. -- **Restore start**: The date the restore job was initiated. -- **Restore end**: The date the restore job ened (whether successful or unsuccessful). -- **Job ID**: The job ID of the restore job. - -## Cloud API for Advanced clusters - -{% include cockroachcloud/backups/cloud-api-get-put.md %} - -
- - - - - - - - - - - +## Cloud API +{% include cockroachcloud/backups/cloud-api-get-put.md %} \ No newline at end of file diff --git a/src/current/releases/cloud.md b/src/current/releases/cloud.md index 537406ba2eb..7b01fd87562 100644 --- a/src/current/releases/cloud.md +++ b/src/current/releases/cloud.md @@ -425,7 +425,7 @@ In addition, this release includes the following features:

Console changes

- The **Add database** button on the [**Databases** page]({% link cockroachcloud/databases-page.md %}) of the Console is temporarily disabled. -- CockroachDB {{ site.data.products.dedicated }} [restore jobs](https://www.cockroachlabs.com/docs/cockroachcloud/managed-backupsfilters=advanced#restore-data-in-advanced-clusters) now have the following more descriptive statuses: `Preparing`, `Running`, `Reverting`, `Finalizing`, `Succeeded`, and `Failed` statuses. Additionally, destination clusters of self-service restores now display a `Restoring` state during the restore. +- CockroachDB {{ site.data.products.dedicated }} [restore jobs]({% link cockroachcloud/managed-backups-advanced.md %}#restore-data) now have the following more descriptive statuses: `Preparing`, `Running`, `Reverting`, `Finalizing`, `Succeeded`, and `Failed` statuses. Additionally, destination clusters of self-service restores now display a `Restoring` state during the restore. - The [**Databases** page]({% link cockroachcloud/databases-page.md %}) now includes additional statistics for clusters running [v23.1.0]({% link releases/v23.1.md %}) and later. - You can now set up an AWS CloudWatch integration and view its status directly from the [**Tools** page]({% link cockroachcloud/export-metrics-advanced.md %}) of the CockroachDB {{ site.data.products.cloud }} Console. @@ -446,7 +446,7 @@ In addition, this release includes the following features: - Organizations that have purchased premium support will now see it included in their [invoices]({% link cockroachcloud/billing-management.md %}). - Cross-cluster [restores]({% link cockroachcloud/managed-backups.md %}#restore-a-cluster) are now limited to CockroachDB {{ site.data.products.dedicated }} clusters with a major version greater than or equal to the major version of the source cluster. -- The [**Restore jobs**]({% link cockroachcloud/managed-backups.md %}?filters=advanced#restore-data-in-advanced-clusters) tab of the **Backups page** now shows more information about a restore job, such as the source and destination clusters, the restore type, the backup size, and the job's progress. +- The [**Restore jobs**]({% link cockroachcloud/managed-backups-advanced.md %}#restore-data) tab of the **Backups page** now shows more information about a restore job, such as the source and destination clusters, the restore type, the backup size, and the job's progress.

Security updates