Skip to content

Commit c334400

Browse files
ti-srebotyikeke
andauthored
cherry pick #3995 to release-4.0 (#3999)
Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
1 parent d0ded9d commit c334400

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

pd-control.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ aliases: ['/docs-cn/stable/reference/tools/pd-control/']
77

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

10-
## 使用 TiUP
10+
## 安装方式
11+
12+
### 使用 TiUP
1113

1214
可直接通过 `tiup ctl pd -- -u http://<pd_ip>:<pd_port> [-i]` 使用。
1315

14-
## 下载安装包
16+
### 下载安装包
1517

1618
如需下载最新版本的 `pd-ctl`,直接下载 TiDB 安装包即可,因为 `pd-ctl` 包含在 TiDB 安装包中。
1719

@@ -23,7 +25,7 @@ PD Control 是 PD 的命令行工具,用于获取集群状态信息和调整
2325
>
2426
> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v4.0.0-rc.2` 版本的下载链接为 `https://download.pingcap.org/tidb-v4.0.0-rc.2-linux-amd64.tar.gz`。也可以使用 `latest` 替代 `{version}` 来下载最新的未发布版本。
2527
26-
## 源码编译
28+
### 源码编译
2729

2830
1. [Go](https://golang.org/) Version 1.13 以上
2931
2. 在 PD 项目根目录使用 `make` 或者 `make pd-ctl` 命令进行编译,生成 bin/pd-ctl
@@ -63,45 +65,45 @@ export PD_ADDR=http://127.0.0.1:2379 &&
6365
./pd-ctl -u https://127.0.0.1:2379 --cacert="path/to/ca" --cert="path/to/cert" --key="path/to/key"
6466
```
6567

66-
## 命令行参数(flags)
68+
## 命令行参数 (flags)
6769

68-
### --cacert
70+
### `--cacert`
6971

7072
- 指定 PEM 格式的受信任 CA 证书的文件路径
7173
- 默认值:""
7274

73-
### --cert
75+
### `--cert`
7476

7577
- 指定 PEM 格式的 SSL 证书的文件路径
7678
- 默认值:""
7779

78-
### --detach,-d
80+
### `--detach` / `-d`
7981

8082
+ 使用单命令行模式(不进入 readline)
8183
+ 默认值: true
8284

83-
### --help,-h
85+
### `--help` / `-h`
8486

8587
+ 输出帮助信息
8688
+ 默认值:false
8789

88-
### --interact,-i
90+
### `--interact` / `-i`
8991

9092
+ 使用交互模式(进入 readline)
9193
+ 默认值:false
9294

93-
### --key
95+
### `--key`
9496

9597
- 指定 PEM 格式的 SSL 证书密钥文件路径,即 `--cert` 所指定的证书的私钥
9698
- 默认值: ""
9799

98-
### --pd,-u
100+
### `--pd` / `-u`
99101

100102
+ 指定 PD 的地址
101103
+ 默认地址:`http://127.0.0.1:2379`
102104
+ 环境变量:`PD_ADDR`
103105

104-
### --version,-V
106+
### `--version` / `-V`
105107

106108
- 打印版本信息并退出
107109
- 默认值: false
@@ -570,10 +572,10 @@ Success!
570572

571573
```
572574
{
573-
"name": "pd",
574-
"member_id": 13155432540099656863,
575-
"peer_urls": [......],
576-
"client_urls": [......]
575+
"name": "pd",
576+
"member_id": 13155432540099656863,
577+
"peer_urls": [......],
578+
"client_urls": [......]
577579
}
578580
```
579581

@@ -947,10 +949,10 @@ Encoding 格式示例:
947949
>> scheduler add shuffle-leader-scheduler // 随机交换不同 store 上的 leader
948950
>> scheduler add shuffle-region-scheduler // 随机调度不同 store 上的 Region
949951
>> scheduler remove grant-leader-scheduler-1 // 把对应的 scheduler 删掉
950-
>> schedule pause balance-region-scheduler 10 // 暂停运行 balance-region 调度器 10 秒
951-
>> schedule pause all 10 // 暂停运行所有的调度器 10 秒
952-
>> schedule resume balance-region-scheduler // 继续运行 balance-region 调度器
953-
>> schedule resume all // 继续运行所有的调度器
952+
>> scheduler pause balance-region-scheduler 10 // 暂停运行 balance-region 调度器 10 秒
953+
>> scheduler pause all 10 // 暂停运行所有的调度器 10 秒
954+
>> scheduler resume balance-region-scheduler // 继续运行 balance-region 调度器
955+
>> scheduler resume all // 继续运行所有的调度器
954956
>> scheduler config balance-hot-region-scheduler // 显示 balance-hot-region 调度器的配置
955957
```
956958

@@ -1016,7 +1018,7 @@ Encoding 格式示例:
10161018
{{< copyable "" >}}
10171019

10181020
```bash
1019-
>> store remove-tombstone // 删除所有 tombstone 状态的 store 记录
1021+
>> store remove-tombstone // 删除所有 tombstone 状态的 store
10201022
>> store limit // 显示所有 store 添加 peer 的速度上限
10211023
>> store limit region-add // 显示所有 store 添加 peer 的速度上限
10221024
>> store limit region-remove // 显示所有 store 删除 peer 的速度上限

0 commit comments

Comments
 (0)