| title | category | aliases | |
|---|---|---|---|
使用 TiUP 部署运维 TiDB 线上集群 |
tools |
|
本文重在介绍如何使用 TiUP 的 cluster 组件，如果需要线上部署的完整步骤，可参考使用 TiUP 部署 TiDB 集群。
与 playground 组件用于部署本地集群类似，cluster 组件用于快速部署生产集群。对比 playground，cluster 组件提供了更强大的集群管理功能，包括对集群的升级、缩容、扩容甚至操作、审计等。
cluster 组件的帮助文档如下：
tiup clusterThe component `cluster` is not installed; downloading from repository.
download https://tiup-mirrors.pingcap.com/cluster-v0.4.9-darwin-amd64.tar.gz 15.32 MiB / 15.34 MiB 99.90% 10.04 MiB p/s
Starting component `cluster`: /Users/joshua/.tiup/components/cluster/v0.4.9/cluster
Deploy a TiDB cluster for production
Usage:
tiup cluster [flags]
tiup [command]
Available Commands:
deploy 部署集群
start 启动已部署的集群
stop 停止集群
restart 重启集群
scale-in 集群缩容
scale-out 集群扩容
destroy 销毁集群
upgrade 升级集群
exec 在集群的一个或多个机器上执行命令
display 获取集群信息
list 获取集群列表
audit 查看集群操作日志
import 导入一个由 TiDB-Ansible 部署的集群
edit-config 编辑 TiDB 集群的配置
reload 用于必要时重载集群配置
patch 使用临时的组件包替换集群上已部署的组件
help 打印 Help 信息
Flags:
-h, --help 帮助信息
--ssh-timeout int SSH 连接超时时间
-y, --yes 跳过所有的确认步骤
部署集群的命令为 tiup cluster deploy，一般用法为：
tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]该命令需要提供集群的名字、集群使用的 TiDB 版本，以及一个集群的拓扑文件。
拓扑文件的编写可参考示例。以一个最简单的拓扑为例，将下列文件保存为 /tmp/topology.yaml：
---
pd_servers:
- host: 172.16.5.134
name: pd-134
- host: 172.16.5.139
name: pd-139
- host: 172.16.5.140
name: pd-140
tidb_servers:
- host: 172.16.5.134
- host: 172.16.5.139
- host: 172.16.5.140
tikv_servers:
- host: 172.16.5.134
- host: 172.16.5.139
- host: 172.16.5.140
grafana_servers:
- host: 172.16.5.134
monitoring_servers:
- host: 172.16.5.134假如我们想要使用 TiDB 的 v3.0.12 版本，集群名字为 prod-cluster，则执行以下命令：
{{< copyable "shell-regular" >}}
tiup cluster deploy -p prod-cluster v3.0.12 /tmp/topology.yaml执行过程中会再次确认拓扑结构并提示输入目标机器上的 root 密码（-p 表示使用密码）：
Please confirm your topology:
TiDB Cluster: prod-cluster
TiDB Version: v3.0.12
Type Host Ports Directories
---- ---- ----- -----------
pd 172.16.5.134 2379/2380 deploy/pd-2379,data/pd-2379
pd 172.16.5.139 2379/2380 deploy/pd-2379,data/pd-2379
pd 172.16.5.140 2379/2380 deploy/pd-2379,data/pd-2379
tikv 172.16.5.134 20160/20180 deploy/tikv-20160,data/tikv-20160
tikv 172.16.5.139 20160/20180 deploy/tikv-20160,data/tikv-20160
tikv 172.16.5.140 20160/20180 deploy/tikv-20160,data/tikv-20160
tidb 172.16.5.134 4000/10080 deploy/tidb-4000
tidb 172.16.5.139 4000/10080 deploy/tidb-4000
tidb 172.16.5.140 4000/10080 deploy/tidb-4000
prometheus 172.16.5.134 9090 deploy/prometheus-9090,data/prometheus-9090
grafana 172.16.5.134 3000 deploy/grafana-3000
Attention:
1. If the topology is not what you expected, check your yaml file.
1. Please confirm there is no port/directory conflicts in same host.
Do you want to continue? [y/N]:输入密码后 tiup-cluster 便会下载需要的组件并部署到对应的机器上，当看到以下提示时说明部署成功：
Deployed cluster `prod-cluster` successfully集群部署成功后，可以通过 tiup cluster list 命令在集群列表中查看该集群：
{{< copyable "shell-root" >}}
tiup cluster listStarting /root/.tiup/components/cluster/v0.4.5/cluster list
Name User Version Path PrivateKey
---- ---- ------- ---- ----------
prod-cluster tidb v3.0.12 /root/.tiup/storage/cluster/clusters/prod-cluster /root/.tiup/storage/cluster/clusters/prod-cluster/ssh/id_rsa
集群部署成功后，可以执行以下命令启动该集群。如果忘记了部署的集群的名字，可以使用 tiup cluster list 命令查看。
{{< copyable "shell-regular" >}}
tiup cluster start prod-cluster如果想查看集群中每个组件的运行状态，逐一登录到各个机器上查看显然很低效。因此，TiUP 提供了 tiup cluster display 命令，用法如下：
{{< copyable "shell-root" >}}
tiup cluster display prod-clusterStarting /root/.tiup/components/cluster/v0.4.5/cluster display prod-cluster
TiDB Cluster: prod-cluster
TiDB Version: v3.0.12
ID Role Host Ports Status Data Dir Deploy Dir
-- ---- ---- ----- ------ -------- ----------
172.16.5.134:3000 grafana 172.16.5.134 3000 Up - deploy/grafana-3000
172.16.5.134:2379 pd 172.16.5.134 2379/2380 Healthy|L data/pd-2379 deploy/pd-2379
172.16.5.139:2379 pd 172.16.5.139 2379/2380 Healthy data/pd-2379 deploy/pd-2379
172.16.5.140:2379 pd 172.16.5.140 2379/2380 Healthy data/pd-2379 deploy/pd-2379
172.16.5.134:9090 prometheus 172.16.5.134 9090 Up data/prometheus-9090 deploy/prometheus-9090
172.16.5.134:4000 tidb 172.16.5.134 4000/10080 Up - deploy/tidb-4000
172.16.5.139:4000 tidb 172.16.5.139 4000/10080 Up - deploy/tidb-4000
172.16.5.140:4000 tidb 172.16.5.140 4000/10080 Up - deploy/tidb-4000
172.16.5.134:20160 tikv 172.16.5.134 20160/20180 Up data/tikv-20160 deploy/tikv-20160
172.16.5.139:20160 tikv 172.16.5.139 20160/20180 Up data/tikv-20160 deploy/tikv-20160
172.16.5.140:20160 tikv 172.16.5.140 20160/20180 Up data/tikv-20160 deploy/tikv-20160
对于普通的组件，Status 列会显示 Up 或者 Down 表示该服务是否正常。对于 PD 组件，Status 会显示 Healthy 或者 Down，同时可能会带有 |L 表示该 PD 是 Leader。
注意：
本节只展示缩容命令的语法示例，线上扩缩容具体步骤可参考使用 TiUP 扩容缩容 TiDB 集群。
缩容即下线服务，最终会将指定的节点从集群中移除，并删除遗留的相关数据文件。
由于 TiKV 和 TiDB Binlog 组件的下线是异步的（需要先通过 API 执行移除操作）并且下线过程耗时较长（需要持续观察节点是否已经下线成功），所以对 TiKV 和 TiDB Binlog 组件做了特殊处理：
- 对 TiKV 及 Binlog 组件的操作
- TiUP cluster 通过 API 将其下线后直接退出而不等待下线完成
- 等之后再执行集群操作相关的命令时，会检查是否存在已经下线完成的 TiKV 或者 Binlog 节点。如果不存在，则继续执行指定的操作；如果存在，则执行如下操作：
- 停止已经下线掉的节点的服务
- 清理已经下线掉的节点的相关数据文件
- 更新集群的拓扑，移除已经下线掉的节点
- 对其他组件的操作
- 下线 PD 组件时，会通过 API 将指定节点从集群中删除掉（这个过程很快），然后停掉指定 PD 的服务并且清除该节点的相关数据文件
- 下线其他组件时，直接停止并且清除节点的相关数据文件
缩容命令的基本用法：
tiup cluster scale-in <cluster-name> -N <node-id>它需要指定至少两个参数，一个是集群名字，另一个是节点 ID。节点 ID 可以参考上一节使用 tiup cluster display 命令获取。
比如想缩容 172.16.5.140 上的 TiKV 节点，可以执行：
{{< copyable "shell-regular" >}}
tiup cluster scale-in prod-cluster -N 172.16.5.140:20160通过 tiup cluster display 可以看到该 TiKV 已经被标记为 Offline：
{{< copyable "shell-root" >}}
tiup cluster display prod-clusterStarting /root/.tiup/components/cluster/v0.4.5/cluster display prod-cluster
TiDB Cluster: prod-cluster
TiDB Version: v3.0.12
ID Role Host Ports Status Data Dir Deploy Dir
-- ---- ---- ----- ------ -------- ----------
172.16.5.134:3000 grafana 172.16.5.134 3000 Up - deploy/grafana-3000
172.16.5.134:2379 pd 172.16.5.134 2379/2380 Healthy|L data/pd-2379 deploy/pd-2379
172.16.5.139:2379 pd 172.16.5.139 2379/2380 Healthy data/pd-2379 deploy/pd-2379
172.16.5.140:2379 pd 172.16.5.140 2379/2380 Healthy data/pd-2379 deploy/pd-2379
172.16.5.134:9090 prometheus 172.16.5.134 9090 Up data/prometheus-9090 deploy/prometheus-9090
172.16.5.134:4000 tidb 172.16.5.134 4000/10080 Up - deploy/tidb-4000
172.16.5.139:4000 tidb 172.16.5.139 4000/10080 Up - deploy/tidb-4000
172.16.5.140:4000 tidb 172.16.5.140 4000/10080 Up - deploy/tidb-4000
172.16.5.134:20160 tikv 172.16.5.134 20160/20180 Up data/tikv-20160 deploy/tikv-20160
172.16.5.139:20160 tikv 172.16.5.139 20160/20180 Up data/tikv-20160 deploy/tikv-20160
172.16.5.140:20160 tikv 172.16.5.140 20160/20180 Offline data/tikv-20160 deploy/tikv-20160
待 PD 将其数据调度到其他 TiKV 后，该节点会被自动删除。
注意：
本节只用于展示扩容命令的语法示例，线上扩缩容可参考使用 TiUP 扩容缩容 TiDB 集群。
扩容的内部逻辑与部署类似，TiUP cluster 组件会先保证节点的 SSH 连接，在目标节点上创建必要的目录，然后执行部署并且启动服务。其中 PD 节点的扩容会通过 join 方式加入到集群中，并且会更新与 PD 有关联的服务的配置；其他服务直接启动加入到集群中。所有服务在扩容时都会做正确性验证，最终返回是否扩容成功。
例如，在集群 tidb-test 中扩容一个 TiKV 节点和一个 PD 节点：
-
新建 scale.yaml 文件，添加新增的 TiKV 和 PD 节点 IP：
注意：
需要新建一个拓扑文件，文件中只写入扩容节点的描述信息，不要包含已存在的节点。
--- pd_servers: - ip: 172.16.5.140 tikv_servers: - ip: 172.16.5.140
-
执行扩容操作。TiUP cluster 根据 scale.yaml 文件中声明的端口、目录等信息在集群中添加相应的节点：
{{< copyable "shell-regular" >}}
tiup cluster scale-out tidb-test scale.yaml
执行完成之后可以通过
tiup cluster display tidb-test命令检查扩容后的集群状态。
注意：
本节只用于展示命令的语法示例，线上升级请参考使用 TiUP 升级 TiDB。
滚动升级功能借助 TiDB 的分布式能力，升级过程中尽量保证对前端业务透明、无感知。升级时会先检查各个组件的配置文件是否合理，如果配置有问题，则报错退出；如果配置没有问题，则工具会逐个节点进行升级。其中对不同节点有不同的操作。
- 升级 PD 节点
- 优先升级非 Leader 节点
- 所有非 Leader 节点升级完成后再升级 Leader 节点
- 工具会向 PD 发送一条命令将 Leader 迁移到升级完成的节点上
- 当 Leader 已经切换到其他节点之后，再对旧的 Leader 节点做升级操作
- 同时升级过程中，若发现有不健康的节点，工具会中止本次升级并退出，此时需要由人工判断、修复后再执行升级。
- 升级 TiKV 节点
- 先在 PD 中添加一个迁移对应 TiKV 上 Region leader 的调度，通过迁移 Leader 确保升级过程中不影响前端业务
- 等待迁移 Leader 完成之后，再对该 TiKV 节点进行升级更新
- 等更新后的 TiKV 正常启动之后再移除迁移 Leader 的调度
- 升级其他服务
- 正常停止服务再更新
升级命令参数如下：
Usage:
tiup cluster upgrade <cluster-name> <version> [flags]
Flags:
--force 在不 transfer leader 的情况下强制升级（危险操作）
-h, --help 帮助手册
--transfer-timeout int transfer leader 的超时时间
Global Flags:
--ssh-timeout int SSH 连接的超时时间
-y, --yes 跳过所有的确认步骤例如，把集群升级到 v4.0.0-rc 的命令为：
{{< copyable "shell-regular" >}}
tiup cluster upgrade tidb-test v4.0.0-rc如果想要动态更新组件的配置，TiUP cluster 组件为每个集群保存了一份当前的配置，如果想要编辑这份配置，则执行 tiup cluster edit-config <cluster-name> 命令。例如：
{{< copyable "shell-regular" >}}
tiup cluster edit-config prod-cluster然后 TiUP cluster 组件会使用 vi 打开配置文件供编辑，编辑完之后保存即可。此时的配置并没有应用到集群，如果想要让它生效，还需要执行：
{{< copyable "shell-regular" >}}
tiup cluster reload prod-cluster该操作会将配置发送到目标机器，重启集群，使配置生效。
常规的升级集群可以使用 upgrade 命令，但是在某些场景下（例如 Debug)，可能需要用一个临时的包替换正在运行的组件，此时可以用 patch 命令：
{{< copyable "shell-root" >}}
tiup cluster patch --helpReplace the remote package with a specified package and restart the service
Usage:
tiup cluster patch <cluster-name> <package-path> [flags]
Flags:
-h, --help 帮助信息
-N, --node strings 指定被替换的节点
--overwrite 在未来的 scale-out 操作中使用当前指定的临时包
-R, --role strings 指定被替换的服务类型
--transfer-timeout int transfer leader 的超时时间
Global Flags:
--ssh-timeout int SSH 连接的超时时间
-y, --yes 跳过所有的确认步骤
例如，有一个 TiDB 的 hotfix 包放在 /tmp/tidb-hotfix.tar.gz，如果此时想要替换集群上的所有 TiDB，则可以执行：
{{< copyable "shell-regular" >}}
tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -R tidb或者只替换其中一个 TiDB：
{{< copyable "shell-regular" >}}
tiup cluster patch test-cluster /tmp/tidb-hotfix.tar.gz -N 172.16.4.5:4000在 TiUP 之前，一般使用 TiDB Ansible 部署 TiDB 集群，import 命令用于将这部分集群过渡给 TiUP 接管。 import 命令用法如下：
{{< copyable "shell-root" >}}
tiup cluster import --helpImport an exist TiDB cluster from TiDB-Ansible
Usage:
tiup cluster import [flags]
Flags:
-d, --dir string TiDB-Ansible 的目录，默认为当前目录
-h, --help import 的帮助信息
--inventory string inventory 文件的名字 (默认为 "inventory.ini")
--no-backup 不备份 Ansible 目录, 用于存在多个 inventory 文件的 Ansible 目录
-r, --rename NAME 重命名被导入的集群
Global Flags:
--ssh-timeout int SSH 连接的超时时间
-y, --yes 跳过所有的确认步骤
例如，导入一个 TiDB Ansible 集群：
{{< copyable "shell-regular" >}}
cd tidb-ansible
tiup cluster import或者
{{< copyable "shell-regular" >}}
tiup cluster import --dir=/path/to/tidb-ansible操作日志的查看可以借助 audit 命令，其用法如下：
Usage:
tiup cluster audit [audit-id] [flags]
Flags:
-h, --help help for audit在不使用 [audit-id] 参数时，该命令会显示执行的命令列表，如下：
{{< copyable "shell-regular" >}}
tiup cluster auditStarting component `cluster`: /Users/joshua/.tiup/components/cluster/v0.6.0/cluster audit
ID Time Command
-- ---- -------
4BLhr0 2020-04-29T13:25:09+08:00 /Users/joshua/.tiup/components/cluster/v0.6.0/cluster deploy test v4.0.0-rc /tmp/topology.yaml
4BKWjF 2020-04-28T23:36:57+08:00 /Users/joshua/.tiup/components/cluster/v0.6.0/cluster deploy test v4.0.0-rc /tmp/topology.yaml
4BKVwH 2020-04-28T23:02:08+08:00 /Users/joshua/.tiup/components/cluster/v0.6.0/cluster deploy test v4.0.0-rc /tmp/topology.yaml
4BKKH1 2020-04-28T16:39:04+08:00 /Users/joshua/.tiup/components/cluster/v0.4.9/cluster destroy test
4BKKDx 2020-04-28T16:36:57+08:00 /Users/joshua/.tiup/components/cluster/v0.4.9/cluster deploy test v4.0.0-rc /tmp/topology.yaml
第一列为 audit-id，如果想看某个命令的执行日志，则传入这个 audit-id：
{{< copyable "shell-regular" >}}
tiup cluster audit 4BLhr0exec 命令可以很方便地到集群的机器上执行命令，其使用方式如下：
Usage:
tiup cluster exec <cluster-name> [flags]
Flags:
--command string 需要执行的命令 (默认是 "ls")
-h, --help 帮助信息
-N, --node strings 指定要执行的节点 ID （节点 id 通过 display 命令获取）
-R, --role strings 指定要执行的 role
--sudo 是否使用 root (默认为 false)例如，如果要到所有的 TiDB 节点上执行 ls /tmp：
{{< copyable "shell-regular" >}}
tiup cluster exec test-cluster --command='ls /tmp'在 TiUP 之前，我们用 tidb-ctl、tikv-ctl、pd-ctl 等工具操控集群，为了方便下载和使用，TiUP 将它们集成到了统一的组件 ctl 中：
Usage:
tiup ctl {tidb/pd/tikv/binlog/etcd} [flags]
Flags:
-h, --help help for tiup这个命令和之前的命令对应关系为：
tidb-ctl [args] = tiup ctl tidb [args]
pd-ctl [args] = tiup ctl pd [args]
tikv-ctl [args] = tiup ctl tikv [args]
binlogctl [args] = tiup ctl bindlog [args]
etcdctl [args] = tiup ctl etcd [args]例如，以前查看 store 的命令为 pd-ctl -u http://127.0.0.1:2379 store，集成到 TiUP 中的命令为：
{{< copyable "shell-regular" >}}
tiup ctl pd -u http://127.0.0.1:2379 store