部署 TiDB Binlog

本文档介绍如何在 Kubernetes 上部署 TiDB 集群的 TiDB Binlog。

部署准备

部署 TiDB 集群的 TiDB Binlog

默认情况下，TiDB Binlog 在 TiDB 集群中处于禁用状态。若要创建一个启用 TiDB Binlog 的 TiDB 集群，或在现有 TiDB 集群中启用 TiDB Binlog，可根据以下步骤进行操作。

部署 Pump

可以修改 TidbCluster CR，添加 Pump 相关配置，示例如下：

  1. spec
  2.   ...
  3.   pump:
  4.     baseImage: pingcap/tidb-binlog
  5.     version: v5.4.0
  6.     replicas: 1
  7.     storageClassName: local-storage
  8.     requests:
  9.       storage: 30Gi
  10.     schedulerName: default-scheduler
  11.     config:
  12.       addr: 0.0.0.0:8250
  13.       gc: 7
  14.       heartbeat-interval: 2

自 v1.1.6 版本起支持透传 TOML 配置给组件:

  1. spec
  2.   ...
  3.   pump:
  4.     baseImage: pingcap/tidb-binlog
  5.     version: v5.4.0
  6.     replicas: 1
  7.     storageClassName: local-storage
  8.     requests:
  9.       storage: 30Gi
  10.     schedulerName: default-scheduler
  11.     config: |
  12.       addr = "0.0.0.0:8250"
  13.       gc = 7
  14.       heartbeat-interval = 2

按照集群实际情况修改 version、replicas、storageClassName、requests.storage 等配置。

值得注意的是，如果需要部署企业版的 Pump，需要将 上述 yaml 中 spec.pump.baseImage 配置为企业版镜像，格式为 pingcap/tidb-binlog-enterprise。

例如:

  1. spec:
  2.  pump:
  3.    baseImage: pingcap/tidb-binlog-enterprise

如果在生产环境中开启 TiDB Binlog，建议为 TiDB 与 Pump 组件设置亲和性和反亲和性。如果在内网测试环境中尝试使用开启 TiDB Binlog，可以跳过此步。

默认情况下，TiDB 和 Pump 的 affinity 亲和性设置为 {}。由于目前 Pump 组件与 TiDB 组件默认并非一一对应，当启用 TiDB Binlog 时，如果 Pump 与 TiDB 组件分开部署并出现网络隔离，而且 TiDB 组件还开启了 ignore-error，则会导致 TiDB 丢失 Binlog。推荐通过亲和性特性将 TiDB 组件与 Pump 部署在同一台 Node 上，同时通过反亲和性特性将 Pump 分散在不同的 Node 上，每台 Node 上至多仅需一个 Pump 实例。

  • 将 spec.tidb.affinity 按照如下设置：

    1. spec:
    2.   tidb:
    3.     affinity:
    4.       podAffinity:
    5.         preferredDuringSchedulingIgnoredDuringExecution:
    6.         - weight: 100
    7.           podAffinityTerm:
    8.             labelSelector:
    9.               matchExpressions:
    10.               - key: "app.kubernetes.io/component"
    11.                 operator: In
    12.                 values:
    13.                 - "pump"
    14.               - key: "app.kubernetes.io/managed-by"
    15.                 operator: In
    16.                 values:
    17.                 - "tidb-operator"
    18.               - key: "app.kubernetes.io/name"
    19.                 operator: In
    20.                 values:
    21.                 - "tidb-cluster"
    22.               - key: "app.kubernetes.io/instance"
    23.                 operator: In
    24.                 values:
    25.                 - ${cluster_name}
    26.             topologyKey: kubernetes.io/hostname

  • 将 spec.pump.affinity 按照如下设置：

    1. spec:
    2.   pump:
    3.     affinity:
    4.       podAffinity:
    5.         preferredDuringSchedulingIgnoredDuringExecution:
    6.         - weight: 100
    7.           podAffinityTerm:
    8.             labelSelector:
    9.               matchExpressions:
    10.               - key: "app.kubernetes.io/component"
    11.                 operator: In
    12.                 values:
    13.                 - "tidb"
    14.               - key: "app.kubernetes.io/managed-by"
    15.                 operator: In
    16.                 values:
    17.                 - "tidb-operator"
    18.               - key: "app.kubernetes.io/name"
    19.                 operator: In
    20.                 values:
    21.                 - "tidb-cluster"
    22.               - key: "app.kubernetes.io/instance"
    23.                 operator: In
    24.                 values:
    25.                 - ${cluster_name}
    26.             topologyKey: kubernetes.io/hostname
    27.       podAntiAffinity:
    28.         preferredDuringSchedulingIgnoredDuringExecution:
    29.         - weight: 100
    30.           podAffinityTerm:
    31.             labelSelector:
    32.               matchExpressions:
    33.               - key: "app.kubernetes.io/component"
    34.                 operator: In
    35.                 values:
    36.                 - "pump"
    37.               - key: "app.kubernetes.io/managed-by"
    38.                 operator: In
    39.                 values:
    40.                 - "tidb-operator"
    41.               - key: "app.kubernetes.io/name"
    42.                 operator: In
    43.                 values:
    44.                 - "tidb-cluster"
    45.               - key: "app.kubernetes.io/instance"
    46.                 operator: In
    47.                 values:
    48.                 - ${cluster_name}
    49.             topologyKey: kubernetes.io/hostname

