Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions br/backup-and-restore-use-cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ With PITR, you can satisfy the preceding requirements.

## Deploy the TiDB cluster and BR

To use PITR, you need to deploy a TiDB cluster >= v6.2.0 and update BR to the same version as the TiDB cluster. This document uses v6.5.5 as an example.
To use PITR, you need to deploy a TiDB cluster >= v6.2.0 and update BR to the same version as the TiDB cluster. This document uses v6.5.6 as an example.

The following table shows the recommended hardware resources for using PITR in a TiDB cluster.

Expand All @@ -44,13 +44,13 @@ Install or upgrade BR using TiUP:
- Install:

```shell
tiup install br:v6.5.5
tiup install br:v6.5.6
```

- Upgrade:

```shell
tiup update br:v6.5.5
tiup update br:v6.5.6
```

## Configure backup storage (Amazon S3)
Expand Down
2 changes: 1 addition & 1 deletion dm/maintain-dm-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ All operations above performed on the cluster machine use the SSH client embedde

Then you can use the `--native-ssh` command-line flag to enable the system-native command-line tool:

- Deploy a cluster: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`. Fill in the name of your cluster for `<cluster-name>`, the DM version to be deployed (such as `v6.5.5`) for `<version>` , and the topology file name for `<topo>`.
- Deploy a cluster: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`. Fill in the name of your cluster for `<cluster-name>`, the DM version to be deployed (such as `v6.5.6`) for `<version>` , and the topology file name for `<topo>`.
- Start a cluster: `tiup dm start <cluster-name> --native-ssh`.
- Upgrade a cluster: `tiup dm upgrade ... --native-ssh`

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 @@ -73,7 +73,7 @@ To run a TiDB server, use the following command:
{{< copyable "shell-regular" >}}

```bash
wget https://download.pingcap.org/tidb-community-server-v6.5.5-linux-amd64.tar.gz
wget https://download.pingcap.org/tidb-community-server-v6.5.6-linux-amd64.tar.gz
tar -xzvf tidb-latest-linux-amd64.tar.gz
mv tidb-latest-linux-amd64/bin/tidb-server ./
./tidb-server
Expand Down
2 changes: 1 addition & 1 deletion pd-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To obtain `pd-ctl` of the latest version, download the TiDB server installation

> **Note:**
>
> `{version}` in the link indicates the version number of TiDB. For example, the download link for `v6.5.5` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-server-v6.5.5-linux-amd64.tar.gz`.
> `{version}` in the link indicates the version number of TiDB. For example, the download link for `v6.5.6` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-server-v6.5.6-linux-amd64.tar.gz`.

### Compile from source code

Expand Down
4 changes: 2 additions & 2 deletions production-deployment-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,13 +333,13 @@ Before you run the `deploy` command, use the `check` and `check --apply` command
{{< copyable "shell-regular" >}}

```shell
tiup cluster deploy tidb-test v6.5.5 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
tiup cluster deploy tidb-test v6.5.6 ./topology.yaml --user root [-p] [-i /home/root/.ssh/gcp_rsa]
```

In the `tiup cluster deploy` command above:

- `tidb-test` is the name of the TiDB cluster to be deployed.
- `v6.5.5` is the version of the TiDB cluster to be deployed. You can see the latest supported versions by running `tiup list tidb`.
- `v6.5.6` is the version of the TiDB cluster to be deployed. You can see the latest supported versions by running `tiup list tidb`.
- `topology.yaml` is the initialization configuration file.
- `--user root` indicates logging into the target machine as the `root` user to complete the cluster deployment. The `root` user is expected to have `ssh` and `sudo` privileges to the target machine. Alternatively, you can use other users with `ssh` and `sudo` privileges to complete the deployment.
- `[-i]` and `[-p]` are 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
10 changes: 5 additions & 5 deletions quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB in
{{< copyable "shell-regular" >}}

```shell
tiup playground v6.5.5 --db 2 --pd 3 --kv 3
tiup playground v6.5.6 --db 2 --pd 3 --kv 3
```

The command downloads a version cluster to the local machine and starts it, such as v6.5.5. To view the latest version, run `tiup list tidb`.
The command downloads a version cluster to the local machine and starts it, such as v6.5.6. To view the latest version, run `tiup list tidb`.

This command returns the access methods of the cluster:

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

```shell
tiup playground v6.5.5 --db 2 --pd 3 --kv 3
tiup playground v6.5.6 --db 2 --pd 3 --kv 3
```

The command downloads a version cluster to the local machine and starts it, such as v6.5.5. To view the latest version, run `tiup list tidb`.
The command downloads a version cluster to the local machine and starts it, such as v6.5.6. To view the latest version, run `tiup list tidb`.

This command returns the access methods of the cluster:

Expand Down Expand Up @@ -436,7 +436,7 @@ Other requirements for the target machine:
```

