cherry pick pingcap#5773 to release-5.0

Signed-off-by: ti-srebot <[email protected]>
ti-srebot · Apr 27, 2021 · a60083f · a60083f
1 parent 00fa44c
commit a60083f
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 欢迎来到 [TiDB](https://github.com/pingcap/tidb) 文档仓库！
 
-这里存放的是 [PingCAP 官网 TiDB 中文文档](https://docs.pingcap.com/zh/tidb/v4.0)的源文件。[官网英文文档](https://docs.pingcap.com/tidb/v4.0)的源文件则存放于 [pingcap/docs](https://github.com/pingcap/docs)。
+这里存放的是 [PingCAP 官网 TiDB 中文文档](https://docs.pingcap.com/zh/tidb/stable)的源文件。[官网英文文档](https://docs.pingcap.com/tidb/stable)的源文件则存放于 [pingcap/docs](https://github.com/pingcap/docs)。
 
 如果你发现或遇到了 TiDB 的文档问题，可随时[提 Issue](https://github.com/pingcap/docs-cn/issues/new/choose) 来反馈，或者直接[提交 Pull Request](/CONTRIBUTING.md#pull-request-提交流程) 来进行修改。
 
@@ -13,6 +13,7 @@
 | 文档仓库 branch | 对应 TiDB 文档版本 |
 |:---------|:----------|
 | [`master`](https://github.com/pingcap/docs-cn/tree/master) | dev 最新开发版 |
+| [`release-5.0`](https://github.com/pingcap/docs-cn/tree/release-5.0) | 5.0 稳定版 |
 | [`release-4.0`](https://github.com/pingcap/docs-cn/tree/release-4.0) | 4.0 稳定版 |
 | [`release-3.1`](https://github.com/pingcap/docs-cn/tree/release-3.1) | 3.1 稳定版 |
 | [`release-3.0`](https://github.com/pingcap/docs-cn/tree/release-3.0) | 3.0 稳定版 |

diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md
@@ -16,7 +16,7 @@ title: TiDB 工具下载
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 TiDB 的版本号。例如，`v4.0.8` 版本的下载链接为 `https://download.pingcap.org/tidb-v4.0.8-linux-amd64.tar.gz`。
+> 下载链接中的 `{version}` 为 TiDB 的版本号。例如，`v5.0.0` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`。
 
 ## TiDB Lightning
 
@@ -28,7 +28,7 @@ title: TiDB 工具下载
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 TiDB Lightning 的版本号。例如，`v4.0.8` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v4.0.8-linux-amd64.tar.gz`。
+> 下载链接中的 `{version}` 为 TiDB Lightning 的版本号。例如，`v5.0.0` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.0.0-linux-amd64.tar.gz`。
 
 ## 备份和恢复 (BR) 工具
 
@@ -40,7 +40,7 @@ title: TiDB 工具下载
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 BR 的版本号。例如，`v4.0.8` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v4.0.8-linux-amd64.tar.gz`。
+> 下载链接中的 `{version}` 为 BR 的版本号。例如，`v5.0.0` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.0.0-linux-amd64.tar.gz`。
 
 ## TiDB DM (Data Migration)
 
@@ -52,7 +52,7 @@ title: TiDB 工具下载
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 DM 的版本号。例如，`v1.0.6` 版本的下载链接为 `https://download.pingcap.org/dm-v1.0.6-linux-amd64.tar.gz`。可以通过 [DM Release](https://github.com/pingcap/dm/releases) 查看当前已发布版本。
+> 下载链接中的 `{version}` 为 DM 的版本号。例如，`v2.0.1` 版本的下载链接为 `https://download.pingcap.org/dm-v2.0.1-linux-amd64.tar.gz`。可以通过 [DM Release](https://github.com/pingcap/dm/releases) 查看当前已发布版本。
 
 ## Dumpling
 
@@ -64,8 +64,8 @@ title: TiDB 工具下载
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 Dumpling 的版本号。例如，`v4.0.2` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v4.0.2-linux-amd64.tar.gz`。可以通过 [Dumpling Release](https://github.com/pingcap/dumpling/releases) 查看当前已发布版本。
-> Dumpling 已支持 arm64 linux，将下载链接中的 amd64 替换为 arm64，即表示 arm64 版 Dumpling。
+> - 下载链接中的 `{version}` 为 Dumpling 的版本号。例如，`v4.0.11` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v4.0.11-linux-amd64.tar.gz`。可以通过 [Dumpling Release](https://github.com/pingcap/dumpling/releases) 查看当前已发布版本。
+> - Dumpling 已支持 arm64 linux，将下载链接中的 amd64 替换为 arm64，即表示 arm64 版 Dumpling。
 
 ## sync-diff-inspector
 

diff --git a/maintain-tidb-using-tiup.md b/maintain-tidb-using-tiup.md
@@ -27,7 +27,7 @@ tiup cluster start ${cluster-name}
 ```
 
 > **注意：**
-> 
+>
 > 你需要将 `${cluster-name}` 替换成实际的集群名字，若忘记集群名字，可通过 `tiup cluster list` 查看。
 
 该命令支持通过 `-R` 和 `-N` 参数来只启动部分组件。
@@ -100,7 +100,7 @@ tiup cluster display ${cluster-name}
 
     **配置项层次结构使用 `.` 表示**。
 
-    关于组件的更多配置参数说明，可参考 [tidb `config.toml.example`](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example)、[tikv `config.toml.example`](https://github.com/tikv/tikv/blob/v4.0.0-rc/etc/config-template.toml) 和 [pd `config.toml.example`](https://github.com/pingcap/pd/blob/v4.0.0-rc/conf/config.toml)。
+    关于组件的更多配置参数说明，可参考 [tidb `config.toml.example`](https://github.com/pingcap/tidb/blob/master/config/config.toml.example)、[tikv `config.toml.example`](https://github.com/tikv/tikv/blob/master/etc/config-template.toml) 和 [pd `config.toml.example`](https://github.com/tikv/pd/blob/master/conf/config.toml)。
 
 3. 执行 `reload` 命令滚动分发配置、重启相应组件：
 
@@ -112,7 +112,7 @@ tiup cluster display ${cluster-name}
 
 ### 示例
 
-如果要调整 tidb-server 中事务大小限制参数 `txn-total-size-limit` 为 `1G`，该参数位于 [performance](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example) 模块下，调整后的配置如下：
+如果要调整 tidb-server 中事务大小限制参数 `txn-total-size-limit` 为 `1G`，该参数位于 [performance](https://github.com/pingcap/tidb/blob/master/config/config.toml.example) 模块下，调整后的配置如下：
 
 ```
 server_configs:
@@ -179,7 +179,7 @@ tiup cluster rename ${cluster-name} ${new-name}
 ```
 
 > **注意：**
-> 
+>
 > + 重命名集群会重启监控（Prometheus 和 Grafana）。
 > + 重命名集群之后 Grafana 可能会残留一些旧集群名的面板，需要手动删除这些面板。
 
@@ -234,7 +234,7 @@ tiup cluster clean ${cluster-name} --log
 {{< copyable "shell-regular" >}}
 
 ```bash
-tiup cluster clean ${cluster-name} --all 
+tiup cluster clean ${cluster-name} --all
 ```
 
 清空 Prometheus 以外的所有服务的日志和数据：

diff --git a/pd-control.md b/pd-control.md
@@ -26,7 +26,7 @@ PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v4.0.0-rc.2` 版本的下载链接为 `https://download.pingcap.org/tidb-v4.0.0-rc.2-linux-amd64.tar.gz`。也可以使用 `latest` 替代 `{version}` 来下载最新的未发布版本。
+> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v5.0.0` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`。
 
 ### 源码编译
 
@@ -221,7 +221,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 ```
 
 ```
-"4.0.0"
+"5.0.0"
 ```
 
 - `max-snapshot-count` 控制单个 store 最多同时接收或发送的 snapshot 数量，调度受制于这个配置来防止抢占正常业务的资源。当需要加快补副本或 balance 速度时可以调大这个值。

diff --git a/pd-recover.md b/pd-recover.md
@@ -29,7 +29,7 @@ PD Recover 包含在 TiDB 安装包中。直接下载 TiDB 安装包即可获取
 
 > **注意：**
 >
-> `{version}` 是 TiDB 的版本号。例如，`v4.0.0` 的安装包下载链接为 `https://download.pingcap.org/tidb-v4.0.0-linux-amd64.tar.gz`。你也可以用 `latest` 替换 `{version}`，下载最新的未发布版本。
+> `{version}` 是 TiDB 的版本号。例如，`v5.0.0` 的安装包下载链接为 `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`。
 
 ## 快速开始
 

diff --git a/post-installation-check.md b/post-installation-check.md
@@ -60,7 +60,7 @@ mysql -u root -h 10.0.1.4 -P 4000
 ```sql
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 3
-Server version: 5.7.25-TiDB-v4.0.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 5.7 compatible
+Server version: 5.7.25-TiDB-v5.0.0 TiDB Server (Apache License 2.0) Community Edition, MySQL 5.7 compatible
 
 Copyright (c) 2000, 2015, Oracle and/or its affiliates. All rights reserved.
 
@@ -85,7 +85,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
 
     ```sql
     *************************** 1. row ***************************
-    tidb_version(): Release Version: v4.0.0
+    tidb_version(): Release Version: v5.0.0
     Edition: Community
     Git Commit Hash: 689a6b6439ae7835947fcaccf329a3fc303986cb
     Git Branch: HEAD
@@ -146,7 +146,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
     {{< copyable "sql" >}}
 
     ```sql
-    insert into `tab_tidb` values (1,'TiDB',5,'TiDB-v4.0.0');
+    insert into `tab_tidb` values (1,'TiDB',5,'TiDB-v5.0.0');
     ```
 
     预期输出
@@ -169,7 +169,7 @@ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
     +----+------+-----+-------------+
     | id | name | age | version     |
     +----+------+-----+-------------+
-    |  1 | TiDB |   5 | TiDB-v4.0.0 |
+    |  1 | TiDB |   5 | TiDB-v5.0.0 |
     +----+------+-----+-------------+
     1 row in set (0.00 sec)
     ```

diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -67,12 +67,12 @@ title: TiDB 数据库快速上手指南
         To view the dashboard: http://127.0.0.1:2379/dashboard
         To view the monitor: http://127.0.0.1:9090
         ```
-        
+
         > **注意：**
         >
         > 以这种方式执行的 playground，在运行结束后 TiUP 会清理掉原集群数据，重新执行该命令后会得到一个全新的集群。
         > 若希望持久化数据，可以执行 TiUP 的 `--tag` 参数：`tiup --tag <your-tag> playground ...`，详情参考 [TiUP 参考手册](/tiup/tiup-reference.md#-t---tag-string)。
-    
+
 4. 新开启一个 session 以访问 TiDB 数据库。
 
     + 使用 TiUP `client` 连接 TiDB：

diff --git a/scale-tidb-using-tiup.md b/scale-tidb-using-tiup.md
@@ -118,7 +118,7 @@ tiup cluster display <cluster-name>
 | 主机 IP   | 服务   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash   |
-| 10.0.1.4   | TiDB + PD   | 
+| 10.0.1.4   | TiDB + PD   |
 | 10.0.1.5   | **TiDB** + TiKV + Monitor   |
 | 10.0.1.1   | TiKV    |
 | 10.0.1.2   | TiKV    |
@@ -169,13 +169,13 @@ tiup cluster display <cluster-name>
 
 扩容后，集群拓扑结构如下所示：
 
-| 主机 IP   | 服务   | 
+| 主机 IP   | 服务   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash   |
-| 10.0.1.4   | TiDB + PD + **TiFlash**    | 
-| 10.0.1.5   | TiDB+ TiKV + Monitor   | 
-| 10.0.1.1   | TiKV    | 
-| 10.0.1.2   | TiKV    | 
+| 10.0.1.4   | TiDB + PD + **TiFlash**    |
+| 10.0.1.5   | TiDB+ TiKV + Monitor   |
+| 10.0.1.1   | TiKV    |
+| 10.0.1.2   | TiKV    |
 
 ## 扩容 TiCDC 节点
 
@@ -217,13 +217,13 @@ tiup cluster display <cluster-name>
 
 扩容后，集群拓扑结构如下所示：
 
-| 主机 IP   | 服务   | 
+| 主机 IP   | 服务   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash + **TiCDC**  |
-| 10.0.1.4   | TiDB + PD + TiFlash + **TiCDC**  | 
-| 10.0.1.5   | TiDB+ TiKV + Monitor   | 
-| 10.0.1.1   | TiKV    | 
-| 10.0.1.2   | TiKV    | 
+| 10.0.1.4   | TiDB + PD + TiFlash + **TiCDC**  |
+| 10.0.1.5   | TiDB+ TiKV + Monitor   |
+| 10.0.1.1   | TiKV    |
+| 10.0.1.2   | TiKV    |
 
 ## 缩容 TiDB/PD/TiKV 节点
 
@@ -246,7 +246,7 @@ Starting /root/.tiup/components/cluster/v1.3.0/cluster display <cluster-name>
 
 TiDB Cluster: <cluster-name>
 
-TiDB Version: v4.0.0-rc
+TiDB Version: v5.0.0
 
 ID              Role         Host        Ports                            Status  Data Dir                Deploy Dir
 
@@ -307,13 +307,13 @@ tiup cluster display <cluster-name>
 
 调整后，拓扑结构如下：
 
-| Host IP   | Service   | 
+| Host IP   | Service   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash + TiCDC  |
-| 10.0.1.4   | TiDB + PD + TiFlash + TiCDC | 
-| 10.0.1.5   | TiDB + Monitor**（TiKV 已删除）**   | 
-| 10.0.1.1   | TiKV    | 
-| 10.0.1.2   | TiKV    | 
+| 10.0.1.4   | TiDB + PD + TiFlash + TiCDC |
+| 10.0.1.5   | TiDB + Monitor**（TiKV 已删除）**   |
+| 10.0.1.1   | TiKV    |
+| 10.0.1.2   | TiKV    |
 
 ## 缩容 TiFlash 节点
 
@@ -462,13 +462,13 @@ tiup cluster display <cluster-name>
 
 调整后，拓扑结构如下：
 
-| Host IP   | Service   | 
+| Host IP   | Service   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash + TiCDC  |
-| 10.0.1.4   | TiDB + PD + TiCDC **（TiFlash 已删除）**  | 
-| 10.0.1.5   | TiDB + Monitor  | 
-| 10.0.1.1   | TiKV    | 
-| 10.0.1.2   | TiKV    | 
+| 10.0.1.4   | TiDB + PD + TiCDC **（TiFlash 已删除）**  |
+| 10.0.1.5   | TiDB + Monitor  |
+| 10.0.1.1   | TiKV    |
+| 10.0.1.2   | TiKV    |
 
 ## 缩容 TiCDC 节点
 
@@ -494,10 +494,10 @@ tiup cluster display <cluster-name>
 
 调整后，拓扑结构如下：
 
-| Host IP   | Service   | 
+| Host IP   | Service   |
 |:----|:----|
 | 10.0.1.3   | TiDB + TiFlash + TiCDC  |
-| 10.0.1.4   | TiDB + PD + **(TiCDC 已删除）**  | 
-| 10.0.1.5   | TiDB + Monitor  | 
-| 10.0.1.1   | TiKV    | 
-| 10.0.1.2   | TiKV    | 
+| 10.0.1.4   | TiDB + PD + **(TiCDC 已删除）**  |
+| 10.0.1.5   | TiDB + Monitor  |
+| 10.0.1.1   | TiKV    |
+| 10.0.1.2   | TiKV    |
diff --git a/tidb-scheduling.md b/tidb-scheduling.md
@@ -19,7 +19,7 @@ TiKV 集群是 TiDB 数据库的分布式 KV 存储引擎，数据以 Region 为
     * 从节点的恢复时间来看
         * 如果节点只是短暂掉线（重启服务），是否需要进行调度。
         * 如果节点是长时间掉线（磁盘故障，数据全部丢失），如何进行调度。
-    * 假设集群需要每个 Raft Group 有 N 个副本，从单个 Raft Group 的副本个数来看 
+    * 假设集群需要每个 Raft Group 有 N 个副本，从单个 Raft Group 的副本个数来看
         * 副本数量不够（例如节点掉线，失去副本），需要选择适当的机器的进行补充。
         * 副本数量过多（例如掉线的节点又恢复正常，自动加入集群），需要合理的删除多余的副本。
 * 读/写通过 Leader 进行，Leader 的分布只集中在少量几个节点会对集群造成影响。

diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md
@@ -99,14 +99,14 @@ TiUP 默认部署在 amd64 架构上运行的 binary，若目标机器为 arm64
 ```yaml
 global:
   arch: "arm64"           # 让所有机器默认使用 arm64 的 binary
- 
+
 tidb_servers:
   - host: 172.16.5.134
     arch: "amd64"         # 这台机器会使用 amd64 的 binary
   - host: 172.16.5.139
     arch: "arm64"         # 这台机器会使用 arm64 的 binary
   - host: 172.16.5.140    # 没有配置 arch 字段的机器，会使用 global 中的默认值，这个例子中是 arm64
-  
+
 ...
 ```
 
@@ -351,12 +351,12 @@ Global Flags:
   -y, --yes               跳过所有的确认步骤
 ```
 
-例如，把集群升级到 v5.0.0-rc 的命令为：
+例如，把集群升级到 v5.0.0 的命令为：
 
 {{< copyable "shell-regular" >}}
 
 ```bash
-tiup cluster upgrade tidb-test v5.0.0-rc
+tiup cluster upgrade tidb-test v5.0.0
 ```
 
 ## 更新配置

diff --git a/tiup/tiup-component-management.md b/tiup/tiup-component-management.md
@@ -68,12 +68,12 @@ tiup install tidb
 tiup install tidb:nightly
 ```
 
-示例三：使用 TiUP 安装 v3.0.6 版本的 TiKV
+示例三：使用 TiUP 安装 v5.0.0 版本的 TiKV
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup install tikv:v3.0.6
+tiup install tikv:v5.0.0
 ```
 
 ## 升级组件
@@ -126,12 +126,12 @@ Flags:
 
 如果想要多次启动同一个组件并复用之前的工作目录，就可以在启动时用 `--tag` 指定相同的名字。指定 tag 后，在实例终止时就*不会自动删除*工作目录，方便下次启动时复用。
 
-示例一：运行 v3.0.8 版本的 TiDB
+示例一：运行 v5.0.0 版本的 TiDB
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup tidb:v3.0.8
+tiup tidb:v5.0.0
 ```
 
 示例二：指定 tag 运行 TiKV
@@ -217,12 +217,12 @@ component 为要卸载的组件名称，version 为要卸载的版本，这两
 - 若省略版本，加 `--all` 表示卸载该组件所有版本
 - 若版本和组件都省略，则加 `--all` 表示卸载所有组件及其所有版本
 
-示例一：卸载 v3.0.8 版本的 TiDB
+示例一：卸载 v5.0.0 版本的 TiDB
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup uninstall tidb:v3.0.8
+tiup uninstall tidb:v5.0.0
 ```
 
 示例二：卸载所有版本的 TiKV