diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 9ae1487626fa0..6c3b65311753b 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -133,3 +133,38 @@ You can specify a `pid` in the `tiup playground scale-in` command to scale in th ```shell 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.15.0, you can deploy TiProxy for your cluster using TiUP Playground. + +1. Create a `tidb.toml` file and add the following configuration: + + ``` + graceful-wait-before-shutdown=15 + ``` + + This configuration item controls the duration (in seconds) that TiDB waits before shutting down the server, avoiding client disconnections during cluster scaling-in operations. + +2. Start the TiDB cluster: + + ```shell + tiup playground v8.1.1 --tiproxy 1 --db.config tidb.toml + ``` + + 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). + --tiproxy.version string The version of TiProxy. If not specified, the latest version of TiProxy is deployed. + ``` + +For more information about deploying and using TiProxy, see [TiProxy installation and usage](/tiproxy/tiproxy-overview.md#installation-and-usage).