From 340910954ac3017e104c53f336b6c10f502a062c Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 23 Dec 2024 14:14:51 +0800 Subject: [PATCH 1/8] Add temp.md --- temp.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 temp.md diff --git a/temp.md b/temp.md new file mode 100644 index 0000000000000..af27ff4986a7b --- /dev/null +++ b/temp.md @@ -0,0 +1 @@ +This is a test file. \ No newline at end of file From d1d42c141d66fb52caa8d772d9ba6b789ca727b9 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 23 Dec 2024 14:14:56 +0800 Subject: [PATCH 2/8] Delete temp.md --- temp.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 temp.md diff --git a/temp.md b/temp.md deleted file mode 100644 index af27ff4986a7b..0000000000000 --- a/temp.md +++ /dev/null @@ -1 +0,0 @@ -This is a test file. \ No newline at end of file From f1256da1267d9ace1d9d24ccbfaecea1ee4c8855 Mon Sep 17 00:00:00 2001 From: qiancai Date: Mon, 23 Dec 2024 14:21:20 +0800 Subject: [PATCH 3/8] Update tiup-playground.md --- tiup/tiup-playground.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index a97a24cfb5260..02be6e166dda8 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -133,6 +133,29 @@ 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. + +You can deploy the TiProxy for your cluster using TiUP Playground as in the following example: + +```shell +tiup playground v8.5.0 --tiproxy 1 +``` + +The following are command-line flags of the playground component for TiProxy: + +```bash +Flags: + --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 max wait time in seconds for starting. 0 means no limit (default 60) +``` + +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: From 8410312f5abd779a98b56a4a6d9f184409e9128e Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 23 Dec 2024 14:29:42 +0800 Subject: [PATCH 4/8] Update tiup/tiup-playground.md --- tiup/tiup-playground.md | 1 + 1 file changed, 1 insertion(+) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 02be6e166dda8..808c01357cb18 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -147,6 +147,7 @@ The following are command-line flags of the playground component for TiProxy: ```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 --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 From 13626ceee01a1550823908af4e0ba75277543d43 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Mon, 23 Dec 2024 14:50:56 +0800 Subject: [PATCH 5/8] Apply suggestions from code review --- tiup/tiup-playground.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 808c01357cb18..99abec5cb5557 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -135,24 +135,24 @@ 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. +[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. -You can deploy the TiProxy for your cluster using TiUP Playground as in the following example: +You can deploy TiProxy for your cluster using TiUP Playground, as in the following example: ```shell tiup playground v8.5.0 --tiproxy 1 ``` -The following are command-line flags of the playground component for TiProxy: +TiProxy-related command-line flags in the playground component are as follows: ```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 - --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) + --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 max wait time in seconds for starting. 0 means no limit (default 60). ``` For more information about TiProxy, see [TiProxy documentation](/tiproxy/tiproxy-overview.md). From 72d3af3c0b1dff65b1d11114107e11c82b364083 Mon Sep 17 00:00:00 2001 From: qiancai Date: Mon, 23 Dec 2024 15:10:43 +0800 Subject: [PATCH 6/8] Update tiup-playground.md --- tiup/tiup-playground.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 99abec5cb5557..705942ea066c6 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -137,13 +137,15 @@ tiup playground scale-in --pid 86526 [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. -You can deploy TiProxy for your cluster using TiUP Playground, as in the following example: +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 ``` -TiProxy-related command-line flags in the playground component are as follows: +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: @@ -155,8 +157,6 @@ Flags: --tiproxy.timeout int TiProxy max wait time in seconds for starting. 0 means no limit (default 60). ``` -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: From 0e2cd41c0be1c42b6afe5fc9c51e1e0a6fcc466a Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 23 Dec 2024 15:17:47 +0800 Subject: [PATCH 7/8] Update tiup/tiup-playground.md --- tiup/tiup-playground.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 705942ea066c6..b4eb99d6bdc2a 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -149,7 +149,7 @@ In the playground component, TiProxy-related command-line flags are as follows: ```bash Flags: - --tiproxy int Specifies the number of TiProxy nodes in the cluster. If not specified, TiProxy is not deployed. + --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. From ee6bd1c3a71e1c77263ed453ca4a9afca01221fe Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Mon, 23 Dec 2024 16:00:44 +0800 Subject: [PATCH 8/8] Update tiup/tiup-playground.md --- tiup/tiup-playground.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index b4eb99d6bdc2a..be90f212d9e36 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -154,7 +154,7 @@ Flags: --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). + --tiproxy.timeout int TiProxy maximum wait time in seconds for starting. 0 means no limit (default 60). ``` ## Deploy PD microservices