Skip to content

cloud: update the maintenance window notification #13839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 13, 2023
Merged

cloud: update the maintenance window notification #13839

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0819d4
Update configure-maintenance-window.md
qiancai Jun 12, 2023
2547fd4
Update tidb-cloud/configure-maintenance-window.md
qiancai Jun 12, 2023
3cc688c
Update tidb-cloud/configure-maintenance-window.md
qiancai Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions tidb-cloud/configure-maintenance-window.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
>
Expand All @@ -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 tasks)
- 72 hours before a maintenance window starts
- The time when a maintenance window is started
- The time when a maintenance window is completed
Expand All @@ -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.

Expand All @@ -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 <svg width="15" height="15" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="mantine-1o1jehl"><path d="M11 3.99998H6.8C5.11984 3.99998 4.27976 3.99998 3.63803 4.32696C3.07354 4.61458 2.6146 5.07353 2.32698 5.63801C2 6.27975 2 7.11983 2 8.79998V17.2C2 18.8801 2 19.7202 2.32698 20.362C2.6146 20.9264 3.07354 21.3854 3.63803 21.673C4.27976 22 5.11984 22 6.8 22H15.2C16.8802 22 17.7202 22 18.362 21.673C18.9265 21.3854 19.3854 20.9264 19.673 20.362C20 19.7202 20 18.8801 20 17.2V13M7.99997 16H9.67452C10.1637 16 10.4083 16 10.6385 15.9447C10.8425 15.8957 11.0376 15.8149 11.2166 15.7053C11.4184 15.5816 11.5914 15.4086 11.9373 15.0627L21.5 5.49998C22.3284 4.67156 22.3284 3.32841 21.5 2.49998C20.6716 1.67156 19.3284 1.67155 18.5 2.49998L8.93723 12.0627C8.59133 12.4086 8.41838 12.5816 8.29469 12.7834C8.18504 12.9624 8.10423 13.1574 8.05523 13.3615C7.99997 13.5917 7.99997 13.8363 7.99997 14.3255V16Z" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg> 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.