Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust for deprecation of --monitor #1639

Merged
merged 4 commits into from
Nov 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/playground/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
47 changes: 39 additions & 8 deletions doc/user/playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down