Skip to content

Commit

Permalink
Bump versions for tiup related content for 5.3.0 (pingcap#6918)
Browse files Browse the repository at this point in the history
  • Loading branch information
shichun-0415 authored Nov 30, 2021
1 parent db29bee commit dbdb168
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 46 deletions.
16 changes: 8 additions & 8 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@ To prepare the TiUP offline component package, manually pack an offline componen

If you want to adjust an existing offline mirror (such as adding a new version of a component), take the following steps:

1. When pulling an offline mirror, you can get an incomplete offline mirror by specifying specific information via parameters, such as the component and version information. For example, you can pull an offline mirror that includes only the offline mirror of TiUP v1.5.2 and TiUP Cluster v1.5.2 by running the following command:
1. When pulling an offline mirror, you can get an incomplete offline mirror by specifying specific information via parameters, such as the component and version information. For example, you can pull an offline mirror that includes only the offline mirror of TiUP v1.7.0 and TiUP Cluster v1.7.0 by running the following command:

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

```bash
tiup mirror clone tiup-custom-mirror-v1.5.2 --tiup v1.5.2 --cluster v1.5.2
tiup mirror clone tiup-custom-mirror-v1.7.0 --tiup v1.7.0 --cluster v1.7.0
```

If you only need the components for a particular platform, you can specify them using the `--os` or `--arch` parameters.
Expand Down Expand Up @@ -174,10 +174,10 @@ To prepare the TiUP offline component package, manually pack an offline componen
{{< copyable "shell-regular" >}}

```bash
tiup mirror merge tiup-custom-mirror-v1.5.2
tiup mirror merge tiup-custom-mirror-v1.7.0
```
5. When the above steps are completed, check the result by running the `tiup list` command. In this document's example, the outputs of both `tiup list tiup` and `tiup list cluster` show that the corresponding components of `v1.5.2` are available.

5. When the above steps are completed, check the result by running the `tiup list` command. In this document's example, the outputs of both `tiup list tiup` and `tiup list cluster` show that the corresponding components of `v1.7.0` are available.
#### Step 2: Deploy the offline TiUP component
Expand Down Expand Up @@ -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.2 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v5.3.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.2.2` as an example.
- You can see the latest supported versions by running `tiup list tidb`. This document takes `v5.3.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.
Expand All @@ -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.2 /home/tidb/.tiup/storage/cluster/clusters/tidb-test /home/tidb/.tiup/storage/cluster/clusters/tidb-test/ssh/id_rsa
tidb-test tidb v5.3.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
Expand Down
8 changes: 4 additions & 4 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.2 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.3.0 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it, such as v5.2.2. `--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.3.0. `--monitor` means that the monitoring component is also deployed.

To view the latest version, run `tiup list tidb`.

Expand Down Expand Up @@ -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.2 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.3.0 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it, such as v5.2.2. `--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.3.0. `--monitor` means that the monitoring component is also deployed.

To view the latest version, run `tiup list tidb`.

Expand Down
4 changes: 2 additions & 2 deletions scale-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,9 @@ 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>
Starting /root/.tiup/components/cluster/v1.7.0/cluster display <cluster-name>
TiDB Cluster: <cluster-name>
TiDB Version: v5.2.2
TiDB Version: v5.3.0
ID Role Host Ports Status Data Dir Deploy Dir
-- ---- ---- ----- ------ -------- ----------
10.0.1.3:8300 cdc 10.0.1.3 8300 Up data/cdc-8300 deploy/cdc-8300
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>`: 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.2`.
- `<version>`: the version number of the TiDB cluster to deploy, such as `v5.3.0`.
- `<topology.yaml>`: the prepared [topology file](/tiup/tiup-cluster-topology-reference.md).

## Options
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 @@ -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.2.
Example 3: Use TiUP to install TiKV v5.3.0.

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

```shell
tiup install tikv:v5.2.2
tiup install tikv:v5.3.0
```

## Upgrade components
Expand Down Expand Up @@ -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.2.
Example 1: Operate TiDB v5.3.0.

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

```shell
tiup tidb:v5.2.2
tiup tidb:v5.3.0
```

Example 2: Specify the tag with which TiKV operates.
Expand Down Expand Up @@ -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.2.2.
Example 1: Uninstall TiDB v5.3.0.

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

```shell
tiup uninstall tidb:v5.2.2
tiup uninstall tidb:v5.3.0
```

Example 2: Uninstall TiKV of all versions.
Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-mirror.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.2` command to clone the v5.2.2 version of the TiDB component.
- Execute the `tiup mirror clone <target-dir> --tidb v5.2.2 --tikv all` command to clone the v5.2.2 version of the TiDB component and all versions of the TiKV component.
- Execute the `tiup mirror clone <target-dir> v5.2.2` command to clone the v5.2.2 version of all components in a cluster.
- Execute the `tiup mirror clone <target-dir> --tidb v5.3.0` command to clone the v5.3.0 version of the TiDB component.
- Execute the `tiup mirror clone <target-dir> --tidb v5.3.0 --tikv all` command to clone the v5.3.0 version of the TiDB component and all versions of the TiKV component.
- Execute the `tiup mirror clone <target-dir> v5.3.0` command to clone the v5.3.0 version of all components in a cluster.

## Usage examples

Expand Down
8 changes: 4 additions & 4 deletions tiup/tiup-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ If you directly execute the `tiup playground` command, TiUP uses the locally ins

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`.
- 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.7.0, then this command works the same as `tiup playground:v1.7.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.2.2, then this command works the same as `tiup playground:v1.5.0 v5.2.2`.
- 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.3.0, then this command works the same as `tiup playground:v1.7.0 v5.3.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).

