release-notes: add 5.2.1 release notes (#6438)

pingcap · Sep 9, 2021 · 055dbf2 · 055dbf2
1 parent bea12de
commit 055dbf2
Show file tree

Hide file tree

Showing 16 changed files with 59 additions and 34 deletions.
diff --git a/TOC.md b/TOC.md
@@ -556,6 +556,7 @@
 + Release Notes
   + [All Releases](/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)

diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md
@@ -18,7 +18,7 @@ If you want to download the latest version of [TiDB Binlog](/tidb-binlog/tidb-bi
 
 > **Note:**
 >
-> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v5.2.0` is `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`.
+> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v5.2.1` is `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`.
 
 ## TiDB Lightning
 
@@ -30,7 +30,7 @@ Download [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) by using t
 
 > **Note:**
 >
-> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v5.2.0` is `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`.
+> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v5.2.1` is `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`.
 
 ## BR (backup and restore)
 
@@ -42,7 +42,7 @@ Download [BR](/br/backup-and-restore-tool.md) by using the download link in the
 
 > **Note:**
 >
-> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v5.0.0-beta` is `http://download.pingcap.org/tidb-toolkit-v5.0.0-beta-linux-amd64.tar.gz`.
+> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v5.2.1` is `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`.
 
 ## TiDB DM (Data Migration)
 
@@ -66,7 +66,7 @@ Download [Dumpling](/dumpling-overview.md) from the links below:
 
 > **Note:**
 >
-> The `{version}` in the download link is the version number of Dumpling. For example, the link for downloading the `v5.2.0` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`. You can view the currently released versions in [Dumpling Releases](https://github.com/pingcap/dumpling/releases).
+> The `{version}` in the download link is the version number of Dumpling. For example, the link for downloading the `v5.2.1` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v5.2.1-linux-amd64.tar.gz`. You can view the currently released versions in [Dumpling Releases](https://github.com/pingcap/dumpling/releases).
 >
 > Dumpling supports arm64 linux. You can replace `amd64` in the download link with `arm64`, which means the `arm64` version of Dumpling.
 

diff --git a/pd-control.md b/pd-control.md
@@ -28,7 +28,7 @@ If you want to download the latest version of `pd-ctl`, directly download the Ti
 
 > **Note:**
 >
-> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.2.0`, the package download link is `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`.
+> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.2.1`, the package download link is `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`.
 
 ### Compile from source code
 
@@ -179,7 +179,7 @@ Usage:
 }
 
 >> config show cluster-version                // Display the current version of the cluster, which is the current minimum version of TiKV nodes in the cluster and does not correspond to the binary version.
-"5.2.0"
+"5.2.1"
 ```
 
 - `max-snapshot-count` controls the maximum number of snapshots that a single store receives or sends out at the same time. The scheduler is restricted by this configuration to avoid taking up normal application resources. When you need to improve the speed of adding replicas or balancing, increase this value.

diff --git a/pd-recover.md b/pd-recover.md
@@ -27,7 +27,7 @@ To download the latest version of PD Recover, directly download the TiDB package
 
 > **Note:**
 >
-> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.2.0`, the package download link is `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`.
+> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v5.2.1`, the package download link is `https://download.pingcap.org/tidb-v5.2.1-linux-amd64.tar.gz`.
 
 ## Quick Start
 

diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -306,13 +306,13 @@ Then execute the `deploy` command to deploy the TiDB cluster:
 {{< 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]
 ```
 
 In the above command:
 
 - The name of the deployed TiDB cluster is `tidb-test`.
-- You can see the latest supported versions by running `tiup list tidb`. This document takes `v5.2.0` as an example.
+- You can see the latest supported versions by running `tiup list tidb`. This document takes `v5.2.1` as an example.
 - The initialization configuration file is `topology.yaml`.
 - `--user root`: Log in to the target machine through the `root` key to complete the cluster deployment, or you can use other users with `ssh` and `sudo` privileges to complete the deployment.
 - `[-i]` and `[-p]`: optional. If you have configured login to the target machine without password, these parameters are not required. If not, choose one of the two parameters. `[-i]` is the private key of the `root` user (or other users specified by `--user`) that has access to the target machine. `[-p]` is used to input the user password interactively.
@@ -334,7 +334,7 @@ TiUP supports managing multiple TiDB clusters. The command above outputs informa
 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
 ```
 
 ## Step 6: Check the status of the deployed TiDB cluster

diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -58,10 +58,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         {{< 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
         ```
 
-        The command downloads a version cluster to the local machine and starts it, such as v5.2.0. `--monitor` means that the monitoring component is also deployed.
+        The command downloads a version cluster to the local machine and starts it, such as v5.2.1. `--monitor` means that the monitoring component is also deployed.
 
         To view the latest version, run `tiup list tidb`.
 
@@ -77,7 +77,7 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
 
         > **Note:**
         >
-        > + Since v5.2.0, TiDB supports running `tiup playground` on the machine that uses the Apple M1 chip.
+        > + Since v5.2.1, TiDB supports running `tiup playground` on the machine that uses the Apple M1 chip.
         > + For the playground operated in this way, after the test deployment is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command.
         > + If you want the data to be persisted on storage，run `tiup --tag <your-tag> playground ...`. For details, refer to [TiUP Reference Guide](/tiup/tiup-reference.md#-t---tag).
 
@@ -164,10 +164,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
         {{< 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
         ```
 
-        The command downloads a version cluster to the local machine and starts it, such as v5.2.0. `--monitor` means that the monitoring component is also deployed.
+        The command downloads a version cluster to the local machine and starts it, such as v5.2.1. `--monitor` means that the monitoring component is also deployed.
 
         To view the latest version, run `tiup list tidb`.
 

diff --git a/releases/release-5.2.0.md b/releases/release-5.2.0.md
@@ -8,6 +8,10 @@ Release date: August 27, 2021
 
 TiDB version: 5.2.0
 
+> **Warning:**
+>
+> Some known issues are found in this version, and these issues are fixed in new versions. It is recommended that you use the latest 5.2.x version.
+
 In v5.2, the key new features and improvements are as follows:
 
 - Support using several functions in expression indexes to greatly improve query performance

diff --git a/releases/release-5.2.1.md b/releases/release-5.2.1.md
@@ -0,0 +1,19 @@
+---
+title: TiDB 5.2.1 Release Notes
+---
+
+# TiDB 5.2.1 Release Notes
+
+Release date: September 9, 2021
+
+TiDB version: 5.2.1
+
+## Bug fixes
+
++ TiDB
+
+    - Fix an error that occurs during execution caused by the wrong execution plan. The wrong execution plan is caused by the shallow copy of schema columns when pushing down the aggregation operators on partitioned tables. [#27797](https://github.com/pingcap/tidb/issues/27797) [#26554](https://github.com/pingcap/tidb/issues/26554)
+
++ TiKV
+
+    - Fix the issue of unavailable TiKV caused by Raftstore deadlock when migrating Regions. The workaround is to disable the scheduling and restart the unavailable TiKV. [#10909](https://github.com/tikv/tikv/issues/10909)
diff --git a/releases/release-notes.md b/releases/release-notes.md
@@ -7,6 +7,7 @@ aliases: ['/docs/dev/releases/release-notes/','/docs/dev/releases/rn/']
 
 ## 5.2
 
+- [5.2.1](/releases/release-5.2.1.md)
 - [5.2.0](/releases/release-5.2.0.md)
 
 ## 5.1

diff --git a/scale-tidb-using-tiup.md b/scale-tidb-using-tiup.md
@@ -262,7 +262,7 @@ If you want to remove a TiKV node from the `10.0.1.5` host, take the following s
     ```
     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
     --              ----         ----        -----                            ------  --------                ----------
     10.0.1.3:8300   cdc          10.0.1.3    8300                             Up      -                       deploy/cdc-8300

diff --git a/ticdc/manage-ticdc.md b/ticdc/manage-ticdc.md
@@ -12,14 +12,14 @@ You can also use the HTTP interface (the TiCDC OpenAPI feature) to manage the Ti
 
 ## Upgrade TiCDC using TiUP
 
-This section introduces how to upgrade the TiCDC cluster using TiUP. In the following example, assume that you need to upgrade TiCDC and the entire TiDB cluster to v5.2.0.
+This section introduces how to upgrade the TiCDC cluster using TiUP. In the following example, assume that you need to upgrade TiCDC and the entire TiDB cluster to 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
 ```
 
 ### Notes for upgrade

diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md
@@ -13,7 +13,7 @@ tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
 ```
 
 - `<cluster-name>`: the name of the new cluster, which cannot be the same as the existing cluster names.
-- `<version>`: the version number of the TiDB cluster to deploy, such as `v5.2.0`.
+- `<version>`: the version number of the TiDB cluster to deploy, such as `v5.2.1`.
 - `<topology.yaml>`: the prepared [topology file](/tiup/tiup-cluster-topology-reference.md).
 
 ## Options

diff --git a/tiup/tiup-component-management.md b/tiup/tiup-component-management.md
@@ -70,12 +70,12 @@ Example 2: Use TiUP to install the nightly version of TiDB.
 tiup install tidb:nightly
 ```
 
-Example 3: Use TiUP to install TiKV v5.2.0.
+Example 3: Use TiUP to install TiKV v5.2.1.
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup install tikv:v5.2.0
+tiup install tikv:v5.2.1
 ```
 
 ## Upgrade components
@@ -128,12 +128,12 @@ Before the component is started, TiUP creates a directory for it, and then puts
 
 If you want to start the same component multiple times and reuse the previous working directory, you can use `--tag` to specify the same name when the component is started. After the tag is specified, the working directory will *not be automatically deleted* when the instance is terminated, which makes it convenient to reuse the working directory.
 
-Example 1: Operate TiDB v5.2.0.
+Example 1: Operate TiDB v5.2.1.
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup tidb:v5.2.0
+tiup tidb:v5.2.1
 ```
 
 Example 2: Specify the tag with which TiKV operates.
@@ -219,12 +219,12 @@ The following flags are supported in this command:
 - If the version is ignored, adding `--all` means to uninstall all versions of this component.
 - If the version and the component are both ignored, adding `--all` means to uninstall all components of all versions.
 
-Example 1: Uninstall TiDB v5.0.0.
+Example 1: Uninstall TiDB v5.2.1.
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup uninstall tidb:v5.0.0
+tiup uninstall tidb:v5.2.1
 ```
 
 Example 2: Uninstall TiKV of all versions.

diff --git a/tiup/tiup-mirror.md b/tiup/tiup-mirror.md
@@ -77,9 +77,9 @@ The `tiup mirror clone` command provides many optional flags (might provide more
 
     If you want to clone only one version (not all versions) of a component, use `--<component>=<version>` to specify this version. For example:
 
-    - Execute the `tiup mirror clone <target-dir> --tidb v5.2.0` command to clone the v5.2.0 version of the TiDB component.
-    - Execute the `tiup mirror clone <target-dir> --tidb v5.2.0 --tikv all` command to clone the v5.2.0 version of the TiDB component and all versions of the TiKV component.
-    - Execute the `tiup mirror clone <target-dir> v5.2.0` command to clone the v5.2.0 version of all components in a cluster.
+    - Execute the `tiup mirror clone <target-dir> --tidb v5.2.1` command to clone the v5.2.1 version of the TiDB component.
+    - Execute the `tiup mirror clone <target-dir> --tidb v5.2.1 --tikv all` command to clone the v5.2.1 version of the TiDB component and all versions of the TiKV component.
+    - Execute the `tiup mirror clone <target-dir> v5.2.1` command to clone the v5.2.1 version of all components in a cluster.
 
 ## Usage examples
 

diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md
@@ -22,7 +22,7 @@ This command actually performs the following operations:
 
 - Because this command does not specify the version of the playground component, TiUP first checks the latest version of the installed playground component. Assume that the latest version is v1.5.0, then this command works the same as `tiup playground:v1.5.0`.
 - If you have not used TiUP playground to install the TiDB, TiKV, and PD components, the playground component installs the latest stable version of these components, and then start these instances.
-- Because this command does not specify the version of the TiDB, PD, and TiKV component, TiUP playground uses the latest version of each component by default. Assume that the latest version is v5.0.0, then this command works the same as `tiup playground:v1.5.0 v5.2.0`.
+- Because this command does not specify the version of the TiDB, PD, and TiKV component, TiUP playground uses the latest version of each component by default. Assume that the latest version is v5.0.0, then this command works the same as `tiup playground:v1.5.0 v5.2.1`.
 - Because this command does not specify the number of each component, TiUP playground, by default, starts a smallest cluster that consists of one TiDB instance, one TiKV instance, and one PD instance.
 - After starting each TiDB component, TiUP playground reminds you that the cluster is successfully started and provides you some useful information, such as how to connect to the TiDB cluster through the MySQL client and how to access the [TiDB Dashboard](/dashboard/dashboard-intro.md).
 
@@ -64,7 +64,7 @@ Flags:
 tiup playground nightly
 ```
 
-In the command above, `nightly` is the version number of the cluster. Similarly, you can replace `nightly` with `v5.2.0`, and the command is `tiup playground v5.2.0`.
+In the command above, `nightly` is the version number of the cluster. Similarly, you can replace `nightly` with `v5.2.1`, and the command is `tiup playground v5.2.1`.
 
 ### Start a cluster with monitor
 

diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md
@@ -156,12 +156,12 @@ If your application has a maintenance window for the database to be stopped for
 tiup cluster upgrade <cluster-name> <version>
 ```
 
-For example, if you want to upgrade the cluster to v5.2.0:
+For example, if you want to upgrade the cluster to v5.2.1:
 
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup cluster upgrade <cluster-name> v5.2.0
+tiup cluster upgrade <cluster-name> v5.2.1
 ```
 
 > **Note:**
@@ -211,7 +211,7 @@ tiup cluster display <cluster-name>
 ```
 Cluster type:       tidb
 Cluster name:       <cluster-name>
-Cluster version:    v5.2.0
+Cluster version:    v5.2.1
 ```
 
 > **Note:**
@@ -261,7 +261,7 @@ You can upgrade the tool version by using TiUP to install the `ctl` component of
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup install ctl:v5.2.0
+tiup install ctl:v5.2.1
 ```
 
 ## TiDB 5.2 compatibility changes
-Original file line number
+Diff line change
@@ Expand Up @@
     ## 5.2
+    - [5.2.1](/releases/release-5.2.1.md)
     - [5.2.0](/releases/release-5.2.0.md)
     ## 5.1
@@ Expand Down @@