维护 TiDB 集群所在的 Kubernetes 节点

本文档将详细介绍如何对 Kubernetes 节点进行临时或长期的维护操作。

环境准备：

kubectl

注意

维护节点前，需要保证 Kubernetes 集群的剩余资源足够运行 TiDB 集群。

使用命令标记待维护节点为不可调度，防止新的 Pod 调度到待维护节点上：
检查待维护节点上是否有 TiKV Pod：
```
kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep tikv
```
假如存在 TiKV Pod，针对每一个 Pod，进行以下操作：
1. 参考迁移 TiKV Region Leader 将 Region Leader 迁移到其他 Pod。
2. 通过调整 PD 的 max-store-down-time 配置来增大集群所允许的 TiKV Pod 下线时间，在此时间内维护完毕并恢复 Kubernetes 节点后，所有该节点上的 TiKV Pod 会自动恢复。
  
  以调整 max-store-down-time 为 60m 为例，请使用以下命令。你可以调整 max-store-down-time 到合理的值。
```
pd-ctl config set max-store-down-time 60m
```
检查待维护节点上是否有 PD Pod：
```
kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep pd
```
假如存在 PD Pod，针对每一个 Pod，参考将 Leader 迁移到其他 Pod。

确认待维护节点上不再有 TiKV 和 PD Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name}

使用 kubectl drain 命令将待维护节点上的 Pod 迁移到其它节点上：
```
kubectl drain ${node_name} --ignore-daemonsets
```
运行后，该节点上的 Pod 会自动迁移到其它可用节点上。

再次确认节点不再有任何 TiKV、TiDB 和 PD Pod 运行：

kubectl get pod --all-namespaces -o wide | grep ${node_name}

如果节点维护结束，在恢复节点后确认其健康状态：
```
watch kubectl get node ${node_name}
```
观察到节点进入 Ready 状态后，继续操作。
使用 kubectl uncordon 命令解除节点的调度限制：
```
kubectl uncordon ${node_name}
```
观察 Pod 是否全部恢复正常运行：
```
kubectl get pod --all-namespaces -o wide | grep ${node_name}
```
Pod 恢复正常运行后，操作结束。

维护短期内不可恢复的节点

检查待维护节点上是否有 TiKV Pod：
```
kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep tikv
```
假如存在 TiKV Pod，针对每一个 Pod，参考将 Pod 重调度到其他节点。
检查待维护节点上是否有 PD Pod：
```
kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep pd
```
假如存在 PD Pod，针对每一个 Pod，参考重调度 PD Pod 将 Pod 重调度到其他节点。

确认待维护节点上不再有 TiKV 和 PD Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name}

再次确认节点不再有任何 TiKV、TiDB 和 PD Pod 运行：

kubectl get pod --all-namespaces -o wide | grep ${node_name}

最后（可选），假如是长期下线节点，建议将节点从 Kubernetes 集群中删除：
```
kubectl delete node ${node_name}
```

针对节点长期下线等情形，为了尽可能减少业务受到的影响，可以将该节点上的 PD Pod 预先调度到其他节点。

如果节点存储可以自动迁移（比如使用 EBS），你不需要删除 PD Member，只需要迁移 Leader 到其他 Pod 后删除原来的 Pod 就可以实现重调度。

使用 kubectl cordon 命令标记待维护节点为不可调度，防止新的 Pod 调度到待维护节点上：

查看待维护节点上的 PD Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep pd

参考将 Leader 迁移到其他 Pod。

删除 PD Pod：

kubectl delete -n ${namespace} pod ${pod_name}

确认该 PD Pod 正常调度到其它节点上：

如果节点存储不可以自动迁移（比如使用本地存储），你需要删除 PD Member 以实现重调度。

使用 kubectl cordon 命令标记待维护节点为不可调度，防止新的 Pod 调度到待维护节点上：
```
kubectl cordon ${node_name}
```

查看待维护节点上的 PD Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep pd

参考迁移 PD Leader 将 Leader 迁移到其他 Pod。
下线 PD Pod。
```
pd-ctl member delete name ${pod_name}
```
确认 PD Member 已删除：
```
pd-ctl member
```

解除 PD Pod 与节点本地盘的绑定。

查询 Pod 使用的 PersistentVolumeClaim：

kubectl -n ${namespace} get pvc -l tidb.pingcap.com/pod-name=${pod_name}

删除该 PersistentVolumeClaim：

kubectl delete -n ${namespace} pvc ${pvc_name} --wait=false

删除 PD Pod：

kubectl delete -n ${namespace} pod ${pod_name}

观察该 PD Pod 是否正常调度到其它节点上：
```
watch kubectl -n ${namespace} get pod -o wide
```

