From d0819d4543920bb220a9416133d78d666552a91e Mon Sep 17 00:00:00 2001 From: qiancai Date: Mon, 12 Jun 2023 19:15:33 +0800 Subject: [PATCH 1/3] Update configure-maintenance-window.md --- tidb-cloud/configure-maintenance-window.md | 35 +++++++++++----------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/tidb-cloud/configure-maintenance-window.md b/tidb-cloud/configure-maintenance-window.md index bd913e5e49b25..ccae09edb6602 100644 --- a/tidb-cloud/configure-maintenance-window.md +++ b/tidb-cloud/configure-maintenance-window.md @@ -5,11 +5,11 @@ summary: Learn how to configure maintenance window for your cluster. # Configure Maintenance Window -A maintenance window is a designated timeframe during which planned maintenance activities, such as operating system updates, security patches, and infrastructure upgrades, are performed automatically to ensure the reliability, security, and performance of the TiDB Cloud service. +A maintenance window is a designated timeframe during which planned maintenance tasks, such as operating system updates, security patches, and infrastructure upgrades, are performed automatically to ensure the reliability, security, and performance of the TiDB Cloud service. During a maintenance window, the maintenance is executed on TiDB clusters one by one so the overall impact is minimal. Although there might be temporary connection disruptions or QPS fluctuations, the clusters remain available, and the existing data import, backup, restore, migration, and replication tasks can still run normally. -By configuring the maintenance window, you can easily schedule and manage maintenance activities to minimize the maintenance impact. For example, you can set the start time of the maintenance window to avoid peak hours of your application workloads. +By configuring the maintenance window, you can easily schedule and manage maintenance tasks to minimize the maintenance impact. For example, you can set the start time of the maintenance window to avoid peak hours of your application workloads. > **Note:** > @@ -36,12 +36,13 @@ During a maintenance window, some operations are allowed, while some are not. - Create import tasks, migration jobs, or changefeeds - Scale specifications of migration jobs or changefeeds -## Get notifications for maintenance activities +## Get notifications for maintenance windows To avoid potential disruptions, it is important to be aware of the maintenance schedules and plan your operations accordingly. -For every maintenance window, TiDB Cloud sends three email notifications to all project members at the following time points: +For every maintenance window, TiDB Cloud sends four email notifications to all project members at the following time points: +- Two weeks before a maintenance window starts (excluding urgent maintenance windows) - 72 hours before a maintenance window starts - The time when a maintenance window is started - The time when a maintenance window is completed @@ -52,7 +53,7 @@ Regular maintenance ensures that essential updates are performed to safeguard Ti If a maintenance window is planned, the default start time of the window is 03:00 Wednesday (based on the time zone of your TiDB Cloud organization) of the target week. -You can modify the start time to your preferred time or defer maintenance activities until the deadline as follows: +You can modify the start time to your preferred time or defer maintenance tasks until the deadline as follows: 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [Clusters](https://tidbcloud.com/console/clusters) page of your project. @@ -64,34 +65,34 @@ You can modify the start time to your preferred time or defer maintenance activi 3. On the **Admin** page, click **Maintenance** in the left navigation pane. - - If any maintenance activities are displayed, check the descriptions, scheduled start time, and deadline. The maintenance activities will start at the designated time. + - If any maintenance tasks are displayed, check the descriptions, scheduled start time, and deadline. The maintenance tasks will start at the designated time. - - If there is no maintenance data, it means no maintenance activity is scheduled recently. + - If there is no maintenance data, it means no maintenance task is scheduled recently. 4. (Optional) Click to modify the start time of the maintenance window. Note that the maintenance will be performed at the specified start time only if there is a maintenance window planned for that week. -5. To defer the start time of a scheduled maintenance activity, click **Defer** in the **Action** column and change it to the next feasible maintenance window before the deadline. +5. To defer the start time of a scheduled maintenance task, click **Defer** in the **Action** column and change it to the next feasible maintenance window before the deadline. - If you need to defer the maintenance activity beyond the deadline, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md#tidb-cloud-support) for assistance. + If you need to defer the maintenance task beyond the deadline, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md#tidb-cloud-support) for assistance. ## FAQs -- What are maintenance activities? +- What are maintenance tasks? - Maintenance activities typically include operating system updates, security patches, and infrastructure upgrades. + Maintenance tasks typically include operating system updates, security patches, and infrastructure upgrades. - Can I disable a maintenance window? - No. The maintenance window is enabled by default and cannot be disabled. You can modify the start time of the maintenance window or defer a maintenance activity to 2 to 4 weeks until the deadline. For more information, see [View and configure maintenance windows](#view-and-configure-maintenance-windows). + No. The maintenance window is enabled by default and cannot be disabled. You can modify the start time of the maintenance window or defer a maintenance task to 2 to 4 weeks until the deadline. For more information, see [View and configure maintenance windows](#view-and-configure-maintenance-windows). - How long does a maintenance window last? - It depends. For each project, maintenance is executed on eligible TiDB clusters one by one. The duration of maintenance varies depending on the number of clusters, cluster data size, and the maintenance activities to be performed. + It depends. For each project, maintenance is executed on eligible TiDB clusters one by one. The duration of maintenance varies depending on the number of clusters, cluster data size, and the maintenance tasks to be performed. -- Will maintenance activities be performed on clusters in any status? +- Will maintenance tasks be performed on clusters in any status? - No. TiDB Cloud checks the cluster status before performing a maintenance activity on a cluster. + No. TiDB Cloud checks the cluster status before performing a maintenance task on a cluster. - - If the cluster is in the **Creating** or **Paused** status, maintenance activities are not required. + - If the cluster is in the **Creating** or **Paused** status, maintenance tasks are not required. - If the cluster is running a daily or manual backup, the maintenance will be delayed and triggered until the current backup is successfully completed. Note that for clusters with large data volumes, the backup process might take a long time, such as 12 hours. To minimize the impact on the clusters, it is recommended to carefully set the start time for backups and the maintenance window. - - If the cluster is in any other status, the maintenance activities will start as scheduled. + - If the cluster is in any other status, the maintenance tasks will start as scheduled. From 2547fd4ee90d806b9ca56e0782334ed0b30bb830 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 12 Jun 2023 19:23:09 +0800 Subject: [PATCH 2/3] Update tidb-cloud/configure-maintenance-window.md --- tidb-cloud/configure-maintenance-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/configure-maintenance-window.md b/tidb-cloud/configure-maintenance-window.md index ccae09edb6602..ea2ff6b7dfe30 100644 --- a/tidb-cloud/configure-maintenance-window.md +++ b/tidb-cloud/configure-maintenance-window.md @@ -42,7 +42,7 @@ To avoid potential disruptions, it is important to be aware of the maintenance s For every maintenance window, TiDB Cloud sends four email notifications to all project members at the following time points: -- Two weeks before a maintenance window starts (excluding urgent maintenance windows) +- Two weeks before a maintenance window starts (excluding urgent maintenance) - 72 hours before a maintenance window starts - The time when a maintenance window is started - The time when a maintenance window is completed From 3cc688c15fee980711659f5abed0d5999d1d2a17 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 12 Jun 2023 19:42:55 +0800 Subject: [PATCH 3/3] Update tidb-cloud/configure-maintenance-window.md --- tidb-cloud/configure-maintenance-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/configure-maintenance-window.md b/tidb-cloud/configure-maintenance-window.md index ea2ff6b7dfe30..5d39c28d53c00 100644 --- a/tidb-cloud/configure-maintenance-window.md +++ b/tidb-cloud/configure-maintenance-window.md @@ -42,7 +42,7 @@ To avoid potential disruptions, it is important to be aware of the maintenance s For every maintenance window, TiDB Cloud sends four email notifications to all project members at the following time points: -- Two weeks before a maintenance window starts (excluding urgent maintenance) +- Two weeks before a maintenance window starts (excluding urgent maintenance tasks) - 72 hours before a maintenance window starts - The time when a maintenance window is started - The time when a maintenance window is completed