部署 Binlog 收集工具 - 图1注意

如果更新了 TiDB 组件的亲和性配置，将引起 TiDB 组件滚动更新。

部署 Drainer

可以通过 tidb-drainer Helm chart 来为 TiDB 集群部署多个 drainer，示例如下：

  1. 确保 PingCAP Helm 库是最新的：

    1. helm repo update
    1. helm search repo tidb-drainer -l

  2. 获取默认的 values.yaml 文件以方便自定义：

    1. helm inspect values pingcap/tidb-drainer --version=${chart_version} > values.yaml

  3. 修改 values.yaml 文件以指定源 TiDB 集群和 drainer 的下游数据库。示例如下：

    1. clusterName: example-tidb
    2. clusterVersion: v5.4.0
    3. baseImage: pingcap/tidb-binlog
    4. storageClassName: local-storage
    5. storage: 10Gi
    6. initialCommitTs: "-1"
    7. config: |
    8.   detect-interval = 10
    9.   [syncer]
    10.   worker-count = 16
    11.   txn-batch = 20
    12.   disable-dispatch = false
    13.   ignore-schemas = "INFORMATION_SCHEMA,PERFORMANCE_SCHEMA,mysql"
    14.   safe-mode = false
    15.   db-type = "tidb"
    16.   [syncer.to]
    17.   host = "downstream-tidb"
    18.   user = "root"
    19.   password = ""
    20.   port = 4000

    clusterName 和 clusterVersion 必须匹配所需的源 TiDB 集群。

    initialCommitTs 为 drainer 没有 checkpoint 时数据同步的起始 commit timestamp。该参数值必须以 string 类型配置，如 "424364429251444742"。

    有关完整的配置详细信息，请参阅 Kubernetes 上的 TiDB Binlog Drainer 配置。

    值得注意的是，如果需要部署企业版的 Drainer，需要将 上述 yaml 中 baseImage 配置为企业版镜像，格式为 pingcap/tidb-binlog-enterprise。

    例如:

    1. ...
    2. clusterVersion: v5.4.0
    3. baseImage: pingcap/tidb-binlog-enterprise
    4. ...

  4. 部署 Drainer：

    1. helm install ${release_name} pingcap/tidb-drainer --namespace=${namespace} --version=${chart_version} -f values.yaml

    如果服务器没有外网，请参考 部署 TiDB 集群 在有外网的机器上将用到的 Docker 镜像下载下来并上传到服务器上。

    部署 Binlog 收集工具 - 图2注意

    该 chart 必须与源 TiDB 集群安装在相同的命名空间中。

开启 TLS

为 TiDB 组件间开启 TLS

如果要为 TiDB 集群及 TiDB Binlog 开启 TLS，请参考为 TiDB 组件间开启 TLS 进行配置。

创建 secret 并启动包含 Pump 的 TiDB 集群后，修改 values.yaml 将 tlsCluster.enabled 设置为 true，并配置相应的 certAllowedCN：

  1. ...
  2. tlsCluster:
  3.   enabled: true
  4.   # certAllowedCN:
  5.   #  - TiDB
  6. ...

为 Drainer 和下游数据库间开启 TLS

如果 tidb-drainer 的写入下游设置为 mysql/tidb，并且希望为 drainer 和下游数据库间开启 TLS，可以参考下面步骤进行配置。

