Skip to content

Commit

Permalink
release-notes: add 5.2.1 release notes (pingcap#7086)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomShawn authored Sep 9, 2021
1 parent d5b4f8c commit 404bb0f
Show file tree
Hide file tree
Showing 16 changed files with 59 additions and 34 deletions.
1 change: 1 addition & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,7 @@
+ 版本发布历史
+ [发布版本汇总](/releases/release-notes.md)
+ v5.2
- [5.2.1](/releases/release-5.2.1.md)
- [5.2.0](/releases/release-5.2.0.md)
+ v5.1
- [5.1.1](/releases/release-5.1.1.md)
Expand Down
8 changes: 4 additions & 4 deletions download-ecosystem-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools

> **注意:**
>
> 下载链接中的 `{version}` 为 TiDB 的版本号。例如,`v5.2.0` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`
> 下载链接中的 `{version}` 为 TiDB 的版本号。例如,`v5.2.1` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`
## TiDB Lightning

Expand All @@ -29,7 +29,7 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools

> **注意:**
>
> 下载链接中的 `{version}` 为 TiDB Lightning 的版本号。例如,`v5.2.0` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`
> 下载链接中的 `{version}` 为 TiDB Lightning 的版本号。例如,`v5.2.1` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`
## 备份和恢复 (BR) 工具

Expand All @@ -41,7 +41,7 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools

> **注意:**
>
> 下载链接中的 `{version}` 为 BR 的版本号。例如,`v5.2.0` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`
> 下载链接中的 `{version}` 为 BR 的版本号。例如,`v5.2.1` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`
## TiDB DM (Data Migration)

Expand All @@ -65,7 +65,7 @@ aliases: ['/docs-cn/dev/download-ecosystem-tools/','/docs-cn/dev/reference/tools

> **注意:**
>
> - 下载链接中的 `{version}` 为 Dumpling 的版本号。例如,`v5.2.0` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`。可以通过 [Dumpling Release](https://github.com/pingcap/dumpling/releases) 查看当前已发布版本。
> - 下载链接中的 `{version}` 为 Dumpling 的版本号。例如,`v5.2.1` 版本的下载链接为 `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`。可以通过 [Dumpling Release](https://github.com/pingcap/dumpling/releases) 查看当前已发布版本。
> - Dumpling 已支持 arm64 linux,将下载链接中的 amd64 替换为 arm64,即表示 arm64 版 Dumpling。
## sync-diff-inspector
Expand Down
4 changes: 2 additions & 2 deletions pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PD Control 是 PD 的命令行工具,用于获取集群状态信息和调整

> **注意:**
>
> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v5.2.0` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`
> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v5.2.1` 版本的下载链接为 `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`
### 源码编译

Expand Down Expand Up @@ -222,7 +222,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
```

```
"5.2.0"
"5.2.1"
```

- `max-snapshot-count` 控制单个 store 最多同时接收或发送的 snapshot 数量,调度受制于这个配置来防止抢占正常业务的资源。当需要加快补副本或 balance 速度时可以调大这个值。
Expand Down
2 changes: 1 addition & 1 deletion pd-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ PD Recover 包含在 TiDB 安装包中。直接下载 TiDB 安装包即可获取

> **注意:**
>
> `{version}` 是 TiDB 的版本号。例如,`v5.2.0` 的安装包下载链接为 `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`
> `{version}` 是 TiDB 的版本号。例如,`v5.2.1` 的安装包下载链接为 `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`
## 快速开始

Expand Down
6 changes: 3 additions & 3 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,13 +309,13 @@ tiup cluster check ./topology.yaml --apply --user root [-p] [-i /home/root/.ssh/
{{< copyable "shell-regular" >}}

```shell
tiup cluster deploy tidb-test v5.2.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v5.2.1 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
```

以上部署命令中:

- 通过 TiUP cluster 部署的集群名称为 `tidb-test`
- 可以通过执行 `tiup list tidb` 来查看 TiUP 支持的最新可用版本,后续内容以版本 `v5.2.0` 为例
- 可以通过执行 `tiup list tidb` 来查看 TiUP 支持的最新可用版本,后续内容以版本 `v5.2.1` 为例
- 初始化配置文件为 `topology.yaml`
- --user root:通过 root 用户登录到目标主机完成集群部署,该用户需要有 ssh 到目标机器的权限,并且在目标机器有 sudo 权限。也可以用其他有 ssh 和 sudo 权限的用户完成部署。
- [-i] 及 [-p]:非必选项,如果已经配置免密登录目标机,则不需填写。否则选择其一即可,[-i] 为可登录到目标机的 root 用户(或 --user 指定的其他用户)的私钥,也可使用 [-p] 交互式输入该用户的密码
Expand All @@ -337,7 +337,7 @@ TiUP 支持管理多个 TiDB 集群,该命令会输出当前通过 TiUP cluste
Starting /home/tidb/.tiup/components/cluster/v1.5.0/cluster list
Name User Version Path PrivateKey
---- ---- ------- ---- ----------
tidb-test tidb v5.2.0 /home/tidb/.tiup/storage/cluster/clusters/tidb-test /home/tidb/.tiup/storage/cluster/clusters/tidb-test/ssh/id_rsa
tidb-test tidb v5.2.1 /home/tidb/.tiup/storage/cluster/clusters/tidb-test /home/tidb/.tiup/storage/cluster/clusters/tidb-test/ssh/id_rsa
```

## 第 6 步:检查部署的 TiDB 集群情况
Expand Down
10 changes: 5 additions & 5 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.2.0 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.2.1 --db 2 --pd 3 --kv 3 --monitor
```

上述命令会在本地下载并启动某个版本的集群(例如 v5.2.0),`--monitor` 表示同时部署监控组件。最新版本可以通过执行 `tiup list tidb` 来查看。运行结果将显示集群的访问方式:
上述命令会在本地下载并启动某个版本的集群(例如 v5.2.1),`--monitor` 表示同时部署监控组件。最新版本可以通过执行 `tiup list tidb` 来查看。运行结果将显示集群的访问方式:

```log
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
Expand All @@ -72,7 +72,7 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti

> **注意:**
>
> + 支持 v5.2.0 及以上版本的 TiDB 在 Apple M1 芯片的机器上运行 `tiup playground`
> + 支持 v5.2.1 及以上版本的 TiDB 在 Apple M1 芯片的机器上运行 `tiup playground`
> + 以这种方式执行的 playground,在结束部署测试后 TiUP 会清理掉原集群数据,重新执行该命令后会得到一个全新的集群。
> + 若希望持久化数据,可以执行 TiUP 的 `--tag` 参数:`tiup --tag <your-tag> playground ...`,详情参考 [TiUP 参考手册](/tiup/tiup-reference.md#-t---tag-string)。

Expand Down Expand Up @@ -159,10 +159,10 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.2.0 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.2.1 --db 2 --pd 3 --kv 3 --monitor
```

上述命令会在本地下载并启动某个版本的集群(例如 v5.2.0),`--monitor` 表示同时部署监控组件。最新版本可以通过执行 `tiup list tidb` 来查看。运行结果将显示集群的访问方式:
上述命令会在本地下载并启动某个版本的集群(例如 v5.2.1),`--monitor` 表示同时部署监控组件。最新版本可以通过执行 `tiup list tidb` 来查看。运行结果将显示集群的访问方式:

```log
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
Expand Down
4 changes: 4 additions & 0 deletions releases/release-5.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ title: TiDB 5.2 Release Notes

TiDB 版本:5.2.0

> **警告:**
>
> 该版本存在一些已知问题,已在新版本中修复,建议使用 5.2.x 的最新版本。
在 5.2 版本中,你可以获得以下关键特性:

- 支持基于部分函数创建表达式索引 (Expression index),极大提升查询的性能。
Expand Down
19 changes: 19 additions & 0 deletions releases/release-5.2.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: TiDB 5.2.1 Release Notes
---

# TiDB 5.2.1 Release Notes

发版日期:2021 年 9 月 9 日

TiDB 版本:5.2.1

## Bug 修复

+ TiDB

- 修复在分区中下推聚合算子时,因浅拷贝 schema 列导致执行计划出错,进而导致执行时报错的问题 [#27797](https://github.com/pingcap/tidb/issues/27797) [#26554](https://github.com/pingcap/tidb/issues/26554)

+ TiKV

- 修复 Region 迁移时 Raftstore 模块出现死锁导致 TiKV 不可用的问题。用户可通过关闭调度并重启出问题的 TiKV 来临时应对。[#10909](https://github.com/tikv/tikv/issues/10909)
1 change: 1 addition & 0 deletions releases/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ TiDB 历史版本发布声明如下:

## 5.2

- [5.2.1](/releases/release-5.2.1.md)
- [5.2.0](/releases/release-5.2.0.md)

## 5.1
Expand Down
2 changes: 1 addition & 1 deletion scale-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ Starting /root/.tiup/components/cluster/v1.5.0/cluster display <cluster-name> 
TiDB Cluster: <cluster-name>
TiDB Version: v5.2.0
TiDB Version: v5.2.1
ID              Role Host        Ports Status Data Dir                Deploy Dir
Expand Down
4 changes: 2 additions & 2 deletions ticdc/manage-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ aliases: ['/docs-cn/dev/ticdc/manage-ticdc/','/docs-cn/dev/reference/tools/ticdc

## 使用 TiUP 升级 TiCDC

本部分介绍如何使用 TiUP 来升级 TiCDC 集群。在以下例子中,假设需要将 TiCDC 组件和整个 TiDB 集群升级到 v5.2.0
本部分介绍如何使用 TiUP 来升级 TiCDC 集群。在以下例子中,假设需要将 TiCDC 组件和整个 TiDB 集群升级到 v5.2.1

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

```shell
tiup update --self && \
tiup update --all && \
tiup cluster upgrade <cluster-name> v5.2.0
tiup cluster upgrade <cluster-name> v5.2.1
```

### 升级的注意事项
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
```

- `<cluster-name>` 表示新集群的名字,不能和现有集群同名
- `<version>` 为要部署的 TiDB 集群版本号,如 `v5.2.0`
- `<version>` 为要部署的 TiDB 集群版本号,如 `v5.2.1`
- `<topology.yaml>` 为事先编写好的[拓扑文件](/tiup/tiup-cluster-topology-reference.md)

## 选项
Expand Down
12 changes: 6 additions & 6 deletions tiup/tiup-component-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ tiup install tidb
tiup install tidb:nightly
```

示例三:使用 TiUP 安装 v5.2.0 版本的 TiKV
示例三:使用 TiUP 安装 v5.2.1 版本的 TiKV

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

```shell
tiup install tikv:v5.2.0
tiup install tikv:v5.2.1
```

## 升级组件
Expand Down Expand Up @@ -127,12 +127,12 @@ Flags:

如果想要多次启动同一个组件并复用之前的工作目录,就可以在启动时用 `--tag` 指定相同的名字。指定 tag 后,在实例终止时就*不会自动删除*工作目录,方便下次启动时复用。

示例一:运行 v5.2.0 版本的 TiDB
示例一:运行 v5.2.1 版本的 TiDB

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

```shell
tiup tidb:v5.2.0
tiup tidb:v5.2.1
```

示例二:指定 tag 运行 TiKV
Expand Down Expand Up @@ -218,12 +218,12 @@ component 为要卸载的组件名称,version 为要卸载的版本,这两
- 若省略版本,加 `--all` 表示卸载该组件所有版本
- 若版本和组件都省略,则加 `--all` 表示卸载所有组件及其所有版本

示例一:卸载 v5.2.0 版本的 TiDB
示例一:卸载 v5.2.1 版本的 TiDB

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

```shell
tiup uninstall tidb:v5.2.0
tiup uninstall tidb:v5.2.1
```

示例二:卸载所有版本的 TiKV
Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ tiup mirror clone <target-dir> [global-version] [flags]

如果只想克隆某个组件的某一个版本而不是所有版本,则使用 `--<component>=<version>` 来限定,例如:

- 只想克隆 TiDB 的 v5.2.0 版本,则执行 `tiup mirror clone <target-dir> --tidb v5.2.0`
- 只想克隆 TiDB 的 v5.2.0 版本,以及 TiKV 的所有版本,则执行 `tiup mirror clone <target-dir> --tidb v5.2.0 --tikv all`
- 克隆一个集群的所有组件的 v5.2.0 版本,则执行 `tiup mirror clone <target-dir> v5.2.0`
- 只想克隆 TiDB 的 v5.2.1 版本,则执行 `tiup mirror clone <target-dir> --tidb v5.2.1`
- 只想克隆 TiDB 的 v5.2.1 版本,以及 TiKV 的所有版本,则执行 `tiup mirror clone <target-dir> --tidb v5.2.1 --tikv all`
- 克隆一个集群的所有组件的 v5.2.1 版本,则执行 `tiup mirror clone <target-dir> v5.2.1`

## 使用示例

Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tiup playground [version] [flags]

- 因为该命令没有指定 playground 的版本,TiUP 会先查找已安装的 playground 的最新版本,假设已安装的 playground 最新版为 v1.5.0,则该命令相当于 tiup playground:v1.5.0
- 如果 playground 从未安装过任何版本的 TiDB/TiKV/PD 组件,TiUP 会先安装这些组件的最新稳定版,然后再启动运行这些组件的实例
- 因为该命令没有指定 TiDB/PD/TiKV 各组件的版本,默认情况下,它会使用各组件的最新发布版本,假设当前为 v5.2.0,则该命令相当于 tiup playground:1.3.0 v5.2.0
- 因为该命令没有指定 TiDB/PD/TiKV 各组件的版本,默认情况下,它会使用各组件的最新发布版本,假设当前为 v5.2.1,则该命令相当于 tiup playground:1.3.0 v5.2.1
- 因为该命令也没有指定各组件的个数,默认情况下,它会启动由 1 个 TiDB、1 个 TiKV 和 1 个 PD 实例构成的最小化集群
- 在依次启动完各个 TiDB 组件后,playground 会提醒集群启动成功,并告诉你一些有用的信息,譬如如何通过 MySQL 客户端连接集群、如何访问 [TiDB Dashboard](/dashboard/dashboard-intro.md)

Expand Down Expand Up @@ -61,7 +61,7 @@ Flags:
tiup playground nightly
```

nightly 就是这个集群的版本号,类似的可以 `tiup playground v5.2.0` 等。
nightly 就是这个集群的版本号,类似的可以 `tiup playground v5.2.1` 等。

### 启动一个带监控的集群

Expand Down
8 changes: 4 additions & 4 deletions upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,12 @@ tiup cluster check <cluster-name> --cluster
tiup cluster upgrade <cluster-name> <version>
```

以升级到 5.2.0 版本为例:
以升级到 5.2.1 版本为例:

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

```
tiup cluster upgrade <cluster-name> v5.2.0
tiup cluster upgrade <cluster-name> v5.2.1
```
> **注意:**
Expand Down Expand Up @@ -199,7 +199,7 @@ tiup cluster display <cluster-name>
```
Cluster type: tidb
Cluster name: <cluster-name>
Cluster version: v5.2.0
Cluster version: v5.2.1
```

> **注意:**
Expand Down Expand Up @@ -249,7 +249,7 @@ tiup cluster upgrade <cluster-name> <version> --force
{{< copyable "" >}}

```
tiup install ctl:v5.2.0
tiup install ctl:v5.2.1
```
## 5. TiDB 5.2 兼容性变化
Expand Down

0 comments on commit 404bb0f

Please sign in to comment.