From 1e5ae17e6558c17f36c3f7330804bf77b9449579 Mon Sep 17 00:00:00 2001 From: xixirangrang Date: Fri, 13 Dec 2024 15:38:13 +0800 Subject: [PATCH] Update tiup-playground.md --- tiup/tiup-playground.md | 54 +---------------------------------------- 1 file changed, 1 insertion(+), 53 deletions(-) diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index 0dc6f5c54bd07..d2c16701dbe85 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -27,60 +27,8 @@ This command actually performs the following operations: You can use the following command to view the command-line flags of the playground component: -<<<<<<< HEAD -```bash -Flags: - --db int Specify the number of TiDB instances (default: 1) - --db.host host Specify the listening address of TiDB - --db.port int Specify the port of TiDB - --db.binpath string Specify the TiDB instance binary path (optional, for debugging) - --db.config string Specify the TiDB instance configuration file (optional, for debugging) - --db.timeout int Specify TiDB maximum wait time in seconds for starting. 0 means no limit - --drainer int Specify Drainer data of the cluster - --drainer.binpath string Specify the location of the Drainer binary files (optional, for debugging) - --drainer.config string Specify the Drainer configuration file - -h, --help Display help information for TiUP - --host string Specify the listening address of each component (default: `127.0.0.1`). Set it to `0.0.0.0` if provided for access of other machines - --kv int Specify the number of TiKV instances (default: 1) - --kv.binpath string Specify the TiKV instance binary path (optional, for debugging) - --kv.config string Specify the TiKV instance configuration file (optional, for debugging) - --mode string Specify the playground mode: 'tidb' (default) and 'tikv-slim' - --pd int Specify the number of PD instances (default: 1) - --pd.host host Specify the listening address of PD - --pd.binpath string Specify the PD instance binary path (optional, for debugging) - --pd.config string Specify the PD instance configuration file (optional, for debugging) - --pd.mode string Specify the PD working mode. The optional value is 'ms'. Specifying this flag means enabling PD microservice mode. - --pump int Specify the number of Pump instances. If the value is not `0`, TiDB Binlog is enabled. - --pump.binpath string Specify the location of the Pump binary files (optional, for debugging) - --pump.config string Specify the Pump configuration file (optional, for debugging) - --scheduling int Specify the number of Scheduling instances (default: 1)，which can be set only when `pd.mode` is 'ms' - --scheduling.host host Specify the listening address of the Scheduling instance - --scheduling.binpath string Specify the Scheduling instance binary path (optional, for debugging) - --scheduling.config string Specify the Scheduling instance configuration file (optional, for debugging) - -T, --tag string Specify a tag for playground - --ticdc int Specify the number of TiCDC instances (default: 0) - --ticdc.binpath string Specify the TiCDC instance binary path (optional, for debugging) - --ticdc.config string Specify the TiCDC instance configuration file (optional, for debugging) - --tiflash int Specify the number of TiFlash instances (default: 1) - --tiflash.binpath string Specify the TiFlash instance binary path (optional, for debugging) - --tiflash.config string Specify the TiFlash instance configuration file (optional, for debugging) - --tiflash.timeout int Specify TiFlash maximum wait time in seconds for starting. 0 means no limit - --tiproxy int TiProxy instance number - --tso int Specify the number of TSO instances (default: 1)，which can be set only when `pd.mode` is 'ms' - --tso.host host Specify the listening address of the TSO instance - --tso.binpath string Specify the TSO instance binary path (optional, for debugging) - --tso.config string Specify the TSO instance configuration file (optional, for debugging) - --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) - -v, --version Specify the version of playground - --without-monitor Disable the monitoring function of Prometheus and Grafana. If you do not add this flag, the monitoring function is enabled by default. -======= ```shell tiup playground --help ->>>>>>> da0d15025a (tiup: refine description about `tiup playground --tag` (#19669)) ``` ## Examples @@ -197,4 +145,4 @@ tiup playground v8.3.0 --pd.mode ms --pd 3 --tso 2 --scheduling 2 - `--pd.mode`: setting it to `ms` means enabling the microservice mode for PD. - `--pd `: specifies the number of APIs for PD microservices. It must be at least `1`. - `--tso `: specifies the number of instances to be deployed for the `tso` microservice. -- `--scheduling `: specifies the number of instances to be deployed for the `scheduling` microservice. \ No newline at end of file +- `--scheduling `: specifies the number of instances to be deployed for the `scheduling` microservice.