首先我们需要创建一个包含下游数据库 TLS 信息的 secret，创建方式如下：

  1. kubectl create secret generic ${downstream_database_secret_name} --namespace=${namespace} --from-file=tls.crt=client.pem --from-file=tls.key=client-key.pem --from-file=ca.crt=ca.pem

默认情况下，tidb-drainer 会将 checkpoint 保存到下游数据库中，所以仅需配置 tlsSyncer.tlsClientSecretName 并配置相应的 certAllowedCN 即可。

  1. tlsSyncer:
  2.   tlsClientSecretName: ${downstream_database_secret_name}
  3.   # certAllowedCN:
  4.   #  - TiDB

如果需要将 tidb-drainer 的 checkpoint 保存到其他开启 TLS 的数据库，需要创建一个包含 checkpoint 数据库的 TLS 信息的 secret，创建方式为：

  1. kubectl create secret generic ${checkpoint_tidb_client_secret} --namespace=${namespace} --from-file=tls.crt=client.pem --from-file=tls.key=client-key.pem --from-file=ca.crt=ca.pem

修改 values.yaml 将 tlsSyncer.checkpoint.tlsClientSecretName 设置为 ${checkpoint_tidb_client_secret}，并配置相应的 certAllowedCN：

  1. ...
  2. tlsSyncer: {}
  3.   tlsClientSecretName: ${downstream_database_secret_name}
  4.   # certAllowedCN:
  5.   #  - TiDB
  6.   checkpoint:
  7.     tlsClientSecretName: ${checkpoint_tidb_client_secret}
  8.     # certAllowedCN:
  9.     #  - TiDB
  10. ...

缩容/移除 Pump/Drainer 节点

如需详细了解如何维护 TiDB Binlog 集群节点状态信息，可以参考 Pump/Drainer 的启动、退出流程。

如果需要完整移除 TiDB Binlog 组件，最好是先移除 Pump 节点，再移除 Drainer 节点。

如果需要移除的 TiDB Binlog 组件开启了 TLS，则需要先将下述文件写入 binlog.yaml，并使用 kubectl apply -f binlog.yaml 启动一个挂载了 TLS 文件和 binlogctl 工具的 Pod。

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: binlogctl
  5. spec:
  6.   containers:
  7.   - name: binlogctl
  8.     image: pingcap/tidb-binlog:${tidb_version}
  9.     command: ['/bin/sh']
  10.     stdin: true
  11.     stdinOnce: true
  12.     tty: true
  13.     volumeMounts:
  14.       - name: binlog-tls
  15.         mountPath: /etc/binlog-tls
  16.   volumes:
  17.     - name: binlog-tls
  18.       secret:
  19.         secretName: ${cluster_name}-cluster-client-secret

缩容 Pump 节点

  1. 执行以下命令缩容 Pump Pod：

    1. kubectl patch tc ${cluster_name} -n ${namespace} --type merge -p '{"spec":{"pump":{"replicas": ${pump_replicas}}}}'

    其中 ${pump_replicas} 是你想缩容至的目标副本数。

    部署 Binlog 收集工具 - 图3注意

    不要缩容 Pump 到 0，否则 Pump 节点会被完全移除。

  2. 等待 Pump Pod 自动下线被删除，运行以下命令观察：

    1. watch kubectl get po ${cluster_name} -n ${namespace}

  3. (可选项) 强制下线 Pump

    如果在下线 Pump 节点时遇到下线失败的情况，即 Pump Pod 长时间未删除，可以强制标注 Pump 状态为 offline。

    没有开启 TLS 时，使用下述指令标注状态为 offline。

    1. kubectl run update-pump-${ordinal_id} --image=pingcap/tidb-binlog:${tidb_version} --namespace=${namespace} --restart=OnFailure -- /binlogctl -pd-urls=http://${cluster_name}-pd:2379 -cmd update-pump -node-id ${cluster_name}-pump-${ordinal_id}:8250 --state offline

    如果开启了 TLS，通过下述指令使用前面开启的 pod 来标注状态为 offline。

    1. kubectl exec binlogctl -n ${namespace} -- /binlogctl -pd-urls=https://${cluster_name}-pd:2379 -cmd update-pump -node-id ${cluster_name}-pump-${ordinal_id}:8250 --state offline -ssl-ca "/etc/binlog-tls/ca.crt" -ssl-cert "/etc/binlog-tls/tls.crt" -ssl-key "/etc/binlog-tls/tls.key"

完全移除 Pump 节点

部署 Binlog 收集工具 - 图4注意