重调度 TiKV Pod

针对节点长期下线等情形，为了尽可能减少业务受到的影响，可以将该节点上的 TiKV Pod 预先调度到其他节点。

如果节点存储可以自动迁移（比如使用 EBS），你不需要删除整个 TiKV Store，只需要迁移 Region Leader 到其他 Pod 后删除原来的 Pod 就可以实现重调度。

使用 kubectl cordon 命令标记待维护节点为不可调度，防止新的 Pod 调度到待维护节点上：
```
kubectl cordon ${node_name}
```

查看待维护节点上的 TiKV Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep tikv

为 TiKV Pod 添加一个 key 为 tidb.pingcap.com/evict-leader 的 annotation，触发优雅重启，TiDB Operator 会在迁移完 TiKV Region Leader 后删掉 Pod：
```
kubectl -n ${namespace} annotate pod ${pod_name} tidb.pingcap.com/evict-leader="delete-pod"
```

watch kubectl -n ${namespace} get pod -o wide

检查 Region Leader 已经开始迁回:

如果节点存储不可以自动迁移（比如使用本地存储），你需要删除整个 TiKV Store 以实现重调度。

使用 kubectl cordon 命令标记待维护节点为不可调度，防止新的 Pod 调度到待维护节点上：

查看待维护节点上的 TiKV Pod：

kubectl get pod --all-namespaces -o wide | grep ${node_name} | grep tikv

参考重建 TiKV Pod 重建一个新的 TiKV Pod。

查看 PD Leader：
```
pd-ctl member leader show
```
如果 Leader Pod 所在节点是要维护的节点，则需要将 PD Leader 先迁移到其他节点上的 Pod。
```
pd-ctl member leader transfer ${pod_name}
```
其中 ${pod_name} 是其他节点上的 PD Pod。

迁移 TiKV Region Leader

为 TiKV Pod 添加一个 key 为 tidb.pingcap.com/evict-leader 的 annotation：

kubectl -n ${namespace} annotate pod ${pod_name} tidb.pingcap.com/evict-leader="none"

执行以下命令，检查 Region Leader 是否已经全部被迁移走：

kubectl -n ${namespace} get tc ${cluster_name} -ojson | jq ".status.tikv.stores | .[] | select ( .podName == \"${pod_name}\" ) | .leaderCount"

如果输出为 0，则 Region Leader 已经全部被迁移走。

参考迁移 TiKV Region Leader 将 Leader 迁移到其他 Pod。

下线 TiKV Pod。

注意

下线 TiKV Pod 前，需要保证集群中剩余的 TiKV Pod 数不少于 PD 配置中的 TiKV 数据副本数（配置项：，默认值 3）。假如不符合该条件，需要先操作扩容 TiKV。

查看 TiKV Pod 的 store-id：

kubectl get -n ${namespace} tc ${cluster_name} -ojson | jq ".status.tikv.stores | .[] | select ( .podName == \"${pod_name}\" ) | .id"

在任意一个 PD Pod 中，使用 pd-ctl 命令下线该 TiKV Pod：

kubectl exec -n ${namespace} ${cluster_name}-pd-0 -- /pd-ctl store delete ${store_id}

等待 store 状态（state_name）转移为 Tombstone：

kubectl exec -n ${namespace} ${cluster_name}-pd-0 -- watch /pd-ctl store ${store_id}

点击查看期望输出

{
  "store": {
    "id": "${store_id}",
    // ...
    "state_name": "Tombstone"
  },
  // ...
}

解除 TiKV Pod 与当前使用的存储的绑定。

查询 Pod 使用的 PersistentVolumeClaim：

kubectl -n ${namespace} get pvc -l tidb.pingcap.com/pod-name=${pod_name}

点击查看示例输出，其中 NAME 项就是该 PVC 的名字

NAME          STATUS   VOLUME                                     CAPACITY   ACCESS MODES       STORAGECLASS   AGE
${pvc_name}   Bound    pvc-a8f16ca6-a675-448f-82c3-3cae624aa0e2   100Gi      RWO                standard       18m

删除该 PersistentVolumeClaim：

kubectl delete -n ${namespace} pvc ${pvc_name} --wait=false

删除 TiKV Pod，并等待新创建的 TiKV Pod 加入集群。

kubectl delete -n ${namespace} pod ${pod_name}

等待新创建的 TiKV Pod 状态变为 Up。

kubectl get -n ${namespace} tc ${cluster_name} -ojson | jq ".status.tikv.stores | .[] | select ( .podName == \"${pod_name}\" )"

点击查看示例输出

移除不再需要的 evict-leader-scheduler：