-
Notifications
You must be signed in to change notification settings - Fork 121
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.
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
en,zh: add pause deployment docs of tidb cluster #906
Conversation
f48f8f1
to
b9d451f
Compare
/cc @ran-huang |
/needs-cherry-pick-1.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
文档中的“部署”不太符合实际场景,建议改为“同步”,英文可以对应为“sync”。
部署一般只第一次安装运行,而 TidbCluster.Spec.Paused
设置好之后,实际行为是暂停同步 Spec
与 Status
。
3524b1a
to
50f4e1a
Compare
50f4e1a
to
dbfba8c
Compare
dbfba8c
to
5b26ba2
Compare
eb66179
to
9e31a8f
Compare
6081cec
to
b9a5de0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rest LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gfd
31aa5fc
to
9762a4d
Compare
@BinChenn, please update your pull request. |
@dragonly PTAL. Thanks |
@BinChenn, please update your pull request. |
23d84e8
to
f5b3289
Compare
zh/pause-sync-of-tidb-cluster.md
Outdated
{{< copyable "shell-regular" >}} | ||
|
||
```shell | ||
kubectl edit tc/`${cluster_name}` -n ${namespace} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kubectl edit tc/`${cluster_name}` -n ${namespace} | |
kubectl edit tc ${cluster_name} -n ${namespace} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To keep consistent with the other docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
zh/pause-sync-of-tidb-cluster.md
Outdated
... | ||
``` | ||
|
||
3. TiDB 集群同步暂停后,可以使用以下命令查看 Controller Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 Controller Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3. TiDB 集群同步暂停后,可以使用以下命令查看 Controller Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 Controller Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 | |
3. TiDB 集群同步暂停后,可以使用以下命令查看 tidb-controller-manager Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 tidb-controller-manager Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
zh/pause-sync-of-tidb-cluster.md
Outdated
{{< copyable "shell-regular" >}} | ||
|
||
```shell | ||
kubectl edit tc/${cluster_name} -n ${namespace} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kubectl edit tc/${cluster_name} -n ${namespace} | |
kubectl edit tc ${cluster_name} -n ${namespace} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
zh/pause-sync-of-tidb-cluster.md
Outdated
... | ||
``` | ||
|
||
3. 恢复 TiDB 集群同步后,可以使用以下命令查看 Controller Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 Controller Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3. 恢复 TiDB 集群同步后,可以使用以下命令查看 Controller Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 Controller Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 | |
3. 恢复 TiDB 集群同步后,可以使用以下命令查看 tidb-controller-manager Pod 日志确认 TiDB 集群同步状态。其中 `${pod_name}` 表示 tidb-controller-manager Pod 的名称,`${namespace}` 表示 TiDB Operator 所在的 namespace。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
…ator into improveImportDoc
en/pause-sync-of-tidb-cluster.md
Outdated
kubectl logs ${pod_name} -n ${namespace} | grep "Finished syncing TidbCluster" | ||
``` | ||
|
||
The expected output is as follows. The `finished syncing` timestamp is later than the `pausing` timestamp, which indicates that sync of the TiDB cluster has been resumed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The expected output is as follows. The `finished syncing` timestamp is later than the `pausing` timestamp, which indicates that sync of the TiDB cluster has been resumed. | |
The expected output is as follows. The `finished syncing` timestamp is later than the `paused` timestamp, which indicates that sync of the TiDB cluster has been resumed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
# Pause Sync of a TiDB Cluster in Kubernetes | ||
|
||
This document introduce how to pause sync of a TiDB cluster in Kubernetes with configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document introduce how to pause sync of a TiDB cluster in Kubernetes with configuration. | |
This document introduces how to pause sync of a TiDB cluster in Kubernetes using configuration. |
with
has multiple meanings. Let's use a more accurate way of expression.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
- Avoiding unexpected rolling update | ||
|
||
In order to prevent the compatibility of the new version TiDB Operator from affecting the TiDB clusters, you can pause sync of TiDB clusters before updating the TiDB Operator. After updating TiDB Operator, resume sync of TiDB clusters one by one or resume sync of TiDB clusters at a specified time, so as to observe the impact of TiDB Operator rolling update on the cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In order to prevent the compatibility of the new version TiDB Operator from affecting the TiDB clusters, you can pause sync of TiDB clusters before updating the TiDB Operator. After updating TiDB Operator, resume sync of TiDB clusters one by one or resume sync of TiDB clusters at a specified time, so as to observe the impact of TiDB Operator rolling update on the cluster. | |
To prevent new versions of TiDB Operator from introducing compatibility issues into the clusters, before updating TiDB Operator, you can pause sync of TiDB clusters. After updating TiDB Operator, you can resume syncing clusters one by one, or specify a time for resume. In this way, you can observe how the rolling update of TiDB Operator would affect the cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
- Avoid multiple rolling restarts | ||
|
||
In some cases, the configuration of a TiDB cluster may be modified several times over a period of time, but you do not want to restart the TiDB cluster many times. In order to avoid multiple rolling restarts, you can pause sync of a TiDB cluster first. During this period, any modification to configuration of the TiDB cluster will not take effect. After the cluster configuration modification is completed, resuming sync of TiDB Cluster. At this time, multiple configuration changes during the sync pausing can be applied in one time rolling restart. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In some cases, the configuration of a TiDB cluster may be modified several times over a period of time, but you do not want to restart the TiDB cluster many times. In order to avoid multiple rolling restarts, you can pause sync of a TiDB cluster first. During this period, any modification to configuration of the TiDB cluster will not take effect. After the cluster configuration modification is completed, resuming sync of TiDB Cluster. At this time, multiple configuration changes during the sync pausing can be applied in one time rolling restart. | |
In some cases, you might need to continuously modify the cluster over a period of time, but do not want to restart the TiDB cluster many times. To avoid multiple rolling restarts, you can pause sync of the cluster. During the sync pausing, any change of the configuration does not take effect on the cluster. After you finish the modification, resume sync of the TiDB cluster. All changes can be applied in a single rolling restart. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
- Maintenance window | ||
|
||
In some situations, you can update or restart TiDB cluster only during a maintenance window. When outside the maintenance window, you can pause sync of the TiDB cluster, so that any modification to spec does not take effect. When inside the maintenance window, you can resume sync of the TiDB cluster to allow TiDB cluster rolling update or restart. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In some situations, you can update or restart TiDB cluster only during a maintenance window. When outside the maintenance window, you can pause sync of the TiDB cluster, so that any modification to spec does not take effect. When inside the maintenance window, you can resume sync of the TiDB cluster to allow TiDB cluster rolling update or restart. | |
In some situations, you can update or restart the TiDB cluster only during a maintenance window. When outside the maintenance window, you can pause sync of the TiDB cluster, so that any modification to the specs does not take effect. When inside the maintenance window, you can resume sync of the TiDB cluster to allow TiDB cluster to rolling update or restart. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
... | ||
``` | ||
|
||
3. Execute the following command to confirm the sync status of a TiDB cluster. `${pod_name}` is the name of tidb-controller-manager Pod, and `${namespace}` is the namespace of TiDB Operator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3. Execute the following command to confirm the sync status of a TiDB cluster. `${pod_name}` is the name of tidb-controller-manager Pod, and `${namespace}` is the namespace of TiDB Operator. | |
3. To confirm the sync status of a TiDB cluster, execute the following command. `${pod_name}` is the name of tidb-controller-manager Pod, and `${namespace}` is the namespace of TiDB Operator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
## Resume sync | ||
|
||
If you want to resume the sync of the TiDB cluster, configure the TidbCluster CR with `spec.paused: false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want to resume the sync of the TiDB cluster, configure the TidbCluster CR with `spec.paused: false`. | |
To resume the sync of the TiDB cluster, configure `spec.paused: false` in the TidbCluster CR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
|
||
If you want to resume the sync of the TiDB cluster, configure the TidbCluster CR with `spec.paused: false`. | ||
|
||
1. Execute the following command to edit configuration of TiDB cluster. `${cluster_name}` represents the name of TiDB cluster, and `${namespace}` refers to the TiDB cluster namespace. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Execute the following command to edit configuration of TiDB cluster. `${cluster_name}` represents the name of TiDB cluster, and `${namespace}` refers to the TiDB cluster namespace. | |
1. Execute the following command to edit the TiDB cluster configuration. `${cluster_name}` represents the name of the TiDB cluster, and `${namespace}` refers to the TiDB cluster namespace. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
kubectl edit tc ${cluster_name} -n ${namespace} | ||
``` | ||
|
||
2. Configure the TidbCluster CR with `spec.paused: false` as following, save changes and exit editor, sync of TiDB cluster's components (PD, TiKV, TiDB, TiFlash, TiCDC,Pump) will be resumed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Configure the TidbCluster CR with `spec.paused: false` as following, save changes and exit editor, sync of TiDB cluster's components (PD, TiKV, TiDB, TiFlash, TiCDC,Pump) will be resumed. | |
2. Configure `spec.paused: false` as follows, and save changes. The sync of TiDB cluster components (PD, TiKV, TiDB, TiFlash, TiCDC, Pump) is then resumed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
en/pause-sync-of-tidb-cluster.md
Outdated
... | ||
``` | ||
|
||
3. After resuming sync of the TiDB cluster, execute the following command to confirm sync status of the TiDB cluster. `${pod_name}` represents the name of tidb-controller-manager Pod, `${namespace}` represents the namespace of TiDB Operator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3. After resuming sync of the TiDB cluster, execute the following command to confirm sync status of the TiDB cluster. `${pod_name}` represents the name of tidb-controller-manager Pod, `${namespace}` represents the namespace of TiDB Operator. | |
3. To confirm the sync status of a TiDB cluster, execute the following command. `${pod_name}` represents the name of the tidb-controller-manager Pod, and `${namespace}` represents the namespace of TiDB Operator. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
@BinChenn, please update your pull request. |
1 similar comment
@BinChenn, please update your pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with the Chinese doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
/merge |
/run-all-tests |
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
cherry pick to release-1.1 in PR #958 |
Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: BinChen <binchinsmail@gmail.com>
First-time contributors' checklist
What is changed, added, or deleted? (Required)
Fix #79
Add docs of pause-deployment-of-tidbcluster in en and zh.
Change TOC.md, insert
Pause Deloyment of TiDB Cluster
in catalogOperator
/运维
Which TiDB Operator version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
This PR is translated from:
#2013
Other reference link(s):
Do your changes match any of the following descriptions?
NONE