From bdd2c1035701fbea6581f96de473f80d85b3466e Mon Sep 17 00:00:00 2001 From: qqqdan Date: Wed, 6 Nov 2024 18:15:26 +0800 Subject: [PATCH 1/7] Update pause-or-resume-tidb-cluster.md --- tidb-cloud/pause-or-resume-tidb-cluster.md | 50 ++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index c465b7dbaa496..4ab2b0ad97491 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -24,11 +24,56 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim ## Pause a TiDB cluster + +
+ +TiDB Cloud supports cluster pause for up to 7 days. If you don't manually resume the cluster within 7 days, TiDB Cloud will automatically resume it for you. + +When a cluster is paused, note the following: + +- TiDB Cloud stops collecting monitoring information of the cluster. +- You cannot read data from or write data to the cluster. +- You cannot import or back up data. +- Only the following costs will be charged: + + - Node Storage Cost + - Data Backup Cost + +- TiDB Cloud stops [automatic backup](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) of the cluster. +- You can view the auto-resume schedule from cluster overview page. TiDB Cloud will send a notification email to project owner and organization owner 24 hours before the auto-resume. + +To pause a cluster, take the following steps: + +1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. +2. In the row of the cluster that you want to pause, click **...**. + + > **Tip:** + > + > Alternatively, you can click the name of the cluster that you want to pause on the **Clusters** page, and then click **...** in the upper-right corner. + +3. Click **Pause** in the drop-down menu. + + The **Pause your cluster** dialog is displayed. + +4. In the dialog, click **Pause** to confirm your choice. + + After you click **Pause**, the cluster will enter the **Pausing** status first. Once the pause operation is done, the cluster will transition to the **Paused** status. + +You can also pause a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). + +
+
+ +> **Note:** +> +> If your organization is created before 2024/11/12, the pause behavior may be still in compatible model . TiDB Cloud will touch you before we change to the new standard pause feature. + When a cluster is paused, note the following: - TiDB Cloud stops collecting monitoring information of the cluster. - You cannot read data from or write data to the cluster. - You cannot import or back up data. +- TiDB Cloud will not auto resume the paused cluster. - Only the following costs will be charged: - Node Storage Cost @@ -55,6 +100,11 @@ To pause a cluster, take the following steps: You can also pause a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). +
+ + + + ## Resume a TiDB cluster After a paused cluster is resumed, note the following: From df851c23b97ac7511911b6bf2bcd802902093797 Mon Sep 17 00:00:00 2001 From: qqqdan Date: Wed, 6 Nov 2024 18:22:09 +0800 Subject: [PATCH 2/7] Update pause-or-resume-tidb-cluster.md --- tidb-cloud/pause-or-resume-tidb-cluster.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 4ab2b0ad97491..924aeb259b306 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -21,14 +21,13 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim - You cannot pause your cluster when a data import task is going on. You can either wait for the import task to be completed or cancel the import task. - You cannot pause your cluster when a backup job is going on. You can either wait for the current backup job to be completed or [delete the running backup job](/tidb-cloud/backup-and-restore.md#delete-a-running-backup-job). - You cannot pause your cluster if it has any [changefeeds](/tidb-cloud/changefeed-overview.md). You need to [delete the existing changefeeds](/tidb-cloud/changefeed-overview.md#delete-a-changefeed) before pausing the cluster. +- TiDB Cloud supports cluster pause for up to 7 days. Exceptionally, some organizations are currently using the compatibile pause feature, which allows for a longer pause, and we will gradually transition them to the standard pause with 7 days limit. ## Pause a TiDB cluster
-TiDB Cloud supports cluster pause for up to 7 days. If you don't manually resume the cluster within 7 days, TiDB Cloud will automatically resume it for you. - When a cluster is paused, note the following: - TiDB Cloud stops collecting monitoring information of the cluster. @@ -40,6 +39,7 @@ When a cluster is paused, note the following: - Data Backup Cost - TiDB Cloud stops [automatic backup](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) of the cluster. +- If you don't manually resume the cluster within 7 days, TiDB Cloud will automatically resume it for you. - You can view the auto-resume schedule from cluster overview page. TiDB Cloud will send a notification email to project owner and organization owner 24 hours before the auto-resume. To pause a cluster, take the following steps: From 57661b683f81c17eb24273335e4147cf5797c502 Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 7 Nov 2024 19:07:10 +0800 Subject: [PATCH 3/7] fix typo and ci --- tidb-cloud/pause-or-resume-tidb-cluster.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 924aeb259b306..132a42003690a 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -21,7 +21,7 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim - You cannot pause your cluster when a data import task is going on. You can either wait for the import task to be completed or cancel the import task. - You cannot pause your cluster when a backup job is going on. You can either wait for the current backup job to be completed or [delete the running backup job](/tidb-cloud/backup-and-restore.md#delete-a-running-backup-job). - You cannot pause your cluster if it has any [changefeeds](/tidb-cloud/changefeed-overview.md). You need to [delete the existing changefeeds](/tidb-cloud/changefeed-overview.md#delete-a-changefeed) before pausing the cluster. -- TiDB Cloud supports cluster pause for up to 7 days. Exceptionally, some organizations are currently using the compatibile pause feature, which allows for a longer pause, and we will gradually transition them to the standard pause with 7 days limit. +- TiDB Cloud supports cluster pause for up to 7 days. Exceptionally, some organizations are currently using the compatible pause feature, which allows for a longer pause, and we will gradually transition them to the standard pause with 7 days limit. ## Pause a TiDB cluster @@ -101,9 +101,7 @@ To pause a cluster, take the following steps: You can also pause a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta).
- - - + ## Resume a TiDB cluster From 583b2bd518113aacea99d373fc401b3ef8960bb8 Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 7 Nov 2024 19:38:40 +0800 Subject: [PATCH 4/7] rewording --- tidb-cloud/pause-or-resume-tidb-cluster.md | 41 +++++++--------------- 1 file changed, 13 insertions(+), 28 deletions(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 132a42003690a..f683643caae35 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -21,12 +21,16 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim - You cannot pause your cluster when a data import task is going on. You can either wait for the import task to be completed or cancel the import task. - You cannot pause your cluster when a backup job is going on. You can either wait for the current backup job to be completed or [delete the running backup job](/tidb-cloud/backup-and-restore.md#delete-a-running-backup-job). - You cannot pause your cluster if it has any [changefeeds](/tidb-cloud/changefeed-overview.md). You need to [delete the existing changefeeds](/tidb-cloud/changefeed-overview.md#delete-a-changefeed) before pausing the cluster. -- TiDB Cloud supports cluster pause for up to 7 days. Exceptionally, some organizations are currently using the compatible pause feature, which allows for a longer pause, and we will gradually transition them to the standard pause with 7 days limit. ## Pause a TiDB cluster +The pause duration and behavior depend on your organization's creation date: + +- Organizations created after November 12, 2024, follow the standard pause behavior with a maximum pause duration of 7 days. +- Organizations created before November 12, 2024, follow the compatible pause behavior, which allows a longer pause duration. These organizations will gradually transition to the standard 7-day limit. + -
+
When a cluster is paused, note the following: @@ -39,34 +43,15 @@ When a cluster is paused, note the following: - Data Backup Cost - TiDB Cloud stops [automatic backup](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) of the cluster. -- If you don't manually resume the cluster within 7 days, TiDB Cloud will automatically resume it for you. -- You can view the auto-resume schedule from cluster overview page. TiDB Cloud will send a notification email to project owner and organization owner 24 hours before the auto-resume. - -To pause a cluster, take the following steps: - -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. -2. In the row of the cluster that you want to pause, click **...**. - - > **Tip:** - > - > Alternatively, you can click the name of the cluster that you want to pause on the **Clusters** page, and then click **...** in the upper-right corner. - -3. Click **Pause** in the drop-down menu. - - The **Pause your cluster** dialog is displayed. - -4. In the dialog, click **Pause** to confirm your choice. - - After you click **Pause**, the cluster will enter the **Pausing** status first. Once the pause operation is done, the cluster will transition to the **Paused** status. - -You can also pause a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). +- The maximum pause duration is 7 days. If you do not manually resume the cluster within 7 days, TiDB Cloud will automatically resume it. +- You can view the auto-resume schedule from the cluster overview page. TiDB Cloud will send a notification email to the organization owner and project owner 24 hours before the cluster is automatically resumed.
-
+
> **Note:** > -> If your organization is created before 2024/11/12, the pause behavior may be still in compatible model . TiDB Cloud will touch you before we change to the new standard pause feature. +> If your organization was created before November 12, 2024, your cluster still follows the compatible pause behavior. TiDB Cloud will notify you before transitioning to the new standard pause behavior. When a cluster is paused, note the following: @@ -81,6 +66,9 @@ When a cluster is paused, note the following: - TiDB Cloud stops [automatic backup](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) of the cluster. +
+ + To pause a cluster, take the following steps: 1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. @@ -100,9 +88,6 @@ To pause a cluster, take the following steps: You can also pause a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). -
- - ## Resume a TiDB cluster After a paused cluster is resumed, note the following: From f4bb0861428c9fe17449d6dda362bb080fa1eff8 Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 11 Nov 2024 15:01:10 +0800 Subject: [PATCH 5/7] Apply suggestions from code review --- tidb-cloud/pause-or-resume-tidb-cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index f683643caae35..14b2d306148fd 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -58,7 +58,7 @@ When a cluster is paused, note the following: - TiDB Cloud stops collecting monitoring information of the cluster. - You cannot read data from or write data to the cluster. - You cannot import or back up data. -- TiDB Cloud will not auto resume the paused cluster. +- TiDB Cloud does not automatically resume the paused cluster. - Only the following costs will be charged: - Node Storage Cost From f35888d79823779d8d2ebb2777f8bf2db9302ace Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Mon, 11 Nov 2024 16:03:36 +0800 Subject: [PATCH 6/7] Update punctuation --- tidb-cloud/pause-or-resume-tidb-cluster.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 14b2d306148fd..3e1631eabfd23 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -26,8 +26,8 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim The pause duration and behavior depend on your organization's creation date: -- Organizations created after November 12, 2024, follow the standard pause behavior with a maximum pause duration of 7 days. -- Organizations created before November 12, 2024, follow the compatible pause behavior, which allows a longer pause duration. These organizations will gradually transition to the standard 7-day limit. +- Organizations created after November 12, 2024 follow the standard pause behavior with a maximum pause duration of 7 days. +- Organizations created before November 12, 2024 follow the compatible pause behavior, which allows a longer pause duration. These organizations will gradually transition to the standard 7-day limit.
From 9cec67bab0dcf42bd17c9212c3c94faf41a006ce Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 11 Nov 2024 18:26:34 +0800 Subject: [PATCH 7/7] Apply suggestions from code review --- tidb-cloud/pause-or-resume-tidb-cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 3e1631eabfd23..c2353224aff93 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -27,7 +27,7 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim The pause duration and behavior depend on your organization's creation date: - Organizations created after November 12, 2024 follow the standard pause behavior with a maximum pause duration of 7 days. -- Organizations created before November 12, 2024 follow the compatible pause behavior, which allows a longer pause duration. These organizations will gradually transition to the standard 7-day limit. +- Organizations created on or before November 12, 2024 follow the compatible pause behavior, which allows a longer pause duration. These organizations will gradually transition to the standard 7-day limit.