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

tiup: add examples for tiup version placehoder #12522

Merged
merged 3 commits into from
Feb 16, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 2 additions & 2 deletions dm/maintain-dm-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,8 @@ 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`
- Start a cluster: `tiup dm start <cluster-name> --native-ssh`
- Deploy a cluster: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`. `<cluster-name>` is the cluster name, `<version>` is the DM version to be deployed (such as `v6.5.0`), and `<topo>` is the topology file.
- Start a cluster: `tiup dm start <cluster-name> --native-ssh`. `<cluster-name>` is the cluster name.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
- Upgrade a cluster: `tiup dm upgrade ... --native-ssh`

You can add `--native-ssh` in all cluster operation commands above to use the system's native SSH client.
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 @@ -433,11 +433,11 @@ Other requirements for the target machine:
{{< copyable "shell-regular" >}}

```shell
tiup cluster deploy <cluster-name> <tidb-version> ./topo.yaml --user root -p
tiup cluster deploy <cluster-name> <version> ./topo.yaml --user root -p
```

- `<cluster-name>`: Set the cluster name
- `<tidb-version>`: Set the TiDB cluster version. 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.0`. 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
6 changes: 3 additions & 3 deletions ticdc/deploy-ticdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,12 @@ You can upgrade TiDB clusters using TiUP, during which TiCDC is upgraded as well
```shell
tiup update --self && \
tiup update --all && \
tiup cluster upgrade <cluster-name> <cluster-version> --transfer-timeout 600
tiup cluster upgrade <cluster-name> <version> --transfer-timeout 600
```

> **Note:**
>
> In the preceding command, you need to replace `<cluster-name>` and `<cluster-version>` with the actual cluster name and cluster version. For example, the version can be v6.5.0.
> 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.0`.

### 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:
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.0`:

```shell
tiup ctl:v<CLUSTER_VERSION> cdc capture list --server=http://10.0.10.25:8300
Expand Down
2 changes: 1 addition & 1 deletion tiflash-620-upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To learn the standard upgrade process, see the following documents:
> - To upgrade TiFlash from versions earlier than v5.3.0 to v5.3.0 or later, you should stop TiFlash and then upgrade it. The following steps help you upgrade TiFlash without interrupting other components:
>
> - Stop the TiFlash instance: `tiup cluster stop <cluster-name> -R tiflash`
> - Upgrade the TiDB cluster without restarting it (only updating the files): `tiup cluster upgrade <cluster-name> <version> --offline`
> - Upgrade the TiDB cluster without restarting it (only updating the files): `tiup cluster upgrade <cluster-name> <version> --offline`, such as `tiup cluster upgrade <cluster-name> v5.3.0 --offline`
> - Reload the TiDB cluster: `tiup cluster reload <cluster-name>`. After the reload, the TiFlash instance is started and you do not need to manually start it.

## From 5.x or v6.0 to v6.1
Expand Down
6 changes: 3 additions & 3 deletions tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,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, and a topology file of the cluster.
This command requires you to provide the cluster name, the TiDB cluster version (such as `v6.5.0`), 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 @@ -697,8 +697,8 @@ 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`
- Start a cluster: `tiup cluster start <cluster-name> --ssh=system`
- Deploy a cluster: `tiup cluster deploy <cluster-name> <version> <topo> --ssh=system`. `<cluster-name>` is the cluster name, `<version>` is the TiDB version to be deployed (such as `v6.5.0`), and `<topo>` is the topology file.
- Start a cluster: `tiup cluster start <cluster-name> --ssh=system`. `<cluster-name>` is the cluster name.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
- Upgrade a cluster: `tiup cluster upgrade ... --ssh=system`

You can add `--ssh=system` in all cluster operation commands above to use the system's native SSH client.
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. 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.0`. 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. 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.0`. 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
6 changes: 3 additions & 3 deletions upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ tiup cluster upgrade <cluster-name> v6.5.0
>
> + To upgrade TiFlash from versions earlier than 5.3 to 5.3 or later, you should stop TiFlash and then upgrade it. The following steps help you upgrade TiFlash without interrupting other components:
> 1. Stop the TiFlash instance: `tiup cluster stop <cluster-name> -R tiflash`
> 2. Upgrade the TiDB cluster without restarting it (only updating the files): `tiup cluster upgrade <cluster-name> <version> --offline`
> 2. Upgrade the TiDB cluster without restarting it (only updating the files): `tiup cluster upgrade <cluster-name> <version> --offline`, such as `tiup cluster upgrade <cluster-name> v6.3.0 --offline`
> 3. Reload the TiDB cluster: `tiup cluster reload <cluster-name>`. After the reload, the TiFlash instance is started and you do not need to manually start it.
>
> + Try to avoid creating a new clustered index table when you apply rolling updates to the clusters using TiDB Binlog.
Expand All @@ -215,7 +215,7 @@ tiup cluster upgrade <cluster-name> v6.5.0
tiup cluster stop <cluster-name>
```

2. Use the `upgrade` command with the `--offline` option to perform the offline upgrade.
2. Use the `upgrade` command with the `--offline` option to perform the offline upgrade. `<cluster-name>` is the cluster name, and `<version>` is the version to upgrade to, such as `v6.5.0`.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down Expand Up @@ -279,7 +279,7 @@ Re-execute the `tiup cluster upgrade` command to resume the upgrade. The upgrade

### The evict leader has waited too long during the upgrade. How to skip this step for a quick upgrade?

You can specify `--force`. Then the processes of transferring PD leader and evicting TiKV leader are skipped during the upgrade. The cluster is directly restarted to update the version, which has a great impact on the cluster that runs online. Here is the command:
You can specify `--force`. Then the processes of transferring PD leader and evicting TiKV leader are skipped during the upgrade. The cluster is directly restarted to update the version, which has a great impact on the cluster that runs online. In the following command, `<cluster-name>` is the cluster name, and `<version>` is the version to upgrade to, such as `v6.5.0`.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down