参考文档
思维导图
TiUP 简介
TiUP 简介
是什么
解决了什么问题
命令介绍
在早期的 TiDB 生态中，没有专门的包管理工具，运维管理难度大
TiDB 4.0 的生态系统里，TiUP 作为新的工具
承担着包管理器的角色，管理着 TiDB 生态下众多的组件（例如 TiDB、PD、TiKV）
像 Prometheus 等第三方监控报表工具甚至需要额外的特殊管理
安装
Commands
Usage
tiup [flags] <command> [args...]
tiup [flags] <component> [args...]
install
list
uninstall
update
status
clean
help
Components
playground
package
cluster
mirrors
命令组成
tiup
TiUP 程序名
flags
全局通用选项，可选
command / component
运行的命令或组件
args
命令或组件的专有参数，可选
查询组件列表，知道有哪些组件可以安装，以及这些组件有哪些版本可选
安装某个组件的特定版本
升级某个组件到最新的版本
卸载组件
查看组件运行状态
清理组件实例
打印帮助信息，后面跟命令则是打印该命令的使用方法
--binary
打印某个组件的可执行程序文件路径
--binpath
指定要运行组件的可执行程序文件路径，这样可以不使用组件的安装路径
--tag
指定组件运行实例的 tag 名称，该名称可以认为是该实例的 ID，如果不指定，则会自动生成随
机的 tag 名称
语法
常用
查询组件列表
tiup list
查看当前有哪些组件可以安装
tiup list <component>
查看某个组件有哪些版本可以安装
查看当前已经安装的所有组件
tiup list --installed
从服务器获取 TiKV 所有可安装版本组件列表
tiup list tikv --refresh
安装组件
使用 TiUP 安装最新稳定版的 TiDB
tiup install tidb
使用 TiUP 安装 nightly 版本的TiDB
tiup install tidb:nightly
使用 TiUP 安装 v3.0.6 版本的 TiKV
tiup install tikv:v3.0.6
升级组件
升级所有组件至最新版本
tiup update --all
升级所有组件至 nightly 版本
tiup update --all --nightly
升级 TiUP 至最新版本
tiup update --self
运行组件
运行 v3.0.8 版本的 TiDB
tiup tidb:v3.0.8
指定 tag 运行 TiKV
tiup --tag=experiment tikv
查询组件运行状态
查看 TiDB 运行状态
tiup status experiment
Name: 实例的 tag 名称
Component: 实例的组件名称
PID: 实例运行的进程 ID
Status: 实例状态，RUNNING 表示正在运行，TERM 表示已经终止
Created Time: 实例的启动时间
Directory: 实例的工作目录，可以通过 --tag 指定
Binary: 实例的可执行程序，可以通过 --binpath
Args: 实例的运行参数
清理组件实例
清理 tag 名称为 experiment 的组件实例
tiup clean experiment
清理所有组件实例
tiup clean --all
卸载组件
卸载 v3.0.8 版本的 TiDB
tiup uninstall tidb:v3.0.8
卸载所有版本的 TiKV
tiup uninstall tikv --all
卸载所有已经安装的组件
tiup uninstall --all
部署 TiDB
curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh
测试环境
生产集群
怎么用
通过 playground 组件启动本地集群
tiup install playground
启动
tiup playground
快速启动一个playground集群
查找 playground 的最新版本
使用各组件的最新 release 版本
使用默认组件个数
tiup playground:v0.0.6
tiup playground:v0.0.6 v4.0.0
启动由 1 个 TiDB、1 个 TiKV 和 1 个 PD 构成的最小化集群
依次启动完各个组件
调用 TiUP 命令来启动 TiDB/PD/TiKV 组件，譬如调用 tiup tidb:v4.0.0 来启动 TiDB 实例，当
然，在真正执行时它还会额外指定一些参数
启动成功
在依次启动完各个组件后，playground 会告诉你启动成功，并告诉你一些有用的信息，譬如如
何通过 MySQL 客户端连接集群、如何访问 dashboard
通过 playground 搭建测试集群
tiup --tag=my-cluster playground
通过指定 tag 名称的方法来启动
启动 v3.0.9 版本的集群
tiup playground v3.0.9
启动 nightly 版本的集群
tiup playground nightly
指定 TiKV 组件的个数为 3 个，同时启动 Prometheus 监控
tiup playground --kv=3 --monitor
各组件使用本机的对外 IP 地址 x.x.x.x 提供服务
tiup playground --host x.x.x.x
安装
作为一个分布式系统，最基础的 TiDB 测试集群通常由 2 个 TiDB 组件、3 个 TiKV 组件和 3 个
PD组件来构成
快速启动由 1 个 TiDB、1 个 TiKV 和 1 个 PD 构成的最小化集群
拓展
部署基础测试集群
tiup playground --db=2 --kv=3 --pd=3
连接到测试集群
tiup playground --db=2 --kv=3 --pd=3 --monitor
带监控功能的
tiup client
自动探测到当前启动了哪些集群，并展示一个类似 DOS 图形化界面的列表，让你选择连接哪
个集群。
指定 tag 名称来连接到特定的集群
tiup client <tag>
安装 cluster 组件
tiup install cluster
部署集群
tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
tiup cluster deploy prod-cluster v3.0.12 /tmp/topology.yaml
查看集群列表
tiup cluster list
启动集群
生产集群
部署
启动
停止
重启
缩容
扩容
升级
tiup cluster start prod-cluster
查看集群状态
tiup cluster display prod-cluster
缩容
tiup cluster scale-in <cluster-name> [flags]
tiup cluster scale-in prod-cluster -N 172.16.5.140:20160
将 172.16.5.140 上的 TiKV 干掉
扩容
cluster scale-out <cluster-name> <topology.yaml> [flags]
升级
tiup cluster upgrade prod-cluster v4.0.0-rc
更新配置
tiup cluster edit-config prod-cluster
tiup cluster reload prod-cluster
tiup cluster reload prod-cluster -R tidb
edit-config
reload
其他
通过help帮助获取