- `<cluster-name>`: Set the cluster name
- `<version>`: Set the TiDB cluster version, such as `v6.5.5`. You can see all the supported TiDB versions by running the `tiup list tidb` command
- `<version>`: Set the TiDB cluster version, such as `v6.5.6`. You can see all the supported TiDB versions by running the `tiup list tidb` command
- `-p`: Specify the password used to connect to the target machine.

> **Note:**
Expand Down
2 changes: 1 addition & 1 deletion scale-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ This section exemplifies how to remove a TiKV node from the `10.0.1.5` host.
```
Starting /root/.tiup/components/cluster/v1.11.3/cluster display <cluster-name>
TiDB Cluster: <cluster-name>
TiDB Version: v6.5.5
TiDB Version: v6.5.6
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
4 changes: 2 additions & 2 deletions ticdc/deploy-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ tiup cluster upgrade <cluster-name> <version> --transfer-timeout 600

> **Note:**
>
> In the preceding command, you need to replace `<cluster-name>` and `<version>` with the actual cluster name and cluster version. For example, the version can be `v6.5.5`.
> In the preceding command, you need to replace `<cluster-name>` and `<version>` with the actual cluster name and cluster version. For example, the version can be `v6.5.6`.

### Upgrade cautions

Expand Down Expand Up @@ -152,7 +152,7 @@ See [Enable TLS Between TiDB Components](/enable-tls-between-components.md).

## View TiCDC status using the command-line tool

Run the following command to view the TiCDC cluster status. Note that you need to replace `v<CLUSTER_VERSION>` with the TiCDC cluster version, such as `v6.5.5`:
Run the following command to view the TiCDC cluster status. Note that you need to replace `v<CLUSTER_VERSION>` with the TiCDC cluster version, such as `v6.5.6`:

```shell
tiup ctl:v<CLUSTER_VERSION> cdc capture list --server=http://10.0.10.25:8300
Expand Down
2 changes: 1 addition & 1 deletion ticdc/ticdc-changefeed-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ You can manage a TiCDC cluster and its replication tasks using the command-line

You can also use the HTTP interface (the TiCDC OpenAPI feature) to manage a TiCDC cluster and its replication tasks. For details, see [TiCDC OpenAPI](/ticdc/ticdc-open-api.md).

If your TiCDC is deployed using TiUP, you can start `cdc cli` by running the `tiup ctl:v<CLUSTER_VERSION> cdc` command. Replace `v<CLUSTER_VERSION>` with the TiCDC cluster version, such as `v6.5.5`. You can also run `cdc cli` directly.
If your TiCDC is deployed using TiUP, you can start `cdc cli` by running the `tiup ctl:v<CLUSTER_VERSION> cdc` command. Replace `v<CLUSTER_VERSION>` with the TiCDC cluster version, such as `v6.5.6`. You can also run `cdc cli` directly.
2 changes: 1 addition & 1 deletion tidb-binlog/get-started-with-tidb-binlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ sudo yum install -y mariadb-server
```

```bash
curl -L https://download.pingcap.org/tidb-community-server-v6.5.5-linux-amd64.tar.gz | tar xzf -
curl -L https://download.pingcap.org/tidb-community-server-v6.5.6-linux-amd64.tar.gz | tar xzf -
cd tidb-latest-linux-amd64
```

Expand Down
2 changes: 1 addition & 1 deletion tiflash/create-tiflash-replicas.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Before TiFlash replicas are added, each TiKV instance performs a full table scan
tiup ctl:v<CLUSTER_VERSION> pd -u http://<PD_ADDRESS>:2379 store limit all engine tiflash 60 add-peer
```

