Skip to content

Commit

Permalink
tiup: add examples for tiup version placehoder (pingcap#12999)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt authored Feb 16, 2023
1 parent 65b333d commit e2df890
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions dm/maintain-dm-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,9 +390,9 @@ tiup dmctl --master-addr master1:8261 operate-source create /tmp/source1.yml

此时可以通过命令行参数 `--native-ssh` 启用系统自带命令行:

- 部署集群: `tiup dm deploy <cluster-name> <version> <topo> --native-ssh`
- 启动集群: `tiup dm start <cluster-name> --native-ssh`
- 升级集群: `tiup dm upgrade ... --native-ssh`
- 部署集群`tiup dm deploy <cluster-name> <version> <topo> --native-ssh`,其中 `<cluster-name>` 为集群名称,`<version>` 为 DM 集群版本(例如 `v6.5.0`),`<topo>` 为拓扑文件路径
- 启动集群`tiup dm start <cluster-name> --native-ssh`
- 升级集群`tiup dm upgrade ... --native-ssh`

所有涉及集群操作的步骤都可以加上 `--native-ssh` 来使用系统自带的客户端。

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 @@ -430,11 +430,11 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti
{{< 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>` 表示设置集群名称
- 参数 `<tidb-version>` 表示设置集群版本,可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本
- 参数 `<version>` 表示设置集群版本,例如 `v6.5.0`可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本
- 参数 `-p` 表示在连接目标机器时使用密码登录
> **注意:**
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 @@ TiUP 支持升级 TiDB 集群,包括 TiCDC 组件。执行升级指令时,Ti
```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
```

> **注意:**
>
> 命令中的 `<cluster-name>` 需要替换为集群名字,`<cluster-version>` 需要替换为目标版本号,例如 v6.5.0。
> 命令中的 `<cluster-name>` 需要替换为集群名字,`<version>` 需要替换为目标版本号,例如 `v6.5.0`

### 升级的注意事项

Expand Down Expand Up @@ -152,7 +152,7 @@ tiup cluster upgrade <cluster-name> <cluster-version> --transfer-timeout 600

## 使用 TiCDC 命令行工具来查看集群状态

执行以下命令来查看 TiCDC 集群运行状态,注意需要将 `v<CLUSTER_VERSION>` 替换为 TiCDC 集群版本:
执行以下命令来查看 TiCDC 集群运行状态,注意需要将 `v<CLUSTER_VERSION>` 替换为 TiCDC 集群版本,例如 `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 @@ summary: 了解升级 TiFlash 至 v6.2 时的注意事项。
> - 若想将 TiFlash 从 v5.3.0 之前的版本升级到 v5.3.0 及之后的版本,必须进行 TiFlash 的停机升级。参考如下步骤,可以在确保其他组件正常运行的情况下升级 TiFlash:
>
> - 关闭 TiFlash 实例:`tiup cluster stop <cluster-name> -R tiflash`
> - 使用 `--offline` 参数在不重启(只更新文件)的情况下升级集群:`tiup cluster upgrade <cluster-name> <version> --offline`
> - 使用 `--offline` 参数在不重启(只更新文件)的情况下升级集群:`tiup cluster upgrade <cluster-name> <version> --offline`,例如 `tiup cluster upgrade <cluster-name> v5.3.0 --offline`
> - reload 整个集群:`tiup cluster reload <cluster-name>`。此时,TiFlash 也会正常启动,无需额外操作。
## 从 v5.x 或 v6.0 升级至 v6.1
Expand Down
8 changes: 4 additions & 4 deletions tiup/tiup-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Flags:
tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]
```

该命令需要提供集群的名字、集群使用的 TiDB 版本,以及一个集群的拓扑文件。
该命令需要提供集群的名字、集群使用的 TiDB 版本(例如 `v6.5.0`,以及一个集群的拓扑文件。

拓扑文件的编写可参考[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)。以一个最简单的拓扑为例,将下列文件保存为 `/tmp/topology.yaml`

Expand Down Expand Up @@ -673,9 +673,9 @@ tiup cluster check <cluster-name> --cluster

此时可以通过命令行参数 `--ssh=system` 启用系统自带命令行:

- 部署集群: `tiup cluster deploy <cluster-name> <version> <topo> --ssh=system`
- 启动集群: `tiup cluster start <cluster-name> --ssh=system`
- 升级集群: `tiup cluster upgrade ... --ssh=system`
- 部署集群`tiup cluster deploy <cluster-name> <version> <topo> --ssh=system`,其中 `<cluster-name>` 为集群名称,`<version>` 为 TiDB 集群版本(例如 `v6.5.0`),`<topo>` 为拓扑文件路径
- 启动集群`tiup cluster start <cluster-name> --ssh=system`
- 升级集群`tiup cluster upgrade ... --ssh=system`

所有涉及集群操作的步骤都可以加上 `--ssh=system` 来使用系统自带的客户端。

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>` 为要操作的集群名字,如果忘记集群名字可通过[集群列表](/tiup/tiup-component-cluster-list.md)查看。
- `<version>` 为要升级到的目标版本,目前仅允许升级到比当前集群更高的版本,不允许升级到比当前集群更低的版本,即不允许降级。同时也不允许升级成 nightly 版本
- `<version>` 为要升级到的目标版本,例如 `v6.5.0`目前仅允许升级到比当前集群更高的版本,不允许升级到比当前集群更低的版本,即不允许降级。同时也不允许升级成 nightly 版本

## 选项

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>` 为要操作的集群名字,如果忘记集群名字可查看[集群列表](/tiup/tiup-component-dm-list.md)
- `<version>` 为要升级到的目标版本,目前仅允许升级到比当前集群更高的版本,不允许升级到比当前集群更低的版本,即不允许降级。同时也不允许升级成 nightly 版本
- `<version>` 为要升级到的目标版本,例如 `v6.5.0`目前仅允许升级到比当前集群更高的版本,不允许升级到比当前集群更低的版本,即不允许降级。同时也不允许升级成 nightly 版本

## 选项

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 @@ -186,7 +186,7 @@ tiup cluster upgrade <cluster-name> v6.5.0
> - 如果希望保持性能稳定,则需要保证 TiKV 上的所有 leader 驱逐完成后再停止该 TiKV 实例,可以指定 `--transfer-timeout` 为一个更大的值,如 `--transfer-timeout 3600`,单位为秒。
> - 若想将 TiFlash 从 5.3 之前的版本升级到 5.3 及之后的版本,必须进行 TiFlash 的停机升级。参考如下步骤,可以在确保其他组件正常运行的情况下升级 TiFlash:
> 1. 关闭 TiFlash 实例:`tiup cluster stop <cluster-name> -R tiflash`
> 2. 使用 `--offline` 参数在不重启(只更新文件)的情况下升级集群:`tiup cluster upgrade <cluster-name> <version> --offline`
> 2. 使用 `--offline` 参数在不重启(只更新文件)的情况下升级集群:`tiup cluster upgrade <cluster-name> <version> --offline`,例如 `tiup cluster upgrade <cluster-name> v6.3.0 --offline`
> 3. reload 整个集群:`tiup cluster reload <cluster-name>`。此时,TiFlash 也会正常启动,无需额外操作。
#### 停机升级
Expand All @@ -199,7 +199,7 @@ tiup cluster upgrade <cluster-name> v6.5.0
tiup cluster stop <cluster-name>
```

之后通过 `upgrade` 命令添加 `--offline` 参数来进行停机升级。
之后通过 `upgrade` 命令添加 `--offline` 参数来进行停机升级,其中 `<cluster-name>` 为集群名,`<version>` 为升级的目标版本,例如 `v6.5.0`

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

Expand Down Expand Up @@ -263,7 +263,7 @@ Cluster version: v6.5.0

### 4.2 升级过程中 evict leader 等待时间过长,如何跳过该步骤快速升级

可以指定 `--force`,升级时会跳过 `PD transfer leader``TiKV evict leader` 过程,直接重启并升级版本,对线上运行的集群性能影响较大。命令如下:
可以指定 `--force`,升级时会跳过 `PD transfer leader``TiKV evict leader` 过程,直接重启并升级版本,对线上运行的集群性能影响较大。命令如下,其中 `<version>` 为升级的目标版本,例如 `v6.5.0`

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

Expand Down

0 comments on commit e2df890

Please sign in to comment.