Skip to content

Commit

Permalink
releases: add tidb 4.0.13 release notes (#5621) (#5712)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored May 28, 2021
1 parent 1a32139 commit c290fe7
Show file tree
Hide file tree
Showing 13 changed files with 168 additions and 24 deletions.
1 change: 1 addition & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,7 @@
+ Release Notes
+ [All Releases](/releases/release-notes.md)
+ v4.0
+ [4.0.13](/releases/release-4.0.13.md)
+ [4.0.12](/releases/release-4.0.12.md)
+ [4.0.11](/releases/release-4.0.11.md)
+ [4.0.10](/releases/release-4.0.10.md)
Expand Down
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 `v4.0.8` is `https://download.pingcap.org/tidb-v4.0.8-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v4.0.13` is `https://download.pingcap.org/tidb-v4.0.13-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 `v4.0.8` is `https://download.pingcap.org/tidb-toolkit-v4.0.8-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v4.0.13` is `https://download.pingcap.org/tidb-toolkit-v4.0.13-linux-amd64.tar.gz`.
## BR (backup and restore)

Expand All @@ -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 `v4.0.8-beta` is `http://download.pingcap.org/tidb-toolkit-v4.0.8-beta-linux-amd64.tar.gz`.
> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v4.0.13` is `http://download.pingcap.org/tidb-toolkit-v4.0.13-linux-amd64.tar.gz`.
## TiDB DM (Data Migration)

Expand All @@ -54,7 +54,7 @@ Download [DM](https://docs.pingcap.com/tidb-data-migration/v1.0/overview) by usi

> **Note:**
>
> `{version}` in the above download link indicates the version number of DM. For example, the download link for `v1.0.6` is `https://download.pingcap.org/dm-v1.0.6-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.3` is `https://download.pingcap.org/dm-v2.0.3-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.2` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v4.0.2-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 `v4.0.13` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v4.0.13-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 maintain-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ When the cluster is in operation, if you need to modify the parameters of a comp

**Use `.` to represent the hierarchy of the configuration items**.

For more information on the configuration parameters of components, refer to [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/v4.0.0-rc/etc/config-template.toml), and [PD `config.toml.example`](https://github.com/pingcap/pd/blob/v4.0.0-rc/conf/config.toml).
For more information on the configuration parameters of components, refer to [TiDB `config.toml.example`](https://github.com/pingcap/tidb/blob/release-4.0/config/config.toml.example)), [TiKV `config.toml.example`](https://github.com/tikv/tikv/blob/release-4.0/etc/config-template.toml), and [PD `config.toml.example`](https://github.com/tikv/pd/blob/release-4.0/conf/config.toml).

3. Rolling update the configuration and restart the corresponding components by running the `reload` command:

Expand All @@ -125,7 +125,7 @@ When the cluster is in operation, if you need to modify the parameters of a comp

### Example

If you want to set the transaction size limit parameter (`txn-total-size-limit` in the [performance](https://github.com/pingcap/tidb/blob/v4.0.0-rc/config/config.toml.example) module) to `1G` in tidb-server, edit the configuration as follows:
If you want to set the transaction size limit parameter (`txn-total-size-limit` in the [performance](https://github.com/pingcap/tidb/blob/release-4.0/config/config.toml.example) module) to `1G` in tidb-server, edit the configuration as follows:

```
server_configs:
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 `v4.0.0`, the package download link is `https://download.pingcap.org/tidb-v4.0.0-linux-amd64.tar.gz`. You can also download the latest unpublished version by replacing `{version}` with `latest`.
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v4.0.13`, the package download link is `https://download.pingcap.org/tidb-v4.0.13-linux-amd64.tar.gz`. You can also download the latest unpublished version by replacing `{version}` with `latest`.
## Quick Start

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 @@ -134,13 +134,13 @@ The following topology documents provide a cluster configuration template for ea
{{< copyable "shell-regular" >}}
```shell
tiup cluster deploy tidb-test v4.0.0 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v4.0.13 ./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`.
- The version of the TiDB cluster is `v4.0.0`. You can see other supported versions by running `tiup list tidb`.
- The version of the TiDB cluster is `v4.0.13`. You can see other supported versions by running `tiup list tidb`.
- 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 @@ -162,7 +162,7 @@ TiUP supports managing multiple TiDB clusters. The command above outputs informa
Starting /home/tidb/.tiup/components/cluster/v1.0.0/cluster list
Name User Version Path PrivateKey
---- ---- ------- ---- ----------
tidb-test tidb v4.0.0 /home/tidb/.tiup/storage/cluster/clusters/tidb-test /home/tidb/.tiup/storage/cluster/clusters/tidb-test/ssh/id_rsa
tidb-test tidb v4.0.13 /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
4 changes: 2 additions & 2 deletions production-offline-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,14 +239,14 @@ Execute the following command to deploy the TiDB cluster:
{{< copyable "shell-regular" >}}

```bash
tiup cluster deploy tidb-test v4.0.0 topology.yaml --user tidb [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v4.0.13 topology.yaml --user tidb [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster start tidb-test
```

> **Parameter description:**
>
> - The name of the cluster deployed by the TiUP cluster is `tidb-test`.
> - The deployment version is `v4.0.0`. To obtain other supported versions, run `tiup list tidb`.
> - The deployment version is `v4.0.13`. To obtain other supported versions, run `tiup list tidb`.
> - The initialization configuration file is `topology.yaml`.
> - `–user tidb`: log in to the target machine using the `tidb` user account to complete the cluster deployment. The `tidb` user needs to have `ssh` and `sudo` privileges of the target machine. 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 Down
4 changes: 2 additions & 2 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
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 v4.0.11 --db 2 --pd 3 --kv 3 --monitor
tiup playground v4.0.13 --db 2 --pd 3 --kv 3 --monitor
```

The command downloads a version cluster to the local machine and starts it,such as v4.0.11. `--monitor` means that the monitoring component is also deployed.
The command downloads a version cluster to the local machine and starts it,such as v4.0.13. `--monitor` means that the monitoring component is also deployed.

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

Expand Down
Loading

0 comments on commit c290fe7

Please sign in to comment.