> In the preceding command, you need to replace `v<CLUSTER_VERSION>` with the actual cluster version, such as `v6.5.5` and `<PD_ADDRESS>:2379` with the address of any PD node. For example:
> In the preceding command, you need to replace `v<CLUSTER_VERSION>` with the actual cluster version, such as `v6.5.6` and `<PD_ADDRESS>:2379` with the address of any PD node. For example:
>
> ```shell
> tiup ctl:v6.1.1 pd -u http://192.168.1.4:2379 store limit all engine tiflash 60 add-peer
Expand Down
30 changes: 15 additions & 15 deletions tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To deploy the cluster, run the `tiup cluster deploy` command. The usage of the c
tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
```

This command requires you to provide the cluster name, the TiDB cluster version (such as `v6.5.5`), and a topology file of the cluster.
This command requires you to provide the cluster name, the TiDB cluster version (such as `v6.5.6`), and a topology file of the cluster.

To write a topology file, refer to [the example](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml). The following file is an example of the simplest topology:

Expand Down Expand Up @@ -118,20 +118,20 @@ tidb_servers:
...
```

Save the file as `/tmp/topology.yaml`. If you want to use TiDB v6.5.5 and your cluster name is `prod-cluster`, run the following command:
Save the file as `/tmp/topology.yaml`. If you want to use TiDB v6.5.6 and your cluster name is `prod-cluster`, run the following command:

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

```shell
tiup cluster deploy -p prod-cluster v6.5.5 /tmp/topology.yaml
tiup cluster deploy -p prod-cluster v6.5.6 /tmp/topology.yaml
```

During the execution, TiUP asks you to confirm your topology again and requires the root password of the target machine (the `-p` flag means inputting password):

```bash
Please confirm your topology:
TiDB Cluster: prod-cluster
TiDB Version: v6.5.5
TiDB Version: v6.5.6
Type Host Ports OS/Arch Directories
---- ---- ----- ------- -----------
pd 172.16.5.134 2379/2380 linux/x86_64 deploy/pd-2379,data/pd-2379
Expand Down Expand Up @@ -174,7 +174,7 @@ tiup cluster list
Starting /root/.tiup/components/cluster/v1.11.3/cluster list
Name User Version Path PrivateKey
---- ---- ------- ---- ----------
prod-cluster tidb v6.5.5 /root/.tiup/storage/cluster/clusters/prod-cluster /root/.tiup/storage/cluster/clusters/prod-cluster/ssh/id_rsa
prod-cluster tidb v6.5.6 /root/.tiup/storage/cluster/clusters/prod-cluster /root/.tiup/storage/cluster/clusters/prod-cluster/ssh/id_rsa
```

## Start the cluster
Expand Down Expand Up @@ -204,7 +204,7 @@ tiup cluster display prod-cluster
```
Starting /root/.tiup/components/cluster/v1.11.3/cluster display prod-cluster
TiDB Cluster: prod-cluster
TiDB Version: v6.5.5
TiDB Version: v6.5.6
ID Role Host Ports OS/Arch Status Data Dir Deploy Dir
-- ---- ---- ----- ------- ------ -------- ----------
172.16.5.134:3000 grafana 172.16.5.134 3000 linux/x86_64 Up - deploy/grafana-3000
Expand Down Expand Up @@ -278,7 +278,7 @@ tiup cluster display prod-cluster
```
Starting /root/.tiup/components/cluster/v1.11.3/cluster display prod-cluster
TiDB Cluster: prod-cluster
TiDB Version: v6.5.5
TiDB Version: v6.5.6
ID Role Host Ports OS/Arch Status Data Dir Deploy Dir
-- ---- ---- ----- ------- ------ -------- ----------
172.16.5.134:3000 grafana 172.16.5.134 3000 linux/x86_64 Up - deploy/grafana-3000
Expand Down Expand Up @@ -389,12 +389,12 @@ Global Flags:
-y, --yes Skip all confirmations and assumes 'yes'
```

For example, the following command upgrades the cluster to v6.5.5:
For example, the following command upgrades the cluster to v6.5.6:

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

```bash
tiup cluster upgrade tidb-test v6.5.5
tiup cluster upgrade tidb-test v6.5.6
```

