| title | aliases | summary | ||
|---|---|---|---|---|
本地快速部署 TiDB 集群 |
|
TiDB 集群是分布式系统，由多个组件构成。想要快速体验 TiDB，可以使用 TiUP 中的 playground 组件快速搭建本地测试环境。通过命令行参数可以设置各组件的数量和配置，也可以启动多个组件实例。使用 `tiup client` 可以快速连接到本地启动的 TiDB 集群。还可以查看已启动集群的信息，扩容或缩容集群。 |
TiDB 集群是由多个组件构成的分布式系统，一个典型的 TiDB 集群至少由 3 个 PD 节点、3 个 TiKV 节点和 2 个 TiDB 节点构成。对于想要快速体验 TiDB 的用户来说，手工部署这么多组件是非常耗时且麻烦的事情。本文介绍 TiUP 中的 playground 组件，以及如何通过 playground 组件快速搭建一套本地的 TiDB 测试环境。
playground 组件的基本用法：
tiup playground ${version} [flags]如果直接执行 tiup playground 命令，则 TiUP playground 会使用本地安装的 TiDB/TiKV/PD 组件或者安装这些组件的稳定版本，来启动一个由 1 个 TiKV、1 个 TiDB、1 个 PD 和 1 个 TiFlash 实例构成的集群。该命令实际做了以下事情：
- 因为该命令没有指定 playground 的版本，TiUP 会先查找已安装的 playground 的最新版本，假设已安装的 playground 最新版为 v1.12.3，则该命令相当于 tiup playground:v1.12.3
- 如果 playground 从未安装过任何版本的 TiDB/TiKV/PD 组件，TiUP 会先安装这些组件的最新稳定版，然后再启动运行这些组件的实例
- 因为该命令没有指定 TiDB/PD/TiKV 各组件的版本，默认情况下，它会使用各组件的最新发布版本，假设当前为 v8.3.0，则该命令相当于 tiup playground:1.12.3 v8.3.0
- 因为该命令也没有指定各组件的个数，默认情况下，它会启动由 1 个 TiDB、1 个 TiKV、1 个 PD 和 1 个 TiFlash 实例构成的最小化集群
- 在依次启动完各个 TiDB 组件后，playground 会提醒集群启动成功，并告诉你一些有用的信息，譬如如何通过 MySQL 客户端连接集群、如何访问 TiDB Dashboard 等
playground 的命令行参数说明：
Flags:
--db int 设置集群中 TiDB 节点的数量（默认为1）
--db.host host 指定 TiDB 的监听地址
--db.port int 指定 TiDB 的端口号
--db.binpath string 指定 TiDB 二进制文件的位置（开发调试用，可忽略）
--db.config string 指定 TiDB 的配置文件（开发调试用，可忽略）
--db.timeout int 指定 TiDB 最长等待超时时间，单位为秒。若配置为 0，则永不超时。
--drainer int 设置集群中 Drainer 数据
--drainer.binpath string 指定 Drainer 二进制文件的位置（开发调试用，可忽略）
--drainer.config string 指定 Drainer 的配置文件
-h, --help 打印帮助信息
--host string 设置每个组件的监听地址（默认为 127.0.0.1），如果要提供给别的电脑访问，可设置为 0.0.0.0
--kv int 设置集群中 TiKV 节点的数量（默认为1）
--kv.binpath string 指定 TiKV 二进制文件的位置（开发调试用，可忽略）
--kv.config string 指定 TiKV 的配置文件（开发调试用，可忽略）
--mode string 指定 playground 的运行模式，取值选项为 'tidb'（默认）和 'tikv-slim'
--pd int 设置集群中 PD 节点的数量（默认为1）
--pd.host host 指定 PD 的监听地址
--pd.binpath string 指定 PD 二进制文件的位置（开发调试用，可忽略）
--pd.config string 指定 PD 的配置文件（开发调试用，可忽略）
--pd.mode string 指定 PD 的工作模式，取值选项为 'ms'。指定该参数代表启用 PD 微服务模式。
--pump int 设置集群中 Pump 节点的数量（非 0 的时候 TiDB 会开启 TiDB Binlog）
--pump.binpath string 指定 Pump 二进制文件的位置（开发调试用，可忽略）
--pump.config string 指定 Pump 的配置文件（开发调试用，可忽略）
--scheduling int 设置集群中 Scheduling 节点的数量（默认为 1），只能在 pd.mode 为 'ms' 的时候设置
--scheduling.host host 指定 Scheduling 节点的监听地址
--scheduling.binpath string 指定 Scheduling 节点上二进制文件的位置（开发调试用，可忽略）
--scheduling.config string 指定 Scheduling 节点的配置文件（开发调试用，可忽略）
-T, --tag string 设置 playground 的 tag 信息
--ticdc int 设置集群中 TiCDC 节点的数量（默认为 0）
--ticdc.binpath string 指定 TiCDC 二进制文件的位置（开发调试用，可忽略）
--ticdc.config string 指定 TiCDC 的配置文件（开发调试用，可忽略）
--tiflash int 设置集群中 TiFlash 节点的数量（默认为 1）
--tiflash.binpath string 指定 TiFlash 的二进制文件位置（开发调试用，可忽略）
--tiflash.config string 指定 TiFlash 的配置文件（开发调试用，可忽略）
--tiflash.timeout int 指定 TiFlash 最长等待超时时间，单位为秒，若配置为 0，则永不超时。
--tiproxy int 设置集群中 TiProxy 节点的数量
--tiproxy.binpath string 指定 TiProxy 的二进制文件位置
--tiproxy.config string 指定 TiProxy 的配置文件
--tiproxy.host host Playground 的 TiProxy host。如果没有提供，TiProxy 会使用 host 参数作为它的 host
--tiproxy.port int Playground 的 TiProxy 端口。如果没有提供，TiProxy 会使用 6000 作为它的端口
--tiproxy.timeout int TiProxy 最长等待超时时间，单位为秒，若配置为 0，则永不超时（默认为 60）。
--tso int 设置集群中 TSO 节点的数量（默认为 1），只能在 pd.mode 为 'ms' 的时候设置
--tso.host host 指定 TSO 节点的监听地址
--tso.binpath string 指定 TSO 节点上二进制文件的位置（开发调试用，可忽略）
--tso.config string 指定 TSO 节点的配置文件（开发调试用，可忽略）
-v, --version 显示 playground 的版本号
--without-monitor 设置不使用 Prometheus 和 Grafana 的监控功能。若不添加此参数，则默认开启监控功能。
{{< copyable "shell-regular" >}}
tiup list tidb{{< copyable "shell-regular" >}}
tiup playground ${version}将 ${version} 替换为所需的版本号。
{{< copyable "shell-regular" >}}
tiup playground nightlynightly 就是这个集群的版本号，这里指定为每日构建版本。
首先，你需要复制 PD 的配置模版。假设你将复制的配置文件放置在 ~/config/pd.toml，按需修改一些内容后，执行以下命令可以覆盖 PD 的默认配置：
{{< copyable "shell-regular" >}}
tiup playground --pd.config ~/config/pd.toml默认启动 playground 时，各个组件都是使用官方镜像组件包中的二进制文件启动的，如果本地编译了一个临时的二进制文件想要放入集群中测试，可以使用 --{comp}.binpath 这个参数替换，例如执行以下命令替换 TiDB 的二进制文件：
{{< copyable "shell-regular" >}}
tiup playground --db.binpath /xx/tidb-server默认情况下各启动一个 TiDB、TiKV 和 PD 实例，如果希望启动多个，可以加上如下参数：
{{< copyable "shell-regular" >}}
tiup playground --db 3 --pd 3 --kv 3Playground 集群在命令行退出时，会默认清空所有的集群数据。如果想要启动一个数据不被自动删除的 Playground 集群，需要在启动时指定集群 tag，指定后可以在 ~/.tiup/data 路径下找到该集群的数据。在集群启动时指定 tag 的方法如下：
tiup playground --tag <tagname>以这种方式启动的集群，在集群关闭以后，数据文件会保留。下一次可以继续使用该 tag 启动集群，从而使用从上一次集群关闭时的数据。
TiUP 提供了 client 组件，用于自动寻找并连接 playground 在本地启动的 TiDB 集群，使用方式为：
{{< copyable "shell-regular" >}}
tiup client该命令会在控制台上提供当前机器上由 playground 启动的 TiDB 集群列表，选中需要连接的 TiDB 集群，点击回车后，可以打开一个自带的 MySQL 客户端以连接 TiDB。
{{< copyable "shell-regular" >}}
tiup playground display可以看到如下信息：
Pid Role Uptime
--- ---- ------
84518 pd 35m22.929404512s
84519 tikv 35m22.927757153s
84520 pump 35m22.92618275s
86189 tidb exited
86526 tidb 34m28.293148663s
86190 drainer 35m19.91349249s
扩容集群的命令行参数与启动集群的相似。以下命令可以扩容两个 TiDB：
{{< copyable "shell-regular" >}}
tiup playground scale-out --db 2可在 tiup playground scale-in 命令中指定 pid，以缩容对应的实例。可以通过 tiup playground display 命令查看 pid。
{{< copyable "shell-regular" >}}
tiup playground scale-in --pid 86526从 v8.2.0 起，PD 微服务（实验特性）支持通过 TiUP 部署。你可以通过 TiUP Playground 为集群部署 tso 微服务和 scheduling 微服务。
tiup playground v8.3.0 --pd.mode ms --pd 3 --tso 2 --scheduling 2--pd.mode：当指定--pd.mode为ms时，代表启用 PD 微服务模式。--pd <num>：指定 PD 微服务 API 的数量，需要大于等于1。--tso <num>：指定要部署的tso微服务的实例数量。--scheduling <num>：指定要部署的scheduling微服务的实例数量。