执行如下步骤之前，集群内需要至少存在一个 Pump 节点。如果此时 Pump 节点已经缩容到 0，需要先至少扩容到 1，再进行下面的移除操作。如果需要扩容至 1，使用命令 kubectl patch tc ${tidb-cluster} -n ${namespace} --type merge -p '{"spec":{"pump":{"replicas": 1}}}'。

  1. 移除 Pump 节点前，必须首先需要执行 kubectl patch tc ${cluster_name} -n ${namespace} --type merge -p '{"spec":{"tidb":{"binlogEnabled": false}}}'，等待 TiDB Pod 完成重启更新后再移除 Pump 节点。如果直接移除 Pump 节点会导致 TiDB 没有可以写入的 Pump 而无法使用。
  2. 参考缩容 Pump 节点步骤缩容 Pump 到 0。
  3. kubectl patch tc ${cluster_name} -n ${namespace} --type json -p '[{"op":"remove", "path":"/spec/pump"}]' 将 spec.pump 部分配置项全部删除。
  4. kubectl delete sts ${cluster_name}-pump -n ${namespace} 删除 Pump StatefulSet 资源。
  5. 通过 kubectl get pvc -n ${namespace} -l app.kubernetes.io/component=pump 查看 Pump 集群使用过的 PVC，随后使用 kubectl delete pvc -l app.kubernetes.io/component=pump -n ${namespace} 指令删除 Pump 的所有 PVC 资源。

移除 Drainer 节点

  1. 下线 Drainer 节点：

    使用下述指令下线 Drainer 节点，${drainer_node_id} 为需要下线的 Drainer 的 node ID。如果在 Helm 的 values.yaml 中配置了 drainerName 选项，则 ${drainer_node_id} 为 ${drainer_name}-0，否则 ${drainer_node_id} 为 ${cluster_name}-${release_name}-drainer-0。

    如果 Drainer 没有开启 TLS，使用下述指令新建 pod 下线 Drainer。

    1. kubectl run offline-drainer-0 --image=pingcap/tidb-binlog:${tidb_version} --namespace=${namespace} --restart=OnFailure -- /binlogctl -pd-urls=http://${cluster_name}-pd:2379 -cmd offline-drainer -node-id ${drainer_node_id}:8249

    如果 Drainer 开启了 TLS，通过下述指令使用前面开启的 pod 来下线 Drainer。

    1. kubectl exec binlogctl -n ${namespace} -- /binlogctl -pd-urls "https://${cluster_name}-pd:2379" -cmd offline-drainer -node-id ${drainer_node_id}:8249 -ssl-ca "/etc/binlog-tls/ca.crt" -ssl-cert "/etc/binlog-tls/tls.crt" -ssl-key "/etc/binlog-tls/tls.key"

    然后查看 Drainer 的日志输出，输出 drainer offline, please delete my pod 后即可确认该节点已经成功下线。

    1. kubectl logs -f -n ${namespace} ${drainer_node_id}

  2. 删除对应的 Drainer Pod：

    运行 helm uninstall ${release_name} -n ${namespace} 指令即可删除 Drainer Pod。

    如果不再使用 Drainer，使用 kubectl delete pvc data-${drainer_node_id} -n ${namespace} 指令删除该 Drainer 的 PVC 资源。

  3. (可选项) 强制下线 Drainer

    如果在下线 Drainer 节点时遇到下线失败的情况，即执行下线操作后仍未看到 Drainer pod 输出可以删除 pod 的日志，可以先进行步骤 2 删除 Drainer Pod 后，再运行下述指令标注 Drainer 状态为 offline：

    没有开启 TLS 时，使用下述指令标注状态为 offline。

    1. kubectl run update-drainer-${ordinal_id} --image=pingcap/tidb-binlog:${tidb_version} --namespace=${namespace} --restart=OnFailure -- /binlogctl -pd-urls=http://${cluster_name}-pd:2379 -cmd update-drainer -node-id ${drainer_node_id}:8249 --state offline

    如果开启了 TLS，通过下述指令使用前面开启的 pod 来下线 Drainer。

    1. kubectl exec binlogctl -n ${namespace} -- /binlogctl -pd-urls=https://${cluster_name}-pd:2379 -cmd update-drainer -node-id ${drainer_node_id}:8249 --state offline -ssl-ca "/etc/binlog-tls/ca.crt" -ssl-cert "/etc/binlog-tls/tls.crt" -ssl-key "/etc/binlog-tls/tls.key"