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, tiproxy: add version flags to tiup cluster upgrade #16243

Merged
merged 2 commits into from
Feb 1, 2024
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
4 changes: 2 additions & 2 deletions tiproxy/tiproxy-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ TiProxy 不适用于以下场景:

## 安装和使用

本节介绍使用 TiUP 部署和变更 TiProxy 的步骤。使用 TiDB Operator 部署的方式请参阅 [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable) 文档。
本节介绍使用 TiUP 部署和变更 TiProxy 的步骤。使用 TiDB Operator 部署的方式请参阅 [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tiproxy) 文档。

### 部署 TiProxy

Expand Down Expand Up @@ -126,7 +126,7 @@ TiProxy 不适用于以下场景:

部署 TiProxy 时建议指定 TiProxy 的版本,使升级 TiDB 集群时不会升级 TiProxy。

如果确实要升级 TiProxy 的版本,需加上 [`--tiproxy-version`](/tiup/tiup-component-cluster-upgrade.md) 指定 TiProxy 的版本:
如果确实要升级 TiProxy 的版本,需加上 [`--tiproxy-version`](/tiup/tiup-component-cluster-upgrade.md#--tiproxy-version) 指定 TiProxy 的版本:

```shell
tiup cluster upgrade <cluster-name> <version> --tiproxy-version <tiproxy-version>
Expand Down
68 changes: 67 additions & 1 deletion tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,78 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- 数据类型:`BOOLEAN`
- 该选项默认关闭,默认值为 `false`。在命令中添加该选项,并传入 `true` 值或不传值,均可开启此功能。

### --ignore-version-check

- 在升级前,TiUP 会检查目标版本是否大于等于当前版本。如果想要跳过该项检查,可以使用该选项。
- 数据类型:`BOOLEAN`
- 该选项默认关闭,默认值为 `false`。在命令中添加该选项,并传入 `true` 值或不传值,均可开启此功能。

### --offline

- 声明当前集群处于停止状态。指定该选项时,TiUP Cluster 仅原地替换集群组件的二进制文件,不执行迁移 Leader 以及重启服务等操作。
- 数据类型:`BOOLEAN`
- 该选项默认关闭,默认值为 `false`。在命令中添加该选项,并传入 `true` 值或不传值,均可开启此功能。

### --pd-version

- 指定 PD 的版本。指定后,PD 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,PD 的版本与集群版本保持一致。

### --tikv-version

- 指定 TiKV 的版本。指定后,TiKV 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiKV 的版本与集群版本保持一致。

### --tikv-cdc-version

- 指定 TiKV CDC 的版本。指定后,TiKV CDC 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiKV CDC 的版本与集群版本保持一致。

### --tiflash-version

- 指定 TiFlash 的版本。指定后,TiFlash 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiFlash 的版本与集群版本保持一致。

### --cdc-version

- 指定 TiCDC 的版本。指定后,TiCDC 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiCDC 的版本与集群版本保持一致。

### --tiproxy-version

- 指定 TiProxy 的版本。指定后,TiProxy 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiProxy 的版本与集群版本保持一致。

### --tidb-dashboard-version

- 指定 TiDB Dashboard 的版本。指定后,TiDB Dashboard 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,TiDB Dashboard 的版本与集群版本保持一致。

### --alertmanager-version

- 指定 alert manager 的版本。指定后,alert manager 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,alert manager 的版本与集群版本保持一致。

### --blackbox-exporter-version

- 指定 Blackbox Exporter 的版本。指定后,Blackbox Exporter 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,Blackbox Exporter 的版本与集群版本保持一致。

### --node-exporter-version

- 指定 Node Exporter 的版本。指定后,Node Exporter 的版本将不再与集群版本保持一致。
- 数据类型:`STRINGS`
- 不指定该选项时,Node Exporter 的版本与集群版本保持一致。

### -h, --help

- 输出帮助信息。
Expand All @@ -57,4 +123,4 @@ tiup cluster upgrade <cluster-name> <version> [flags]

升级服务的日志。

[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
[<< 返回上一页 - TiUP Cluster 命令清单](/tiup/tiup-component-cluster.md#命令清单)
Loading