https://docs.pingcap.com/zh/tidb/stable/maintain-tidb-using-tiup
本文介绍了使用 TiUP 运维 TiDB 集群的常见操作,包括查看集群列表、启动集群、查看集群状态、修改配置参数、关闭集群、销毁集群等。
TiUP cluster 组件可以用来管理多个 TiDB 集群,在每个 TiDB 集群部署完毕后,该集群会出现在 TiUP 的集群列表里,可以使用 list 命令来查看。
启动集群操作会按 PD -> TiKV -> Pump -> TiDB -> TiFlash -> Drainer -> TiCDC -> Prometheus -> Grafana -> Alertmanager 的顺序启动整个 TiDB 集群所有组件:
该命令支持通过 -R
和 -N
参数来只启动部分组件。
例如,下列命令只启动 PD 组件:
下列命令只启动 1.2.3.4
和 1.2.3.5
这两台机器上的 PD 组件:
集群启动之后需要检查每个组件的运行状态,以确保每个组件工作正常。TiUP 提供了 display 命令,节省了登录到每台机器上去查看进程的时间。
集群运行过程中,如果需要调整某个组件的参数,可以使用 edit-config
命令来编辑参数。具体的操作步骤如下:
以编辑模式打开该集群的配置文件:
设置参数:
首先确定配置的生效范围,有以下两种生效范围:
如果配置的生效范围为该组件全局,则配置到 server_configs
。例如:
如果配置的生效范围为某个节点,则配置到具体节点的 config
中。例如:
参数的格式参考 TiUP 配置参数模版。
配置项层次结构使用 .
表示。
关于组件的更多配置参数说明,可参考 tidb config.toml.example
、tikv config.toml.example
和 pd config.toml.example
。
执行 reload
命令滚动分发配置、重启相应组件:
如果要调整 tidb-server 中事务大小限制参数 txn-total-size-limit
为 1G
,该参数位于 performance 模块下,调整后的配置如下:
然后执行 tiup cluster reload ${cluster-name} -R tidb
命令滚动重启。
常规的升级集群请参考升级文档,但是在某些场景下(例如 Debug),可能需要用一个临时的包替换正在运行的组件,此时可以用 patch
命令:
例如,有一个 TiDB 实例的 hotfix 包放在 /tmp/tidb-hotfix.tar.gz
目录下。如果此时想要替换集群上的所有 TiDB 实例,则可以执行以下命令:
或者只替换其中一个 TiDB 实例:
部署并启动集群后,可以通过 tiup cluster rename
命令来对集群重命名:
关闭集群操作会按 Alertmanager -> Grafana -> Prometheus -> TiCDC -> Drainer -> TiFlash -> TiDB -> Pump -> TiKV -> PD 的顺序关闭整个 TiDB 集群所有组件(同时也会关闭监控组件):
和 start
命令类似,stop
命令也支持通过 -R
和 -N
参数来只停止部分组件。
例如,下列命令只停止 TiDB 组件:
下列命令只停止 1.2.3.4
和 1.2.3.5
这两台机器上的 TiDB 组件:
此操作会关闭所有服务,并清空其数据目录或/和日志目录,并且无法恢复,需要谨慎操作。
清空集群所有服务的数据,但保留日志:
清空集群所有服务的日志,但保留数据:
清空集群所有服务的数据和日志:
清空 Prometheus 以外的所有服务的日志和数据:
清空节点 172.16.13.11:9000
以外的所有服务的日志和数据:
清空部署在 172.16.13.12
以外的所有服务的日志和数据:
销毁集群操作会关闭服务,清空数据目录和部署目录,并且无法恢复,需要谨慎操作。