diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index a97a24cfb5260..be90f212d9e36 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -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 from PingCAP, placed between the client and the TiDB server to provide load balancing, connection persistence, service discovery, and other features for TiDB. + +Starting from TiUP v1.14.1, you can deploy TiProxy for your cluster using TiUP Playground, as in the following example: + +```shell +tiup playground v8.5.0 --tiproxy 1 +``` + +For more information about TiProxy deployment and usage, see [TiProxy documentation](/tiproxy/tiproxy-overview.md#installation-and-usage). + +In the playground component, TiProxy-related command-line flags are as follows: + +```bash +Flags: + --tiproxy int The number of TiProxy nodes in the cluster. If not specified, TiProxy is not deployed. + --tiproxy.binpath string TiProxy instance binary path. + --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 maximum wait time in seconds for starting. 0 means no limit (default 60). +``` + ## 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: