From 09e171fded22922b5d02b078dc0cb885ecbbd904 Mon Sep 17 00:00:00 2001 From: ti-srebot <66930949+ti-srebot@users.noreply.github.com> Date: Wed, 21 Apr 2021 13:13:53 +0800 Subject: [PATCH] ctl: add a note for all ctl docs (#6096) (#6101) --- pd-control.md | 8 ++++++-- tidb-binlog/binlog-control.md | 6 +++++- tidb-control.md | 6 +++++- tikv-control.md | 4 ++++ 4 files changed, 20 insertions(+), 4 deletions(-) diff --git a/pd-control.md b/pd-control.md index 2aa0ac6ab62e..9a121add63da 100644 --- a/pd-control.md +++ b/pd-control.md @@ -8,6 +8,10 @@ PD Control 是 PD 的命令行工具,用于获取集群状态信息和调整 ## 安装方式 +> **注意:** +> +> 建议使用的 Control 工具版本与集群版本保持一致。 + ### 使用 TiUP 可直接通过 `tiup ctl pd: -u http://: [-i]` 使用。 @@ -974,8 +978,8 @@ Encoding 格式示例: >> scheduler remove grant-leader-scheduler-1 // 把对应的调度器删掉,`-1` 对应 store ID >> scheduler pause balance-region-scheduler 10 // 暂停运行 balance-region 调度器 10 秒 >> scheduler pause all 10 // 暂停运行所有的调度器 10 秒 ->> scheduler resume balance-region-scheduler // 继续运行 balance-region 调度器 ->> scheduler resume all // 继续运行所有的调度器 +>> scheduler resume balance-region-scheduler // 继续运行 balance-region 调度器 +>> scheduler resume all // 继续运行所有的调度器 >> scheduler config balance-hot-region-scheduler // 显示 balance-hot-region 调度器的配置 ``` diff --git a/tidb-binlog/binlog-control.md b/tidb-binlog/binlog-control.md index f4cd901eceac..eaba288da88f 100644 --- a/tidb-binlog/binlog-control.md +++ b/tidb-binlog/binlog-control.md @@ -1,6 +1,6 @@ --- title: binlogctl 工具 -summary: 介绍 binlogctl 的使用方法。 +summary: 介绍 binlogctl 的使用方法。 --- # binlogctl 工具 @@ -21,6 +21,10 @@ binlogctl 支持如下这些功能: ## binlogctl 下载 +> **注意:** +> +> 建议使用的 Control 工具版本与集群版本保持一致。 + binlogctl 下载链接: {{< copyable "shell-regular" >}} diff --git a/tidb-control.md b/tidb-control.md index 9f08cc4b3ad8..16770e986806 100644 --- a/tidb-control.md +++ b/tidb-control.md @@ -10,6 +10,10 @@ TiDB Control 是 TiDB 的命令行工具,用于获取 TiDB 状态信息,多 本节提供了两种方式获取 TiDB Control 工具。 +> **注意:** +> +> 建议使用的 Control 工具版本与集群版本保持一致。 + ### 通过 TiUP 安装 在安装 TiUP 之后, 可以使用 `tiup ctl tidb` 命令来获取 TiDB Control 的二进制程序以及运行 TiDB Control。 @@ -134,7 +138,7 @@ tid 子命令用来通过表的 id 获取数据库中表的表结构。 "collate": "utf8mb4_bin", ... } -``` +``` 同 in 子命令一样,如果使用的 TiDB 地址不是默认的地址和端口,需要通过 `--host` 和 `--port` 参数指定 TiDB 的地址和 status 端口。 diff --git a/tikv-control.md b/tikv-control.md index d80cf5ffa3a1..3a935264d498 100644 --- a/tikv-control.md +++ b/tikv-control.md @@ -10,6 +10,10 @@ TiKV Control(以下简称 tikv-ctl)是 TiKV 的命令行工具,用于管 ## 通过 TiUP 使用 TiKV Control +> **注意:** +> +> 建议使用的 Control 工具版本与集群版本保持一致。 + `tikv-ctl` 也集成在了 `tiup` 命令中。执行以下命令,即可调用 `tikv-ctl` 工具: {{< copyable "shell-regular" >}}