From 72f43b370ce824e12852ee806dbf54d9898de664 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Fri, 20 Aug 2021 11:21:11 +0800 Subject: [PATCH] Bump version for v5.2.0 --- download-ecosystem-tools.md | 8 +++---- pd-control.md | 4 ++-- pd-recover.md | 2 +- production-deployment-using-tiup.md | 6 ++--- scale-tidb-using-tiup.md | 2 +- ticdc/manage-ticdc.md | 4 ++-- tiup/tiup-component-cluster-deploy.md | 2 +- tiup/tiup-component-management.md | 8 +++---- tiup/tiup-mirror.md | 6 ++--- tiup/tiup-playground.md | 4 ++-- upgrade-tidb-using-tiup.md | 33 ++++++++++++++------------- 11 files changed, 40 insertions(+), 39 deletions(-) diff --git a/download-ecosystem-tools.md b/download-ecosystem-tools.md index 845c225c29c2d..7c13bbdea89d2 100644 --- a/download-ecosystem-tools.md +++ b/download-ecosystem-tools.md @@ -17,7 +17,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.1.0` is `https://download.pingcap.org/tidb-v5.1.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.0` is `https://download.pingcap.org/tidb-v5.2.0-linux-amd64.tar.gz`. ## TiDB Lightning @@ -29,7 +29,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.1.0` is `https://download.pingcap.org/tidb-toolkit-v5.1.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.0` is `https://download.pingcap.org/tidb-toolkit-v5.2.0-linux-amd64.tar.gz`. ## BR (backup and restore) @@ -53,7 +53,7 @@ Download [DM](https://docs.pingcap.com/tidb-data-migration/stable/overview) by u > **Note:** > -> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v2.0.4` is `https://download.pingcap.org/dm-v2.0.4-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/dm/releases) page. +> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v2.0.6` is `https://download.pingcap.org/dm-v2.0.6-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/dm/releases) page. ## Dumpling @@ -65,7 +65,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.1.0` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v5.1.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.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). > > 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 index 2b478cf15c50c..57756e38a7a4b 100644 --- a/pd-control.md +++ b/pd-control.md @@ -27,7 +27,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.1.0`, the package download link is `https://download.pingcap.org/tidb-v5.1.0-linux-amd64.tar.gz`. +> `{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`. ### Compile from source code @@ -178,7 +178,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.1.0" +"5.2.0" ``` - `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 index 54b7113a12880..8163771707c38 100644 --- a/pd-recover.md +++ b/pd-recover.md @@ -26,7 +26,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.1.0`, the package download link is `https://download.pingcap.org/tidb-v5.1.0-linux-amd64.tar.gz`. +> `{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`. ## Quick Start diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md index a0ebaa5b12f59..771cd4b10b7b2 100644 --- a/production-deployment-using-tiup.md +++ b/production-deployment-using-tiup.md @@ -259,13 +259,13 @@ Then execute the `deploy` command to deploy the TiDB cluster: {{< copyable "shell-regular" >}} ```shell -tiup cluster deploy tidb-test v5.1.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa] +tiup cluster deploy tidb-test v5.2.0 ./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.1.0` as an example. +- You can see the latest supported versions by running `tiup list tidb`. This document takes `v5.2.0` 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. @@ -287,7 +287,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.1.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.0 /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/scale-tidb-using-tiup.md b/scale-tidb-using-tiup.md index bf6c1eda0fa04..280b09dcbc52e 100644 --- a/scale-tidb-using-tiup.md +++ b/scale-tidb-using-tiup.md @@ -261,7 +261,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 TiDB Cluster: - TiDB Version: v5.1.0 + TiDB Version: v5.2.0 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 index 484c2ccdc8bb8..818b96eb3b45c 100644 --- a/ticdc/manage-ticdc.md +++ b/ticdc/manage-ticdc.md @@ -11,14 +11,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.1.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.0. {{< copyable "shell-regular" >}} ```shell tiup update --self && \ tiup update --all && \ -tiup cluster upgrade v5.1.0 +tiup cluster upgrade v5.2.0 ``` ### Notes for upgrade diff --git a/tiup/tiup-component-cluster-deploy.md b/tiup/tiup-component-cluster-deploy.md index 19eb1bd01c347..32b67a54bfe43 100644 --- a/tiup/tiup-component-cluster-deploy.md +++ b/tiup/tiup-component-cluster-deploy.md @@ -13,7 +13,7 @@ tiup cluster deploy [flags] ``` - ``: the name of the new cluster, which cannot be the same as the existing cluster names. -- ``: the version number of the TiDB cluster to deploy, such as `v5.1.0`. +- ``: the version number of the TiDB cluster to deploy, such as `v5.2.0`. - ``: 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 index 18c599da01568..ea48aa9e3a234 100644 --- a/tiup/tiup-component-management.md +++ b/tiup/tiup-component-management.md @@ -69,12 +69,12 @@ Example 2: Use TiUP to install the nightly version of TiDB. tiup install tidb:nightly ``` -Example 3: Use TiUP to install TiKV v5.1.0. +Example 3: Use TiUP to install TiKV v5.2.0. {{< copyable "shell-regular" >}} ```shell -tiup install tikv:v5.1.0 +tiup install tikv:v5.2.0 ``` ## Upgrade components @@ -127,12 +127,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.1.0. +Example 1: Operate TiDB v5.2.0. {{< copyable "shell-regular" >}} ```shell -tiup tidb:v5.1.0 +tiup tidb:v5.2.0 ``` Example 2: Specify the tag with which TiKV operates. diff --git a/tiup/tiup-mirror.md b/tiup/tiup-mirror.md index bff31265ae2fa..f7170ec10f571 100644 --- a/tiup/tiup-mirror.md +++ b/tiup/tiup-mirror.md @@ -76,9 +76,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 `--=` to specify this version. For example: - - Execute the `tiup mirror clone --tidb v5.1.0` command to clone the v5.1.0 version of the TiDB component. - - Execute the `tiup mirror clone --tidb v5.1.0 --tikv all` command to clone the v5.1.0 version of the TiDB component and all versions of the TiKV component. - - Execute the `tiup mirror clone v5.1.0` command to clone the v5.1.0 version of all components in a cluster. + - Execute the `tiup mirror clone --tidb v5.2.0` command to clone the v5.2.0 version of the TiDB component. + - Execute the `tiup mirror clone --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 v5.2.0` command to clone the v5.2.0 version of all components in a cluster. ## Usage examples diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md index acb858c8d76e4..f2fdd5197f6ba 100644 --- a/tiup/tiup-playground.md +++ b/tiup/tiup-playground.md @@ -21,7 +21,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.1.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.0`. - 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). @@ -63,7 +63,7 @@ Flags: tiup playground nightly ``` -In the command above, `nightly` is the version number of the cluster. Similarly, you can replace `nightly` with `v5.1.0`, and the command is `tiup playground v5.1.0`. +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`. ### Start a cluster with monitor diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index fbec3e73ef592..bb9dc6884fef5 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -7,22 +7,23 @@ summary: Learn how to upgrade TiDB using TiUP. This document is targeted for the following upgrade paths: -- Upgrade from TiDB 4.0 versions to TiDB 5.1 versions. -- Upgrade from TiDB 5.0 versions to TiDB 5.1 versions. +- Upgrade from TiDB 4.0 versions to TiDB 5.2 versions. +- Upgrade from TiDB 5.0 versions to TiDB 5.2 versions. +- Upgrade from TiDB 5.2 versions to TiDB 5.2 versions. > **Note:** > -> If your cluster to be upgraded is v3.1 or an earlier version (v3.0 or v2.1), the direct upgrade to v5.1 or its patch versions is not supported. You need to upgrade your cluster first to v4.0 and then to v5.1. +> If your cluster to be upgraded is v3.1 or an earlier version (v3.0 or v2.1), the direct upgrade to v5.2 or its patch versions is not supported. You need to upgrade your cluster first to v4.0 and then to v5.2. ## Upgrade caveat - TiDB currently does not support version downgrade or rolling back to an earlier version after the upgrade. -- For the v4.0 cluster managed using TiDB Ansible, you need to import the cluster to TiUP (`tiup cluster`) for new management according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup). Then you can upgrade the cluster to v5.1 or its patch versions according to this document. -- To update versions earlier than 3.0 to 5.1: +- For the v4.0 cluster managed using TiDB Ansible, you need to import the cluster to TiUP (`tiup cluster`) for new management according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup). Then you can upgrade the cluster to v5.2 or its patch versions according to this document. +- To update versions earlier than 3.0 to 5.2: 1. Update this version to 3.0 using [TiDB Ansible](https://docs.pingcap.com/tidb/v3.0/upgrade-tidb-using-ansible). 2. Use TiUP (`tiup cluster`) to import the TiDB Ansible configuration. 3. Update the 3.0 version to 4.0 according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup). - 4. Upgrade the cluster to v5.1 according to this document. + 4. Upgrade the cluster to v5.2 according to this document. - Support upgrading the versions of TiDB Binlog, TiCDC, TiFlash, and other components. - For detailed compatibility changes of different versions, see the [Release Notes](/releases/release-notes.md) of each version. Modify your cluster configuration according to the "Compatibility Changes" section of the corresponding release notes. @@ -95,7 +96,7 @@ Now, the offline mirror has been upgraded successfully. If an error occurs durin > Skip this step if one of the following situations applies: > > + You have not modified the configuration parameters of the original cluster. Or you have modified the configuration parameters using `tiup cluster` but no more modification is needed. -> + After the upgrade, you want to use v5.1's default parameter values for the unmodified configuration items. +> + After the upgrade, you want to use v5.2's default parameter values for the unmodified configuration items. 1. Enter the `vi` editing mode to edit the topology file: @@ -111,9 +112,9 @@ Now, the offline mirror has been upgraded successfully. If an error occurs durin > **Note:** > -> Before you upgrade the cluster to v5.1, make sure that the parameters you have modified in v4.0 are compatible in v5.1. For details, see [TiKV Configuration File](/tikv-configuration-file.md). +> Before you upgrade the cluster to v5.2, make sure that the parameters you have modified in v4.0 are compatible in v5.2. For details, see [TiKV Configuration File](/tikv-configuration-file.md). > -> The following three TiKV parameters are obsolete in TiDB v5.1. If the following parameters have been configured in your original cluster, you need to delete these parameters through `edit-config`: +> The following three TiKV parameters are obsolete in TiDB v5.2. If the following parameters have been configured in your original cluster, you need to delete these parameters through `edit-config`: > > - pessimistic-txn.enabled > - server.request-batch-enable-cross-command @@ -154,12 +155,12 @@ If your application has a maintenance window for the database to be stopped for tiup cluster upgrade ``` -For example, if you want to upgrade the cluster to v5.1.0: +For example, if you want to upgrade the cluster to v5.2.0: {{< copyable "shell-regular" >}} ```shell -tiup cluster upgrade v5.1.0 +tiup cluster upgrade v5.2.0 ``` > **Note:** @@ -209,7 +210,7 @@ tiup cluster display ``` Cluster type: tidb Cluster name: -Cluster version: v5.1.0 +Cluster version: v5.2.0 ``` > **Note:** @@ -259,10 +260,10 @@ You can upgrade the tool version by using TiUP to install the `ctl` component of {{< copyable "shell-regular" >}} ```shell -tiup install ctl:v5.1.0 +tiup install ctl:v5.2.0 ``` -## TiDB 5.1 compatibility changes +## TiDB 5.2 compatibility changes -- See TiDB 5.1 Release Notes for the compatibility changes. -- Try to avoid creating a new clustered index table when you apply rolling updates to the clusters using TiDB-Binlog. +- See TiDB 5.2 Release Notes for the compatibility changes. +- Try to avoid creating a new clustered index table when you apply rolling updates to the clusters using TiDB Binlog.