Skip to content

Commit

Permalink
Bump version for v5.1.0 (pingcap#5849)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomShawn authored Jun 24, 2021
1 parent 639194e commit c2d573b
Show file tree
Hide file tree
Showing 13 changed files with 34 additions and 34 deletions.
10 changes: 5 additions & 5 deletions download-ecosystem-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.0` is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
> `{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`.
## TiDB Lightning

Expand All @@ -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.0.0` is `https://download.pingcap.org/tidb-toolkit-v5.0.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.1.0` is `https://download.pingcap.org/tidb-toolkit-v5.1.0-linux-amd64.tar.gz`.
## BR (backup and restore)

Expand All @@ -46,15 +46,15 @@ Download [BR](/br/backup-and-restore-tool.md) by using the download link in the
## TiDB DM (Data Migration)

Download [DM](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) by using the download link in the following table:
Download [DM](https://docs.pingcap.com/tidb-data-migration/stable/overview) by using the download link in the following table:

| Package name | OS | Architecture | SHA256 checksum |
|:---|:---|:---|:---|
| `https://download.pingcap.org/dm-{version}-linux-amd64.tar.gz` | Linux | amd64 | `https://download.pingcap.org/dm-{version}-linux-amd64.sha256` |

> **Note:**
>
> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v2.0.1` is `https://download.pingcap.org/dm-v2.0.1-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.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.
## Dumpling

Expand All @@ -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 `v4.0.11` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v4.0.11-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.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).
>
> Dumpling supports arm64 linux. You can replace `amd64` in the download link with `arm64`, which means the `arm64` version of Dumpling.
Expand Down
4 changes: 2 additions & 2 deletions pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.0`, the package download link is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
> `{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`.
### Compile from source code

Expand Down Expand Up @@ -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.0.0"
"5.1.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.
Expand Down
2 changes: 1 addition & 1 deletion pd-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0.0`, the package download link is `https://download.pingcap.org/tidb-v5.0.0-linux-amd64.tar.gz`.
> `{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`.
## Quick Start

Expand Down
8 changes: 4 additions & 4 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,13 +260,13 @@ Then execute the `deploy` command to deploy the TiDB cluster:
{{< copyable "shell-regular" >}}
```shell
tiup cluster deploy tidb-test v5.0.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v5.1.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.0.0` as an example.
- You can see the latest supported versions by running `tiup list tidb`. This document takes `v5.1.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 @@ -285,10 +285,10 @@ tiup cluster list
TiUP supports managing multiple TiDB clusters. The command above outputs information of all the clusters currently managed by TiUP, including the name, deployment user, version, and secret key information:
```log
Starting /home/tidb/.tiup/components/cluster/v1.3.0/cluster list
Starting /home/tidb/.tiup/components/cluster/v1.5.0/cluster list
Name User Version Path PrivateKey
---- ---- ------- ---- ----------
tidb-test tidb v5.0.0 /home/tidb/.tiup/storage/cluster/clusters/tidb-test /home/tidb/.tiup/storage/cluster/clusters/tidb-test/ssh/id_rsa
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
```
## 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 @@ -56,10 +56,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.0.1 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.1.0 --db 2 --pd 3 --kv 3 --monitor
```

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

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

Expand Down Expand Up @@ -161,10 +161,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
{{< copyable "shell-regular" >}}

```shell
tiup playground v5.0.1 --db 2 --pd 3 --kv 3 --monitor
tiup playground v5.1.0 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it, such as v5.0.1. `--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.1.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 @@ -256,9 +256,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.3.0/cluster display <cluster-name>
Starting /root/.tiup/components/cluster/v1.5.0/cluster display <cluster-name>
TiDB Cluster: <cluster-name>
TiDB Version: v5.0.0
TiDB Version: v5.1.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
Expand Down
4 changes: 2 additions & 2 deletions ticdc/manage-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ This document describes how to manage the TiCDC cluster and replication tasks us

## 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 v4.0.6.
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.

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

```shell
tiup update --self && \
tiup update --all && \
tiup cluster upgrade <cluster-name> v4.0.6
tiup cluster upgrade <cluster-name> v5.1.0
```

### Notes for upgrade
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tiup bench
```

```
Starting component `bench`: /home/tidb/.tiup/components/bench/v1.3.0/bench
Starting component `bench`: /home/tidb/.tiup/components/bench/v1.5.0/bench
Benchmark database with different workloads
Usage:
Expand Down
4 changes: 2 additions & 2 deletions tiup/tiup-command-mirror-rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ TiUP uses the command `tiup mirror rotate` to automate the above process.

> **Note:**
>
> + For TiUP versions earlier than v1.3.0, running this command does not returns a correct new `root.json` file. See [#983](https://github.com/pingcap/tiup/issues/983).
> + Before using this command, make sure that all TiUP clients are upgraded to v1.3.0 or a later version.
> + For TiUP versions earlier than v1.5.0, running this command does not returns a correct new `root.json` file. See [#983](https://github.com/pingcap/tiup/issues/983).
> + Before using this command, make sure that all TiUP clients are upgraded to v1.5.0 or a later version.
## Syntax

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 `v4.0.9`.
- `<version>`: the version number of the TiDB cluster to deploy, such as `v5.1.0`.
- `<topology.yaml>`: the prepared [topology file](/tiup/tiup-cluster-topology-reference.md).

## Options
Expand Down
8 changes: 4 additions & 4 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.0.0.
Example 3: Use TiUP to install TiKV v5.1.0.

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

```shell
tiup install tikv:v5.0.0
tiup install tikv:v5.1.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.0.0.
Example 1: Operate TiDB v5.1.0.

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

```shell
tiup tidb:v5.0.0
tiup tidb:v5.1.0
```

Example 2: Specify the tag with which TiKV operates.
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.0.0` command to clone the v5.0.0 version of the TiDB component.
- Execute the `tiup mirror clone <target-dir> --tidb v5.0.0 --tikv all` command to clone the v5.0.0 version of the TiDB component and all versions of the TiKV component.
- Execute the `tiup mirror clone <target-dir> v5.0.0` command to clone the v5.0.0 version of all components in a cluster.
- Execute the `tiup mirror clone <target-dir> --tidb v5.1.0` command to clone the v5.1.0 version of the TiDB component.
- Execute the `tiup mirror clone <target-dir> --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 <target-dir> v5.1.0` command to clone the v5.1.0 version of all components in a cluster.

## Usage examples

Expand Down
6 changes: 3 additions & 3 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.3.0, then this command works the same as `tiup playground:v1.3.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.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.3.0 v5.0.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.1.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.0.0`, and the command is `tiup playground v5.0.0`.
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`.

### Start a cluster with monitor

Expand Down

0 comments on commit c2d573b

Please sign in to comment.