From e2df890272f44c9fb2dc2d926a1ffd58e944da6e Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 16 Feb 2023 17:04:03 +0800 Subject: [PATCH] tiup: add examples for tiup version placehoder (#12999) --- dm/maintain-dm-using-tiup.md | 6 +++--- quick-start-with-tidb.md | 4 ++-- ticdc/deploy-ticdc.md | 6 +++--- tiflash-620-upgrade-guide.md | 2 +- tiup/tiup-cluster.md | 8 ++++---- tiup/tiup-component-cluster-upgrade.md | 2 +- tiup/tiup-component-dm-upgrade.md | 2 +- upgrade-tidb-using-tiup.md | 6 +++--- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/dm/maintain-dm-using-tiup.md b/dm/maintain-dm-using-tiup.md index ddaf18015f2c..2bae43045072 100644 --- a/dm/maintain-dm-using-tiup.md +++ b/dm/maintain-dm-using-tiup.md @@ -390,9 +390,9 @@ tiup dmctl --master-addr master1:8261 operate-source create /tmp/source1.yml 此时可以通过命令行参数 `--native-ssh` 启用系统自带命令行： -- 部署集群: `tiup dm deploy --native-ssh` -- 启动集群: `tiup dm start --native-ssh` -- 升级集群: `tiup dm upgrade ... --native-ssh` +- 部署集群：`tiup dm deploy --native-ssh`，其中 `` 为集群名称，`` 为 DM 集群版本（例如 `v6.5.0`），`` 为拓扑文件路径 +- 启动集群：`tiup dm start --native-ssh` +- 升级集群：`tiup dm upgrade ... --native-ssh` 所有涉及集群操作的步骤都可以加上 `--native-ssh` 来使用系统自带的客户端。 diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 71bc37edfa9c..ff18c27f3def 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -430,11 +430,11 @@ TiDB 是一个分布式系统。最基础的 TiDB 测试集群通常由 2 个 Ti {{< copyable "shell-regular" >}} ```shell - tiup cluster deploy ./topo.yaml --user root -p + tiup cluster deploy ./topo.yaml --user root -p ``` - 参数 `` 表示设置集群名称 - - 参数 `` 表示设置集群版本，可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本 + - 参数 `` 表示设置集群版本，例如 `v6.5.0`。可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本 - 参数 `-p` 表示在连接目标机器时使用密码登录 > **注意：** diff --git a/ticdc/deploy-ticdc.md b/ticdc/deploy-ticdc.md index 42161b915e3d..9a2f9febabd0 100644 --- a/ticdc/deploy-ticdc.md +++ b/ticdc/deploy-ticdc.md @@ -90,12 +90,12 @@ TiUP 支持升级 TiDB 集群，包括 TiCDC 组件。执行升级指令时，Ti ```shell tiup update --self && \ tiup update --all && \ -tiup cluster upgrade --transfer-timeout 600 +tiup cluster upgrade --transfer-timeout 600 ``` > **注意：** > -> 命令中的 `` 需要替换为集群名字，`` 需要替换为目标版本号，例如 v6.5.0。 +> 命令中的 `` 需要替换为集群名字，`` 需要替换为目标版本号，例如 `v6.5.0`。 ### 升级的注意事项 @@ -152,7 +152,7 @@ tiup cluster upgrade --transfer-timeout 600 ## 使用 TiCDC 命令行工具来查看集群状态 -执行以下命令来查看 TiCDC 集群运行状态，注意需要将 `v` 替换为 TiCDC 集群版本： +执行以下命令来查看 TiCDC 集群运行状态，注意需要将 `v` 替换为 TiCDC 集群版本，例如 `v6.5.0`： ```shell tiup ctl:v cdc capture list --server=http://10.0.10.25:8300 diff --git a/tiflash-620-upgrade-guide.md b/tiflash-620-upgrade-guide.md index c132c706101c..8cf448698223 100644 --- a/tiflash-620-upgrade-guide.md +++ b/tiflash-620-upgrade-guide.md @@ -25,7 +25,7 @@ summary: 了解升级 TiFlash 至 v6.2 时的注意事项。 > - 若想将 TiFlash 从 v5.3.0 之前的版本升级到 v5.3.0 及之后的版本，必须进行 TiFlash 的停机升级。参考如下步骤，可以在确保其他组件正常运行的情况下升级 TiFlash： > > - 关闭 TiFlash 实例：`tiup cluster stop -R tiflash` -> - 使用 `--offline` 参数在不重启（只更新文件）的情况下升级集群：`tiup cluster upgrade --offline` +> - 使用 `--offline` 参数在不重启（只更新文件）的情况下升级集群：`tiup cluster upgrade --offline`，例如 `tiup cluster upgrade v5.3.0 --offline` > - reload 整个集群：`tiup cluster reload `。此时，TiFlash 也会正常启动，无需额外操作。 ## 从 v5.x 或 v6.0 升级至 v6.1 diff --git a/tiup/tiup-cluster.md b/tiup/tiup-cluster.md index f1f046929d3d..36b21195a139 100644 --- a/tiup/tiup-cluster.md +++ b/tiup/tiup-cluster.md @@ -61,7 +61,7 @@ Flags: tiup cluster deploy [flags] ``` -该命令需要提供集群的名字、集群使用的 TiDB 版本，以及一个集群的拓扑文件。 +该命令需要提供集群的名字、集群使用的 TiDB 版本（例如 `v6.5.0`），以及一个集群的拓扑文件。 拓扑文件的编写可参考[示例](https://github.com/pingcap/tiup/blob/master/embed/examples/cluster/topology.example.yaml)。以一个最简单的拓扑为例，将下列文件保存为 `/tmp/topology.yaml`： @@ -673,9 +673,9 @@ tiup cluster check --cluster 此时可以通过命令行参数 `--ssh=system` 启用系统自带命令行： -- 部署集群: `tiup cluster deploy --ssh=system` -- 启动集群: `tiup cluster start --ssh=system` -- 升级集群: `tiup cluster upgrade ... --ssh=system` +- 部署集群：`tiup cluster deploy --ssh=system`，其中 `` 为集群名称，`` 为 TiDB 集群版本（例如 `v6.5.0`），`` 为拓扑文件路径 +- 启动集群：`tiup cluster start --ssh=system` +- 升级集群：`tiup cluster upgrade ... --ssh=system` 所有涉及集群操作的步骤都可以加上 `--ssh=system` 来使用系统自带的客户端。 diff --git a/tiup/tiup-component-cluster-upgrade.md b/tiup/tiup-component-cluster-upgrade.md index 3a2f0993d970..22f3d2d8e0ad 100644 --- a/tiup/tiup-component-cluster-upgrade.md +++ b/tiup/tiup-component-cluster-upgrade.md @@ -13,7 +13,7 @@ tiup cluster upgrade [flags] ``` - `` 为要操作的集群名字，如果忘记集群名字可通过[集群列表](/tiup/tiup-component-cluster-list.md)查看。 -- `` 为要升级到的目标版本，目前仅允许升级到比当前集群更高的版本，不允许升级到比当前集群更低的版本，即不允许降级。同时也不允许升级成 nightly 版本 +- `` 为要升级到的目标版本，例如 `v6.5.0`。目前仅允许升级到比当前集群更高的版本，不允许升级到比当前集群更低的版本，即不允许降级。同时也不允许升级成 nightly 版本 ## 选项 diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md index 42ef0997753b..438c4a06a2e4 100644 --- a/tiup/tiup-component-dm-upgrade.md +++ b/tiup/tiup-component-dm-upgrade.md @@ -13,7 +13,7 @@ tiup dm upgrade [flags] ``` - `` 为要操作的集群名字，如果忘记集群名字可查看[集群列表](/tiup/tiup-component-dm-list.md)。 -- `` 为要升级到的目标版本，目前仅允许升级到比当前集群更高的版本，不允许升级到比当前集群更低的版本，即不允许降级。同时也不允许升级成 nightly 版本 +- `` 为要升级到的目标版本，例如 `v6.5.0`。目前仅允许升级到比当前集群更高的版本，不允许升级到比当前集群更低的版本，即不允许降级。同时也不允许升级成 nightly 版本 ## 选项 diff --git a/upgrade-tidb-using-tiup.md b/upgrade-tidb-using-tiup.md index 529f11a7778e..2e8d029abca2 100644 --- a/upgrade-tidb-using-tiup.md +++ b/upgrade-tidb-using-tiup.md @@ -186,7 +186,7 @@ tiup cluster upgrade v6.5.0 > - 如果希望保持性能稳定，则需要保证 TiKV 上的所有 leader 驱逐完成后再停止该 TiKV 实例，可以指定 `--transfer-timeout` 为一个更大的值，如 `--transfer-timeout 3600`，单位为秒。 > - 若想将 TiFlash 从 5.3 之前的版本升级到 5.3 及之后的版本，必须进行 TiFlash 的停机升级。参考如下步骤，可以在确保其他组件正常运行的情况下升级 TiFlash： > 1. 关闭 TiFlash 实例：`tiup cluster stop -R tiflash` -> 2. 使用 `--offline` 参数在不重启（只更新文件）的情况下升级集群：`tiup cluster upgrade --offline` +> 2. 使用 `--offline` 参数在不重启（只更新文件）的情况下升级集群：`tiup cluster upgrade --offline`，例如 `tiup cluster upgrade v6.3.0 --offline` > 3. reload 整个集群：`tiup cluster reload `。此时，TiFlash 也会正常启动，无需额外操作。 #### 停机升级 @@ -199,7 +199,7 @@ tiup cluster upgrade v6.5.0 tiup cluster stop ``` -之后通过 `upgrade` 命令添加 `--offline` 参数来进行停机升级。 +之后通过 `upgrade` 命令添加 `--offline` 参数来进行停机升级，其中 `` 为集群名，`` 为升级的目标版本，例如 `v6.5.0`。 {{< copyable "shell-regular" >}} @@ -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` 过程，直接重启并升级版本，对线上运行的集群性能影响较大。命令如下，其中 `` 为升级的目标版本，例如 `v6.5.0`： {{< copyable "shell-regular" >}}