Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tool: update the tool downloading links and instructions #8839

Merged
merged 7 commits into from
Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion br/backup-and-restore-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ TiDB supports both [`BACKUP`](/sql-statements/sql-statement-backup.md#backup) an

#### Use the command-line tool

The `br` command-line utility is available as a [separate download](/download-ecosystem-tools.md#br-backup-and-restore). For details, see [Use BR Command-line for Backup and Restoration](/br/use-br-command-line-tool.md).
The `br` command-line utility is available as a [separate download](/download-ecosystem-tools.md). For details, see [Use BR Command-line for Backup and Restoration](/br/use-br-command-line-tool.md).

#### In the Kubernetes environment

Expand Down
2 changes: 1 addition & 1 deletion br/backup-and-restore-use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can estimate the performance of your backup or restoration operation based o

### Deployment method

It is recommended that you deploy the TiDB cluster using [TiUP](/tiup/tiup-cluster.md) and get BR by downloading [TiDB Toolkit](/download-ecosystem-tools.md#br-backup-and-restore).
It is recommended that you deploy the TiDB cluster using [TiUP](/tiup/tiup-cluster.md) and get BR by downloading [TiDB Toolkit](/download-ecosystem-tools.md).

### Cluster versions

Expand Down
14 changes: 2 additions & 12 deletions dm/deploy-a-dm-cluster-using-binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,9 @@ This document introduces how to quickly deploy the Data Migration (DM) cluster u
>
> In the production environment, it is recommended to [use TiUP to deploy a DM cluster](/dm/deploy-a-dm-cluster-using-tiup.md).

## Preparations
## Download DM binary

Download the official binary 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 TiDB. For example, the download link for `v1.0.1` is `https://download.pingcap.org/dm-v1.0.1-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/tiflow/releases) page.

The downloaded files have two subdirectories, `bin` and `conf`. The `bin` directory contains the binary files of DM-master, DM-worker, and dmctl. The `conf` directory contains the sample configuration files.
The DM binary is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

## Sample scenario

Expand Down
2 changes: 1 addition & 1 deletion dm/quick-start-create-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ To run a TiDB server, use the following command:
{{< copyable "shell-regular" >}}

```bash
wget https://download.pingcap.org/tidb-latest-linux-amd64.tar.gz
wget https://download.pingcap.org/tidb-community-server-v6.0.0-linux-amd64.tar.gz
tar -xzvf tidb-latest-linux-amd64.tar.gz
mv tidb-latest-linux-amd64/bin/tidb-server ./
./tidb-server
Expand Down
100 changes: 29 additions & 71 deletions download-ecosystem-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,86 +6,44 @@ aliases: ['/docs/dev/download-ecosystem-tools/','/docs/dev/reference/tools/downl

# Download TiDB Tools

This document collects the available downloads for most officially maintained versions of TiDB tools.
This document describes how to download the TiDB Toolkit.

## TiUP
TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, and backup and restore tool BR.

You can install TiUP with a single command in both Darwin and Linux operating systems. For more information, see [Install TiUP](/tiup/tiup-overview.md#install-tiup).

## TiDB Operator

TiDB Operator runs in Kubernetes. After deploying the Kubernetes cluster, you can choose to deploy TiDB Operator either online or offline. For more information, see [Deploying TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-operator/).

## TiDB Binlog

If you want to download the latest version of [TiDB Binlog](/tidb-binlog/tidb-binlog-overview.md), directly download the TiDB package, because TiDB Binlog is included in the TiDB package.

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

> **Note:**
> **Tip:**
>
> `{version}` in the above download link indicates the version number of TiDB. For example, the download link for `v6.0.0` is `https://download.pingcap.org/tidb-v6.0.0-linux-amd64.tar.gz`.
> - If your deployment environment has internet access, you can deploy a TiDB tool using a single [TiUP command](/tiup/tiup-component-management.md), so there is no need to download the TiDB Toolkit separately.
> - If you need to deploy and maintain TiDB on Kubernetes, instead of downloading the TiDB Toolkit, follow the steps in [TiDB Operator offline installation](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tidb-operator#offline-installation).

## TiDB Lightning
## Environment requirements

Download [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) by using the download link in the following table:
- Operating system: Linux
- Architecture: amd64

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

> **Note:**
>
> `{version}` in the above download link indicates the version number of TiDB Lightning. For example, the download link for `v6.0.0` is `https://download.pingcap.org/tidb-toolkit-v6.0.0-linux-amd64.tar.gz`.

## BR (backup and restore)

Download [BR](/br/backup-and-restore-tool.md) by using the download link in the following table:

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

> **Note:**
>
> `{version}` in the above download link indicates the version number of BR. For example, the download link for `v6.0.0` is `https://download.pingcap.org/tidb-toolkit-v6.0.0-linux-amd64.tar.gz`.

## TiDB DM (Data Migration)

Download [DM](/dm/dm-overview.md) 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 `v6.0.0` is `https://download.pingcap.org/dm-v6.0.0-linux-amd64.tar.gz`. You can check the published DM versions in the [DM Release](https://github.com/pingcap/dm/releases) page.

## Dumpling

Download [Dumpling](/dumpling-overview.md) from the links below:

| Installation package | Operating system | Architecture | SHA256 checksum |
|:---|:---|:---|:---|
| `https://download.pingcap.org/tidb-toolkit-{version}-linux-amd64.tar.gz` | Linux | amd64 | `https://download.pingcap.org/tidb-toolkit-{version}-linux-amd64.sha256` |

> **Note:**
>
> The `{version}` in the download link is the version number of Dumpling. For example, the link for downloading the `v6.0.0` version of Dumpling is `https://download.pingcap.org/tidb-toolkit-v6.0.0-linux-amd64.tar.gz`. You can view the currently released versions in [TiDB Releases](https://github.com/pingcap/tidb/releases).
>
> Dumpling supports arm64 linux. You can replace `amd64` in the download link with `arm64`, which means the `arm64` version of Dumpling.
You can download TiDB Toolkit from the following link:

## sync-diff-inspector
```
https://download.pingcap.org/tidb-community-toolkit-{version}-linux-amd64.tar.gz
```

Download [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) from the links below:
`{version}` in the link indicates the version number of TiDB. For example, the download link for `v6.0.0` is `https://download.pingcap.org/tidb-community-toolkit-v6.0.0-linux-amd64.tar.gz`.

| Package name | OS | Architecture | SHA256 checksum |
|:---|:---|:---|:---|
| [tidb-enterprise-tools-nightly-linux-amd64.tar.gz](https://download.pingcap.org/tidb-enterprise-tools-nightly-linux-amd64.tar.gz) | Linux | amd64 | [tidb-enterprise-tools-nightly-linux-amd64.sha256](https://download.pingcap.org/tidb-enterprise-tools-nightly-linux-amd64.sha256) |
## TiDB Toolkit description

## TiCDC
Depending on which tools you want to use, you can install the corresponding offline packages as follows:

To download [TiCDC](/ticdc/ticdc-overview.md), refer to [Deploy TiCDC](/ticdc/deploy-ticdc.md).
| Tools | Offline Package Name |
qiancai marked this conversation as resolved.
Show resolved Hide resolved
|:------|:----------|
| [TiUP](/tiup/tiup-overview.md) | `tiup-linux-amd64.tar.gz` <br/>`tiup-{tiup-version}-linux-amd64.tar.gz` <br/>`dm-{tiup-version}-linux-amd64.tar.gz` |
| [Dumpling](/dumpling-overview.md) | `dumpling-{version}-linux-amd64.tar.gz` |
| [TiDB Lightning](/tidb-lightning/tidb-lightning-overview.md) | `tidb-lightning-ctl` <br/>`tidb-lightning-{version}-linux-amd64.tar.gz` |
| [TiDB DM (Data Migration)](/dm/dm-overview.md) | `dm-worker-{version}-linux-amd64.tar.gz` <br/>`dm-master-{version}-linux-amd64.tar.gz` <br/>`dmctl-{version}-linux-amd64.tar.gz` |
qiancai marked this conversation as resolved.
Show resolved Hide resolved
| [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-amd64.tar.gz` |
| [TiDB Binlog](/tidb-binlog/tidb-binlog-overview.md) | `pump-{version}-linux-amd64.tar.gz` <br/>`drainer-{version}-linux-amd64.tar.gz` <br/>`binlogctl` <br/>`reparo` |
| [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-amd64.tar.gz` |
| [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` |
| [TiSpark](/tispark-overview.md) | `tispark-{tispark-version}-any-any.tar.gz` <br/>`spark-{spark-version}-any-any.tar.gz` |
| [PD Control](/pd-control.md) | `pd-recover-{version}-linux-amd64.tar` |
| [PD Recover](/pd-recover.md) | `etcdctl` |
2 changes: 1 addition & 1 deletion dumpling-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ When using Dumpling, you need to execute the export command on a running cluster

You can get Dumpling using [TiUP](/tiup/tiup-overview.md) by running `tiup install dumpling`. Afterwards, you can use `tiup dumpling ...` to run Dumpling.

Dumpling is also included in the tidb-toolkit installation package and can be [download here](/download-ecosystem-tools.md#dumpling).
Dumpling is also included in the TiDB Toolkit installation package and can be [downloaded here](/download-ecosystem-tools.md).
qiancai marked this conversation as resolved.
Show resolved Hide resolved

## Export data from TiDB/MySQL

Expand Down
4 changes: 1 addition & 3 deletions get-started-with-tidb-lightning.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ Before the data import, you need to deploy a TiDB cluster. In this tutorial, TiD

### Step 2: Download TiDB Lightning installation package

Download the TiDB Lightning installation package from the following link:

- **v5.4.0**: [tidb-toolkit-v5.4.0-linux-amd64.tar.gz](https://download.pingcap.org/tidb-toolkit-v5.4.0-linux-amd64.tar.gz)
The TiDB Lightning installation package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

> **Note:**
>
Expand Down
12 changes: 2 additions & 10 deletions pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,9 @@ As a command line tool of PD, PD Control obtains the state information of the cl

To use PD Control, execute the `tiup ctl:<cluster-version> pd -u http://<pd_ip>:<pd_port> [-i]` command.

### Download TiDB installation package
### Download the installation package

If you want to download the latest version of `pd-ctl`, directly download the TiDB package, because `pd-ctl` is included in the TiDB package.

| Package download link | OS | Architecture | SHA256 checksum |
| :------------------------------------------------------------------------ | :---- | :----------- | :--------------------------------------------------------------- |
| `https://download.pingcap.org/tidb-{version}-linux-amd64.tar.gz` (pd-ctl) | Linux | amd64 | `https://download.pingcap.org/tidb-{version}-linux-amd64.sha256` |

> **Note:**
>
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v6.0.0`, the package download link is `https://download.pingcap.org/tidb-v6.0.0-linux-amd64.tar.gz`.
The PD Control installation package (`pd-ctl`) is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

### Compile from source code

Expand Down
12 changes: 2 additions & 10 deletions pd-recover.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,9 @@ PD Recover is a disaster recovery tool of PD, used to recover the PD cluster whi
>
> Generally, you do not need to compile source code because the PD Control tool already exists in the released binary or Docker. However, developer users can refer to the instructions above for compiling source code.

## Download TiDB installation package
## Download TiDB Toolkit

To download the latest version of PD Recover, directly download the TiDB package, because PD Recover is included in the TiDB package.

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

> **Note:**
>
> `{version}` indicates the version number of TiDB. For example, if `{version}` is `v6.0.0`, the package download link is `https://download.pingcap.org/tidb-v6.0.0-linux-amd64.tar.gz`.
The PD Recover installation package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

## Quick Start

Expand Down
2 changes: 1 addition & 1 deletion sync-diff-inspector/sync-diff-inspector-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases: ['/docs/dev/sync-diff-inspector/sync-diff-inspector-overview/','/docs/d

This guide introduces the key features of sync-diff-inspector and describes how to configure and use this tool. To download sync-diff-inspector, use one of the following methods:

+ Binary package. Click [tidb-enterprise-tools-nightly-linux-amd64](https://download.pingcap.org/tidb-enterprise-tools-nightly-linux-amd64.tar.gz) to download.
+ Binary package. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).
+ Docker image. Execute the following command to download:

{{< copyable "shell-regular" >}}
Expand Down
27 changes: 1 addition & 26 deletions tidb-binlog/binlog-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,7 @@ The following are its usage scenarios:

## Download `binlogctl`

> **Note:**
>
> It is recommended that the version of the Control tool you use is consistent with the version of the cluster.

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

```bash
wget https://download.pingcap.org/tidb-{version}-linux-amd64.tar.gz &&
wget https://download.pingcap.org/tidb-{version}-linux-amd64.sha256
```

To check the file integrity, execute the following command. If the result is OK, the file is correct.

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

```bash
sha256sum -c tidb-{version}-linux-amd64.sha256
```

To check the file integrity, execute the following command. If the result is OK, the file is correct.

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

```bash
sha256sum -c tidb-enterprise-tools-latest-linux-amd64.sha256
```
`binlogctl` is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

## Descriptions

Expand Down
37 changes: 3 additions & 34 deletions tidb-binlog/deploy-tidb-binlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,42 +23,11 @@ In environments of development, testing and production, the requirements on serv

It is recommended to deploy TiDB Binlog using TiUP. To do that, when deploying TiDB using TiUP, you need to add the node information of `drainer` and `pump` of TiDB Binlog in [TiDB Binlog Deployment Topology](/tidb-binlog-deployment-topology.md). For detailed deployment information, refer to [Deploy a TiDB Cluster Using TiUP](/production-deployment-using-tiup.md).

## Deploy TiDB Binlog using a Binary package
## Deploy TiDB Binlog using a binary package

### Download the official Binary package
### Download the official binary package

Run the following commands to download the packages:

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

```bash
version="latest" for nightly builds &&
wget https://download.pingcap.org/tidb-latest-linux-amd64.{tar.gz,sha256}
```

Check the file integrity. If the result is OK, the file is correct.

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

```bash
sha256sum -c tidb-latest-linux-amd64.sha256
```

For TiDB v2.1.0 GA or later versions, Pump and Drainer are already included in the TiDB download package. For other TiDB versions, you need to download Pump and Drainer separately using the following command:

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

```bash
wget https://download.pingcap.org/tidb-binlog-$version-linux-amd64.{tar.gz,sha256}
```

Check the file integrity. If the result is OK, the file is correct.

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

```bash
sha256sum -c tidb-binlog-$version-linux-amd64.sha256
```
The binary package of TiDB Binlog is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).

### The usage example

Expand Down
2 changes: 1 addition & 1 deletion tidb-binlog/tidb-binlog-reparo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases: ['/docs/dev/tidb-binlog/tidb-binlog-reparo/','/docs/dev/reference/tidb-

Reparo is a TiDB Binlog tool, used to recover the incremental data. To back up the incremental data, you can use Drainer of TiDB Binlog to output the binlog data in the protobuf format to files. To restore the incremental data, you can use Reparo to parse the binlog data in the files and apply the binlog in TiDB/MySQL.

Download Reparo via [tidb-binlog-cluster-latest-linux-amd64.tar.gz](https://download.pingcap.org/tidb-binlog-cluster-latest-linux-amd64.tar.gz)
The Reparo installation package (`reparo`) is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tidb-binlog/get-started-with-tidb-binlog.md 这个文档漏掉了

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in 641045c


## Reparo usage

Expand Down
2 changes: 1 addition & 1 deletion tidb-lightning/deploy-tidb-lightning.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can find deployment instructions in [TiDB Quick Start Guide](/quick-start-wi

#### Step 2: Download the TiDB Lightning installation package

Refer to the [TiDB enterprise tools download page](/download-ecosystem-tools.md#tidb-lightning) to download the TiDB Lightning package.
Refer to the [Download TiDB Tools](/download-ecosystem-tools.md) document to download the TiDB Lightning package.

> **Note:**
>
Expand Down
2 changes: 1 addition & 1 deletion tidb-lightning/tidb-lightning-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/dev/tidb-lightning/tidb-lightning-overview/','/docs/dev/referen

# TiDB Lightning Overview

[TiDB Lightning](https://github.com/pingcap/tidb-lightning) is a tool used for fast full import of large amounts of data into a TiDB cluster. You can download TiDB Lightning from [here](/download-ecosystem-tools.md#tidb-lightning).
[TiDB Lightning](https://github.com/pingcap/tidb-lightning) is a tool used for fast full import of large amounts of data into a TiDB cluster. You can download TiDB Lightning from [here](/download-ecosystem-tools.md).

Currently, TiDB Lightning can mainly be used in the following two scenarios:

Expand Down