## Update configuration
Expand Down Expand Up @@ -579,11 +579,11 @@ tiup cluster audit
Starting component `cluster`: /home/tidb/.tiup/components/cluster/v1.11.3/cluster audit
ID Time Command
-- ---- -------
4BLhr0 2023-09-21T13:25:09+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.5 /tmp/topology.yaml
4BKWjF 2023-09-21T23:36:57+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.5 /tmp/topology.yaml
4BKVwH 2023-09-21T23:02:08+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.5 /tmp/topology.yaml
4BKKH1 2023-09-21T16:39:04+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster destroy test
4BKKDx 2023-09-21T16:36:57+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.5 /tmp/topology.yaml
4BLhr0 2023-12-07T13:25:09+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.6 /tmp/topology.yaml
4BKWjF 2023-12-07T23:36:57+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.6 /tmp/topology.yaml
4BKVwH 2023-12-07T23:02:08+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.6 /tmp/topology.yaml
4BKKH1 2023-12-07T16:39:04+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster destroy test
4BKKDx 2023-12-07T16:36:57+08:00 /home/tidb/.tiup/components/cluster/v1.11.3/cluster deploy test v6.5.6 /tmp/topology.yaml
```

The first column is `audit-id`. To view the execution log of a certain command, pass the `audit-id` of a command as the flag as follows:
Expand Down Expand Up @@ -699,7 +699,7 @@ All operations above performed on the cluster machine use the SSH client embedde

Then you can use the `--ssh=system` command-line flag to enable the system-native command-line tool:

- Deploy a cluster: `tiup cluster deploy <cluster-name> <version> <topo> --ssh=system`. Fill in the name of your cluster for `<cluster-name>`, the TiDB version to be deployed (such as `v6.5.5`) for `<version>`, and the topology file for `<topo>`.
- Deploy a cluster: `tiup cluster deploy <cluster-name> <version> <topo> --ssh=system`. Fill in the name of your cluster for `<cluster-name>`, the TiDB version to be deployed (such as `v6.5.6`) for `<version>`, and the topology file for `<topo>`.
- Start a cluster: `tiup cluster start <cluster-name> --ssh=system`
- Upgrade a cluster: `tiup cluster upgrade ... --ssh=system`

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

## Options
Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before running the `tiup cluster patch` command, you need to pack the binary pac
1. Determine the following variables:

- `${component}`: the name of the component to be replaced (such as `tidb`, `tikv`, or `pd`).
- `${version}`: the version of the component (such as `v6.5.5`).
- `${version}`: the version of the component (such as `v6.5.6`).
- `${os}`: the operating system (`linux`).
- `${arch}`: the platform on which the component runs (`amd64`, `arm64`).

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
```

- `<cluster-name>`: the cluster name to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-cluster-list.md) command.
- `<version>`: the target version to upgrade to, such as `v6.5.5`. Currently, it is only allowed to upgrade to a version higher than the current cluster, that is, no downgrade is allowed. It is also not allowed to upgrade to the nightly version.
- `<version>`: the target version to upgrade to, such as `v6.5.6`. Currently, it is only allowed to upgrade to a version higher than the current cluster, that is, no downgrade is allowed. It is also not allowed to upgrade to the nightly version.

## Options

Expand Down
2 changes: 1 addition & 1 deletion tiup/tiup-component-dm-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tiup dm upgrade <cluster-name> <version> [flags]
```

- `<cluster-name>` is the name of the cluster to be operated on. If you forget the cluster name, you can check it using the [`tiup dm list`](/tiup/tiup-component-dm-list.md) command.
- `<version>` is the target version to be upgraded to, such as `v6.5.5`. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either.
- `<version>` is the target version to be upgraded to, such as `v6.5.6`. Currently, only upgrading to a later version is allowed, and upgrading to an earlier version is not allowed, which means the downgrade is not allowed. Upgrading to a nightly version is not allowed either.

## 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 @@ -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 v6.5.5.
Example 3: Use TiUP to install TiKV v6.5.6.

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

```shell
tiup install tikv:v6.5.5
tiup install tikv:v6.5.6
```

## Upgrade components
Expand Down Expand Up @@ -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 v6.5.5.
Example 1: Operate TiDB v6.5.6.

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

```shell
tiup tidb:v6.5.5
tiup tidb:v6.5.6
```

Example 2: Specify the tag with which TiKV operates.
Expand Down Expand Up @@ -218,12 +218,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 v6.5.5.
Example 1: Uninstall TiDB v6.5.6.

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

```shell
tiup uninstall tidb:v6.5.5
tiup uninstall tidb:v6.5.6
```

Example 2: Uninstall TiKV of all versions.
Expand Down
Loading