Skip to content

Commit

Permalink
[DOC-10237] Document deletion protection
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville committed Jun 13, 2024
1 parent 3dd9763 commit 4085163
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/current/_includes/releases/cloud/2024-06-19.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# June 19, 2024

<h3 id="2024-06-19-security-updates"> Security updates </h3>
<h3 id="2024-06-19-general-updates"> General updates </h3>

- The [IdP-initiated SAML flow]({% link cockroachcloud/cloud-org-sso.md %}#cloud-organization-sso) is now enabled by default. When you configure a [Cloud Organization SSO SAML connection]({% link cockroachcloud/configure-cloud-org-sso.md %}#saml), your users can optionally sign in to CockroachDB {{ site.data.products.cloud }} from your IdP, such as Okta.
- Deletion protection, which helps to prevent a cluster in CockroachDB {{ site.data.products.cloud }} from being deleted by mistake, is generally available for CockroachDB {{ site.data.products.serverless }} and CockroachDB {{ site.data.products.dedicated }} clusters. Only a user with permission to delete a cluster can enable deletion protection for the cluster. Refer to the instructions for [CockroachDB {{ site.data.products.serverless }}]({% link cockroachcloud/serverless-cluster-management.md %}#enable-deletion-protection) and [CockroachDB {{ site.data.products.dedicated }}]({% link cockroachcloud/cluster-management.md %}#enable-deletion-protection).
7 changes: 7 additions & 0 deletions src/current/cockroachcloud/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,12 @@ CockroachDB {{ site.data.products.dedicated }} advanced clusters have a **PCI re

You can also check the status of these features on the [**PCI ready**]({% link cockroachcloud/cluster-overview-page.md %}?filters=dedicated#pci-ready-dedicated-advanced) page of the CockroachDB {{ site.data.products.cloud }} Console.

## Enable deletion protection

To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before a cluster with deletion protection enabled can be deleted, deletion protection must be disabled. A user with permission to delete a cluster can enable deletion protection on the same cluster.

1. Navigate to the **Overview** page for the cluster you want to protect.
1. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click **Save**.

## Delete cluster

Expand All @@ -206,6 +212,7 @@ You will only be billed for a CockroachDB {{ site.data.products.dedicated }} clu
Proceed with the following steps only if you are sure you want to delete a cluster:

1. Navigate to the **Overview** page for the cluster you want to delete.
1. If [deletion protection](#enable-deletion-protection) is enabled, click the pencil icon next to it. Toggle the setting, then click **Save**.
1. Click the **Actions** button in the top right corner.
1. Select **Delete cluster**.
1. In the confirmation window, enter the name of the cluster.
Expand Down
8 changes: 8 additions & 0 deletions src/current/cockroachcloud/serverless-cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ Use the [Managed-Service Backups]({% link cockroachcloud/use-managed-service-bac

You can also [back up and restore]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}) your CockroachDB {{ site.data.products.serverless }} cluster manually. You can take [backups locally]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}) to [`userfile`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/use-userfile-storage) or [back up to cloud storage]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}).

## Enable deletion protection

To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before a cluster with deletion protection enabled can be deleted, deletion protection must be disabled. A user with permission to delete a cluster can enable deletion protection on the same cluster.

1. Navigate to the **Overview** page for the cluster you want to protect.
1. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click **Save**.

## Delete cluster

{{site.data.alerts.callout_danger}}
Expand All @@ -123,6 +130,7 @@ Free CockroachDB {{ site.data.products.serverless }} clusters are subject to del
Proceed with the following steps only if you are sure you want to delete a cluster:

1. Navigate to the **Overview** page for the cluster you want to delete.
1. If [deletion protection](#enable-deletion-protection) is enabled, click the pencil icon next to it. Toggle the setting, then click **Save**.
1. Click the **Actions** button in the top right corner.
1. Select **Delete cluster**.
1. In the confirmation window, enter the name of the cluster.
Expand Down

0 comments on commit 4085163

Please sign in to comment.