From b4e40f2f7e3b6505187deac6c22b1944380c2f66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Wed, 24 Nov 2021 15:37:20 +0100 Subject: [PATCH 1/3] Adjust for deprecation of `--monitor` --- components/playground/main.go | 2 +- doc/user/playground.md | 47 +++++++++++++++++++++++++++++------ 2 files changed, 40 insertions(+), 9 deletions(-) diff --git a/components/playground/main.go b/components/playground/main.go index 7de793e9b9..4ac764fe64 100644 --- a/components/playground/main.go +++ b/components/playground/main.go @@ -146,7 +146,7 @@ if you don't specified a version. Examples: $ tiup playground nightly # Start a TiDB nightly version local cluster $ tiup playground v5.0.1 --db 3 --pd 3 --kv 3 # Start a local cluster with 10 nodes - $ tiup playground nightly --monitor=false # Start a local cluster and disable monitor system + $ tiup playground nightly --without-monitor # Start a local cluster and disable monitor system $ tiup playground --pd.config ~/config/pd.toml # Start a local cluster with specified configuration file $ tiup playground --db.binpath /xx/tidb-server # Start a local cluster with component binary path $ tiup playground --mode tikv-slim # Start a local tikv only cluster (No TiDB or TiFlash Available) diff --git a/doc/user/playground.md b/doc/user/playground.md index 98538f2c76..2113c3094d 100644 --- a/doc/user/playground.md +++ b/doc/user/playground.md @@ -22,23 +22,48 @@ The command line arguments for playground state: ```bash Usage: tiup playground [version] [flags] + tiup [command] + +Available Commands: + completion generate the autocompletion script for the specified shell + display + help Help about any command + scale-in + scale-out Flags: - --db int TiDB instance number (default 1) + --db int TiDB instance number + --db.Host host Playground TiDB host. If not provided, TiDB will still use host flag as its host + --db.Port int Playground TiDB port. If not provided, TiDB will use 4000 as its port --db.binpath string TiDB instance binary path --db.config string TiDB instance configuration file + --db.timeout int TiDB max wait time in seconds for starting, 0 means no limit + --drainer int Drainer instance number + --drainer.binpath string Drainer instance binary path + --drainer.config string Drainer instance configuration file -h, --help help for tiup - --host string Playground cluster host (default "127.0.0.1") - --kv int TiKV instance number (default 1) + --host string Playground cluster host + --kv int TiKV instance number --kv.binpath string TiKV instance binary path --kv.config string TiKV instance configuration file - --monitor Start prometheus component - --pd int PD instance number (default 1) + --mode string TiUP playground mode: 'tidb', 'tikv-slim' (default "tidb") + --pd int PD instance number + --pd.Host host Playground PD host. If not provided, PD will still use host flag as its host --pd.binpath string PD instance binary path --pd.config string PD instance configuration file + --pump int Pump instance number + --pump.binpath string Pump instance binary path + --pump.config string Pump instance configuration file + -T, --tag string Specify a tag for playground + --ticdc int TiCDC instance number + --ticdc.binpath string TiCDC instance binary path + --ticdc.config string TiCDC instance configuration file --tiflash int TiFlash instance number --tiflash.binpath string TiFlash instance binary path --tiflash.config string TiFlash instance configuration file + --tiflash.timeout int TiFlash max wait time in seconds for starting, 0 means no limit + -v, --version version for tiup + --without-monitor Don't start prometheus and grafana component ``` ## Example @@ -51,13 +76,19 @@ tiup playground nightly Nightly is the version number of this cluster, and similar ones can be `tiup playground v4.0.0-rc` etc. -### Start a cluster with monitoring. +### Start a cluster with or without monitoring. + +```shell +tiup playground nightly +``` + +This command launches Prometheus on port 9090 and Grafana on port 3000 for displaying timing data within the cluster. ```shell -tiup playground nightly --monitor +tiup playground nightly --without-monitor ``` -This command launches prometheus on port 9090 for displaying timing data within the cluster. +This won't launch Prometheus or Grafana. This can be used to save resources. ### Overrides the default configuration of the PD From b184639467003544e31f006939cb5cfc3a560166 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Thu, 25 Nov 2021 08:39:21 +0100 Subject: [PATCH 2/3] Update doc/user/playground.md Co-authored-by: Allen Zhong --- doc/user/playground.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/playground.md b/doc/user/playground.md index 2113c3094d..67e8741cd5 100644 --- a/doc/user/playground.md +++ b/doc/user/playground.md @@ -33,7 +33,7 @@ Available Commands: Flags: --db int TiDB instance number - --db.Host host Playground TiDB host. If not provided, TiDB will still use host flag as its host + --db.host host Playground TiDB host. If not provided, TiDB will still use host flag as its host --db.Port int Playground TiDB port. If not provided, TiDB will use 4000 as its port --db.binpath string TiDB instance binary path --db.config string TiDB instance configuration file From 3742e6e34937f63b4e68e308abc2030023c0df6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Eeden?= Date: Thu, 25 Nov 2021 08:39:41 +0100 Subject: [PATCH 3/3] Update doc/user/playground.md --- doc/user/playground.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/playground.md b/doc/user/playground.md index 67e8741cd5..31acbd4b7e 100644 --- a/doc/user/playground.md +++ b/doc/user/playground.md @@ -34,7 +34,7 @@ Available Commands: Flags: --db int TiDB instance number --db.host host Playground TiDB host. If not provided, TiDB will still use host flag as its host - --db.Port int Playground TiDB port. If not provided, TiDB will use 4000 as its port + --db.port int Playground TiDB port. If not provided, TiDB will use 4000 as its port --db.binpath string TiDB instance binary path --db.config string TiDB instance configuration file --db.timeout int TiDB max wait time in seconds for starting, 0 means no limit