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

ctl: add a note for all ctl docs #6096

Merged
merged 1 commit into from
Apr 21, 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
8 changes: 6 additions & 2 deletions pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ PD Control 是 PD 的命令行工具,用于获取集群状态信息和调整

## 安装方式

> **注意:**
>
> 建议使用的 Control 工具版本与集群版本保持一致。

### 使用 TiUP

可直接通过 `tiup ctl pd:<pd_version> -u http://<pd_ip>:<pd_port> [-i]` 使用。
Expand Down Expand Up @@ -975,8 +979,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 调度器的配置
```

Expand Down
6 changes: 5 additions & 1 deletion tidb-binlog/binlog-control.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: binlogctl 工具
summary: 介绍 binlogctl 的使用方法。
summary: 介绍 binlogctl 的使用方法。
aliases: ['/docs-cn/dev/tidb-binlog/binlog-control/']
---

Expand All @@ -22,6 +22,10 @@ binlogctl 支持如下这些功能:

## binlogctl 下载

> **注意:**
>
> 建议使用的 Control 工具版本与集群版本保持一致。

binlogctl 下载链接:

{{< copyable "shell-regular" >}}
Expand Down
6 changes: 5 additions & 1 deletion tidb-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ TiDB Control 是 TiDB 的命令行工具,用于获取 TiDB 状态信息,多

本节提供了两种方式获取 TiDB Control 工具。

> **注意:**
>
> 建议使用的 Control 工具版本与集群版本保持一致。

### 通过 TiUP 安装

在安装 TiUP 之后, 可以使用 `tiup ctl tidb` 命令来获取 TiDB Control 的二进制程序以及运行 TiDB Control。
Expand Down Expand Up @@ -135,7 +139,7 @@ tid 子命令用来通过表的 id 获取数据库中表的表结构。
"collate": "utf8mb4_bin",
...
}
```
```

同 in 子命令一样,如果使用的 TiDB 地址不是默认的地址和端口,需要通过 `--host` 和 `--port` 参数指定 TiDB 的地址和 status 端口。

Expand Down
4 changes: 4 additions & 0 deletions tikv-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ TiKV Control(以下简称 tikv-ctl)是 TiKV 的命令行工具,用于管

## 通过 TiUP 使用 TiKV Control

> **注意:**
>
> 建议使用的 Control 工具版本与集群版本保持一致。

`tikv-ctl` 也集成在了 `tiup` 命令中。执行以下命令,即可调用 `tikv-ctl` 工具:

{{< copyable "shell-regular" >}}
Expand Down