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) #6098

Merged
merged 4 commits into from
Apr 22, 2021
Merged
Changes from 3 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
4 changes: 4 additions & 0 deletions pd-control.md
Original file line number Diff line number Diff line change
@@ -7,6 +7,10 @@ aliases: ['/docs-cn/v3.0/pd-control/','/docs-cn/v3.0/reference/tools/pd-control/

PD Control 是 PD 的命令行工具,用于获取集群状态信息和调整集群。

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

## 源码编译

1. [Go](https://golang.org/) Version 1.13 以上
6 changes: 5 additions & 1 deletion tidb-control.md
Original file line number Diff line number Diff line change
@@ -11,6 +11,10 @@ TiDB Control 是 TiDB 的命令行工具,用于获取 TiDB 状态信息,多

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

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

### 通过 TiDB Ansible 安装

对于使用 [TiDB Ansible](/online-deployment-using-ansible.md) 部署的 TiDB 集群,在 TiDB 的安装路径下可以找到 TiDB Control 的二进制程序 `tidb-ctl`。
@@ -132,7 +136,7 @@ tid 子命令用来通过表的 id 获取数据库中表的表结构。
"collate": "utf8mb4_bin",
...
}
```
```

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

4 changes: 4 additions & 0 deletions tikv-control.md
Original file line number Diff line number Diff line change
@@ -10,6 +10,10 @@ TiKV Control(以下简称 tikv-ctl)是 TiKV 的命令行工具,用于管
* 如果是使用 TiDB Ansible 部署的集群,在 `ansible` 目录下的 `resources/bin` 子目录下。
* 如果是使用 TiUP 部署的集群,在 `~/.tiup/components/ctl/{VERSION}/` 目录下。

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

[TiUP](https://github.com/pingcap/tiup) 是晚于 `tidb-ansible` 推出的部署工具,使用方式更加简化,`tikv-ctl` 也集成在了 `tiup` 命令中。执行以下命令,即可调用 `tikv-ctl` 工具:

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