Expand Down Expand Up @@ -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.2`, and the command is `tiup playground v5.2.2`.
In the command above, `nightly` is the version number of the cluster. Similarly, you can replace `nightly` with `v5.3.0`, and the command is `tiup playground v5.3.0`.

### Start a cluster with monitor

Expand Down Expand Up @@ -103,7 +103,7 @@ By default, only one instance is started for each TiDB, TiKV, and PD component.
{{< copyable "shell-regular" >}}

```shell
tiup playground v3.0.10 --db 3 --pd 3 --kv 3
tiup playground v5.3.0 --db 3 --pd 3 --kv 3
```

## Quickly connect to the TiDB cluster started by playground
Expand Down
37 changes: 19 additions & 18 deletions upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ aliases: ['/docs/dev/upgrade-tidb-using-tiup/','/docs/dev/how-to/upgrade/using-t

This document is targeted for the following upgrade paths:

- 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.
- Upgrade from TiDB 4.0 versions to TiDB 5.3 versions.
- Upgrade from TiDB 5.0 versions to TiDB 5.3 versions.
- Upgrade from TiDB 5.1 versions to TiDB 5.3 versions.
- Upgrade from TiDB 5.2 versions to TiDB 5.3 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.2 or its patch versions is not supported. You need to upgrade your cluster first to v4.0 and then to v5.2.
> If your cluster to be upgraded is v3.1 or an earlier version (v3.0 or v2.1), the direct upgrade to v5.3 or its patch versions is not supported. You need to upgrade your cluster first to v4.0 and then to v5.3.
## 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.2 or its patch versions according to this document.
- To update versions earlier than 3.0 to 5.2:
- 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.3 or its patch versions according to this document.
- To update versions earlier than 3.0 to 5.3:
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.2 according to this document.
4. Upgrade the cluster to v5.3 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.

Expand All @@ -46,7 +47,7 @@ Before upgrading your TiDB cluster, you first need to upgrade TiUP or TiUP mirro
>
> If the control machine of the cluster to upgrade cannot access `https://tiup-mirrors.pingcap.com`, skip this section and see [Upgrade TiUP offline mirror](#upgrade-tiup-offline-mirror).
1. Upgrade the TiUP version. It is recommended that the TiUP version is `1.5.0` or later.
1. Upgrade the TiUP version. It is recommended that the TiUP version is `1.7.0` or later.

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

Expand All @@ -55,7 +56,7 @@ Before upgrading your TiDB cluster, you first need to upgrade TiUP or TiUP mirro
tiup --version
```

2. Upgrade the TiUP Cluster version. It is recommended that the TiUP Cluster version is `1.5.0` or later.
2. Upgrade the TiUP Cluster version. It is recommended that the TiUP Cluster version is `1.7.0` or later.

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

Expand Down Expand Up @@ -97,7 +98,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.2's default parameter values for the unmodified configuration items.
> + After the upgrade, you want to use v5.3's default parameter values for the unmodified configuration items.
1. Enter the `vi` editing mode to edit the topology file:
Expand All @@ -113,9 +114,9 @@ Now, the offline mirror has been upgraded successfully. If an error occurs durin
> **Note:**
>
> 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).
> Before you upgrade the cluster to v5.3, make sure that the parameters you have modified in v4.0 are compatible in v5.3. For details, see [TiKV Configuration File](/tikv-configuration-file.md).
>
> 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`:
> The following three TiKV parameters are obsolete in TiDB v5.3. 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
Expand Down Expand Up @@ -156,12 +157,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.2:
For example, if you want to upgrade the cluster to v5.3.0:
{{< copyable "shell-regular" >}}
```shell
tiup cluster upgrade <cluster-name> v5.2.2
tiup cluster upgrade <cluster-name> v5.3.0
```
> **Note:**
Expand Down Expand Up @@ -211,7 +212,7 @@ tiup cluster display <cluster-name>
```
Cluster type: tidb
Cluster name: <cluster-name>
Cluster version: v5.2.2
Cluster version: v5.3.0
```
> **Note:**
Expand Down Expand Up @@ -261,10 +262,10 @@ You can upgrade the tool version by using TiUP to install the `ctl` component of
{{< copyable "shell-regular" >}}
```shell
tiup install ctl:v5.2.2
tiup install ctl:v5.3.0
```
## TiDB 5.2 compatibility changes
## TiDB 5.3 compatibility changes
- See TiDB 5.2 Release Notes for the compatibility changes.
- See TiDB 5.3 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.

0 comments on commit dbdb168

Please sign in to comment.