tiup-component-cluster.md

title
TiUP Cluster

TiUP Cluster

TiUP Cluster 是 TiUP 提供的使用 Golang 编写的集群管理组件，通过 TiUP Cluster 组件就可以进行日常的运维工作，包括部署、启动、关闭、销毁、弹性扩缩容、升级 TiDB 集群、管理 TiDB 集群参数。

语法

tiup cluster [command] [flags]

[command] 代表命令名字，支持的命令列表请参考下方命令清单。

选项

--ssh (string，默认 builtin)

指定 SSH 客户端连接远端（部署 TiDB 服务的机器）执行命令，支持以下值：

• builtin：使用 tiup-cluster 内置的 easyssh 客户端
• system：使用当前操作系统默认的 SSH 客户端
• none：不使用 ssh 客户端，这种方式只支持部署到当前机器

--ssh-timeout（uint，默认 5）

设置 SSH 连接超时时间，单位为秒。

--wait-timeout（uint，默认 120）

运维过程中涉及到很多操作：指定 systemctl 启动/停止服务，等待端口上线/下线等，每个操作可能会消耗数秒。--wait-timeout 用于设置每个步骤的最长等待时间（单位为秒），超时后报错退出。

-y, --yes

• 跳过所有风险操作的二次确认，除非是使用脚本调用 TiUP，否则不推荐使用。
• 数据类型：BOOLEAN
• 该选项默认关闭，默认值为 false。在命令中添加该选项，并传入 true 值或不传值，均可开启此功能。

-v, --version

• 输出 TiUP Cluster 当前版本信息。
• 数据类型：BOOLEAN
• 该选项默认关闭，默认值为 false。在命令中添加该选项，并传入 true 值或不传值，均可开启此功能。

-h, --help

• 输出相关命令的帮助信息。
• 数据类型：BOOLEAN
• 该选项默认关闭，默认值为 false。在命令中添加该选项，并传入 true 值或不传值，均可开启此功能。

命令清单

• import：导入 ansible 部署的集群
• template：输出拓扑模版
• check：部署前后的集群检查
• deploy：根据指定拓扑部署集群
• list：查询已部署的集群列表
• display：展示指定集群状态
• start：启动指定集群
• stop：停止指定集群
• restart：重启指定集群
• scale-in：缩容指定集群
• scale-out：扩容指定集群
• upgrade：升级指定集群
• prune：销毁指定集群中状态为 Tombstone 的实例
• edit-config：修改指定集群配置
• reload：重载指定集群配置
• patch：替换已部署集群的某个服务
• rename：重命名集群
• clean：删除指定集群数据
• destroy：销毁指定集群
• audit：查询集群操作审计日志
• replay：重试指定命令
• enable：开启指定集群或服务开机自启动
• disable：关闭指定集群或服务开机自启动
• meta backup：备份指定集群运维操作所需的 TiUP meta 文件
• meta restore：恢复指定集群的 TiUP meta 文件
• help：输出帮助信息

<< 返回上一页 - TiUP 组件清单