Skip to content

Commit

Permalink
tiup-playground: update instructions for deploying TiProxy (#19360) (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Dec 23, 2024
1 parent f891cee commit fac66f2
Showing 1 changed file with 28 additions and 15 deletions.
43 changes: 28 additions & 15 deletions tiup/tiup-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,25 +154,38 @@ tiup playground scale-in --pid 86526

[TiProxy](/tiproxy/tiproxy-overview.md) 是 PingCAP 的官方代理组件,位于客户端和 TiDB server 之间,为 TiDB 提供负载均衡、连接保持、服务发现等功能。

从 TiUP v1.14.1 版本起,你可以通过 TiUP Playground 为集群部署 TiProxy。例如:
从 TiUP v1.15.0 版本起,你可以通过 TiUP Playground 为集群部署 TiProxy。

```shell
tiup playground v8.5.0 --tiproxy 1
```
1. 创建 `tidb.toml` 文件,并添加如下配置:

关于 TiProxy 的部署和使用详情,请参考 [TiProxy 文档](/tiproxy/tiproxy-overview.md#安装和使用)
```
graceful-wait-before-shutdown=15
```
`tiup playground` 命令行中与 TiProxy 相关的选项说明:
该配置项用于控制关闭服务器时 TiDB 等待的秒数,避免缩容集群时客户端断连。
```bash
Flags:
--tiproxy int 设置集群中 TiProxy 节点的数量。如果未指定,不会部署 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)。
```
2. 启动 TiDB 集群:
```shell
tiup playground v8.5.0 --tiproxy 1 --db.config tidb.toml
```
`tiup playground` 命令行中与 TiProxy 相关的选项说明:
```bash
Flags:
--tiproxy int 设置集群中 TiProxy 节点的数量。如果未指定,不会部署 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)。
--tiproxy.version string 指定 TiProxy 的版本号。如果没有提供,会部署最新的 TiProxy 版本。
```
关于 TiProxy 的部署和使用详情,请参考[安装和使用 TiProxy](/tiproxy/tiproxy-overview.md#安装和使用)。
如需使用 TiProxy 客户端程序 `tiproxyctl`,请参考[安装 TiProxy Control](/tiproxy/tiproxy-command-line-flags.md#安装-tiproxy-control)。
## 部署 PD 微服务
Expand Down

0 comments on commit fac66f2

Please sign in to comment.