From d2f6501e3ce31b10c5d15f3e9bb599607c931db2 Mon Sep 17 00:00:00 2001 From: JoyinQ <56883733+Joyinqin@users.noreply.github.com> Date: Mon, 26 Apr 2021 16:25:58 +0800 Subject: [PATCH] cherry pick #5435 to release-4.0 Signed-off-by: ti-srebot --- pd-control.md | 4 ++++ tidb-binlog/binlog-control.md | 4 ++++ tidb-control.md | 4 ++++ tikv-control.md | 8 ++++++++ 4 files changed, 20 insertions(+) diff --git a/pd-control.md b/pd-control.md index f16a2d60d841d..c0a0a40f5afac 100644 --- a/pd-control.md +++ b/pd-control.md @@ -10,6 +10,10 @@ As a command line tool of PD, PD Control obtains the state information of the cl ## Install PD Control +> **Note:** +> +> It is recommended that the version of the Control tool you use is consistent with the version of the cluster. + ### Use TiUP command To use PD Control, execute the `tiup ctl pd -u http://: [-i]` command. diff --git a/tidb-binlog/binlog-control.md b/tidb-binlog/binlog-control.md index 6f1b71a1bfb3d..284b8e07ef2dd 100644 --- a/tidb-binlog/binlog-control.md +++ b/tidb-binlog/binlog-control.md @@ -22,6 +22,10 @@ The following are its usage scenarios: ## Download `binlogctl` +> **Note:** +> +> It is recommended that the version of the Control tool you use is consistent with the version of the cluster. + {{< copyable "shell-regular" >}} ```bash diff --git a/tidb-control.md b/tidb-control.md index a41648128a104..a7bd7a3ad0f4e 100644 --- a/tidb-control.md +++ b/tidb-control.md @@ -12,6 +12,10 @@ TiDB Control is a command-line tool of TiDB, usually used to obtain the status i You can get TiDB Control by installing it using TiUP or by compiling it from source code. +> **Note:** +> +> It is recommended that the version of the Control tool you use is consistent with the version of the cluster. + ### Install TiDB Control using TiUP After installing TiUP, you can use `tiup ctl tidb` command to get and execute TiDB Control. diff --git a/tikv-control.md b/tikv-control.md index b99c19ec30327..7a55c43eb101b 100644 --- a/tikv-control.md +++ b/tikv-control.md @@ -12,7 +12,15 @@ TiKV Control (`tikv-ctl`) is a command line tool of TiKV, used to manage the clu * If the cluster is deployed using TiUP, `tikv-ctl` directory is in the in `~/.tiup/components/ctl/{VERSION}/` directory. ## Use TiKV Control in TiUP +<<<<<<< HEAD +======= + +> **Note:** +> +> It is recommended that the version of the Control tool you use is consistent with the version of the cluster. + +>>>>>>> 70a6d90f... ctl: add a note for all ctl docs (#5435) `tikv-ctl` is also integrated in the `tiup` command. Execute the following command to call the `tikv-ctl` tool: {{< copyable "shell-regular" >}}