熟悉 TiDB 运维管理工具之 TiUP（一）

作者： 数据源的 TiDB 学习之路原文来源：https://tidb.net/blog/a2968d05

刚接触 TiDB 一个月，当前的感受主要有两点：其一是 TiDB 的文档真的很丰富，光官方文档合起来就有 4000 多页，如果能把官方文档所有知识点都掌握，那绝对算得上是一个全面的 TiDB 专家了；其二是 TiDB 的工具很全面，官方文档有专门关于 TiDB 工具的一个章节，工具包括部署运维工具 TiUP 及 TiDB Operator（Kubernetes 部署）、数据迁入 Data Migration（将 MySQL/MariaDB 迁移到 TiDB）、全量导出 Dumpling、全量导入 Lightning、备份恢复 Backup&Restore、增量同步 TiCDC 及 TiDB Binlog、数据校验 sync-diff-inspector 等。

TiDB 的工具确实多，不同的工具也有很多不同的命令、参数还有相应的配置文件。对于一个初学者而言，想要在短时间内完全熟悉这些命令怕是有相当大点难度的。拿笔者个人的学习体会而言，虽然用了一周时间考过了 PCTP，但课程中相关工具的原理、命令啥的已经变得模糊不清，所以有必要通过记录的方式来回顾这些知识点。今天我们先通过这篇文章来总结一下 TiDB 强大的运维管理命令行工具 TiUP。

一． TiUP 是什么？

简单来说，TiUP 是一个 TiDB 包管理器，管理众多组件如 TiDB、PD、TiKV 等。当想要运行任何组件时，只需要执行一条 TiUP 命令即可。

二． TiUP 如何安装？

安装 TiUP 非常简单，如果机器可以访问外网，直接使用以下命令安装即可（如果是离线环境，需要下载 TiDB-community-toolkit 包）。

该命令将 TiUP 默认安装在 $HOME/.tiup 文件夹下，之后安装的组件及组件运行产生的数据也会在该文件夹下。同时，它还会自动将 $HOME/.tiup/bin 加入到.bash_profile 中，如上面截图所示。之后，我们 source .bash_profile 后便可以使用 tiup 命令了。

TiUP 本身也是有版本的，可以使用 tiup –version 来查看 TiUP 的版本号。

三． TiUP 如何使用？

想了解 TiUP 如何使用，首先可以通过查看 TiUP 命令行介绍，通过执行 tiup –help 或直接执行 tiup 看到帮助信息。

可以简单把 TiUP 命令分为两部分来看，即支持哪些命令和支持哪些组件。命令和组件的区别是命令是 tiup 自带的，而组件需要通过 tiup 进行安装。

从支持的命令来说，TiUP 支持以下命令：

1. install- 用于安装组件

2. list- 用于查看有哪些组件

3. uninstall- 用于卸载组件

4. update- 用于更新组件

5. status- 查看组件运行状态

6. clean- 清除组件运行记录

7. mirror- 克隆一个私有镜像

8. telemetry-telemetry 相关的内容

9. env- 查看 tiup 相关系统变量

10. history- 查看 tiup 执行历史命令

11. link- 将组件二进制文件链接到 $TIUP_HOME/bin/

12. unlink- 与 link 相反

13. help- 帮助

14. completion- 生成 autocompletion 脚本

举个例子，我们可以使用 tiup list 来查看有哪些组件，进而用 tiup list <component-name> 来查看具体某个组件的所有版本。

从可用的组件来说，tiup list 显示的组件就是当前支持的组件，包括：

1. PCC- 用于捕获不同 TiDB 版本变更的组件。

2. bench- 用于对数据库进行压力测试的组件。

3. br- 备份恢复组件。

4. cdc-cdc 组件。

5. chaosd- 混沌工程工具。

6. client- 连接 playground 的客户端。

7. cloud- 管理 TiDB Cloud 的 CLI 工具。

8. cluster- 部署用于生产的集群。

9. ctl- 控制器套件。

10. dm-Data Migration 数据迁移平台。

11. dmctl-DM 数据迁移的 dmctl 组件。

12. errdoc-TiDB 错误文档。

13. pd-recover-PD 的灾难恢复工具。

14. playground- 可安装一个本地试玩的单机 TiDB。

15. tidb-TiDB Server 组件。

16. tidb-dashboard-TiDB dashboard 组件。

17. tidb-lightning-Lightning 导入组件。

18. tikv-br-TiKV 集群 br 组件。

19. tikv-cdc-TiKV 的 cdc 组件。

20. tiproxy- 基于 TiDB 的 proxy 组件。

21. tiup-tiup 包管理器。

四． 关于 TiUP 组件？

组件是可运行的程序或脚本，通过 tiup <component>[:version]运行。如果未指定[:version]，表示默认用本地的最新版本，如果本地没有对应版本则自动从镜像服务器下载对应的版本。

五． 关于 TiUP 镜像？

TiUP 所有组件都从镜像下载，镜像仓库包含各个组件的 tar 包及元信息，TiDB 默认使用 PingCAP 官方镜像库，用户也可以自定义镜像仓库。镜像仓库可以是在线 HTTP 服务器，也可以是本地文件目录。

六． TiUP 组件管理的常用命令？

以下列出常用的 TiUP 组件管理命令：

（1）查询组件列表

tiup list：查看当前有哪些组件可以安装

tiup list <component>：查看某个组件有哪些版本可以安装

注：–installed 选项表示列出已安装组件；–all 选项显示隐藏组件

（2）安装组件

tiup install <component>：安装指定组件的最新稳定版

tiup install <component>:[version]：安装指定版本的指定组件

（3）升级组件

tiup update –all：升级所有组件

tiup update –self：升级 tiup 自己到最新版本

tiup update –nightly：升级到 nightly 版本

tiup update –force：强制升级到最新版本

（4）运行组件

tiup <component>:[version]：启动相应的组件

（5）查看组件运行状态

tiup status

（6）清理组件实例

tiup clean <component>

（7）卸载组件

tiup uninstall <component>:[version]