Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tiup-playground: add info about TiProxy #19769

Merged
merged 8 commits into from
Dec 23, 2024
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions tiup/tiup-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,30 @@ You can specify a `pid` in the `tiup playground scale-in` command to scale in th
tiup playground scale-in --pid 86526
```

## Deploy TiProxy

[TiProxy](/tiproxy/tiproxy-overview.md) is the official proxy component of PingCAP. It is placed between the client and the TiDB server to provide load balancing, connection persistence, service discovery, and other features for TiDB.
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

You can deploy the TiProxy for your cluster using TiUP Playground as in the following example:
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

```shell
tiup playground v8.5.0 --tiproxy 1
```

The following are command-line flags of the playground component for TiProxy:
lilin90 marked this conversation as resolved.
Show resolved Hide resolved

```bash
Flags:
--tiproxy int Specifies the number of TiProxy nodes in the cluster. If not specified, TiProxy is not deployed.
--tiproxy.binpath string TiProxy instance binary path
qiancai marked this conversation as resolved.
Show resolved Hide resolved
--tiproxy.config string TiProxy instance configuration file
--tiproxy.host host Playground TiProxy host. If not provided, TiProxy will still use host flag as its host
--tiproxy.port int Playground TiProxy port. If not provided, TiProxy will use 6000 as its port
--tiproxy.timeout int TiProxy max wait time in seconds for starting. 0 means no limit (default 60)
lilin90 marked this conversation as resolved.
Show resolved Hide resolved
```

For more information about TiProxy, see [TiProxy documentation](/tiproxy/tiproxy-overview.md).

## Deploy PD microservices

Starting from v8.2.0, [PD microservice mode](/pd-microservices.md) (experimental) can be deployed using TiUP. You can deploy the `tso` microservice and `scheduling` microservice for your cluster using TiUP Playground as follows:
Expand Down
Loading