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 #16917

Merged
merged 4 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
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
12 changes: 6 additions & 6 deletions tiproxy/tiproxy-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,6 @@ Configuration for SQL port.
+ Possible values: ``, `v2`
+ Enable the [PROXY protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) on the port. By enabling the PROXY protocol, TiProxy can pass the real client IP address to TiDB. `v2` indicates using the PROXY protocol version 2, and `` indicates disabling the PROXY protocol. If the PROXY protocol is enabled on TiProxy, you need to also enable the [PROXY protocol](/tidb-configuration-file.md#proxy-protocol) on the TiDB server.

#### `require-backend-tls`

+ Default value: `true`
+ Support hot-reload: yes, but only for new connections
+ Require TLS between TiProxy and TiDB servers. If the TiDB server doesn't support TLS, clients will report an error when connecting to TiProxy.

### api

Configurations for HTTP gateway.
Expand Down Expand Up @@ -194,6 +188,12 @@ For server TLS object:

A client TLS object. It is used to access TiDB or PD.

#### `require-backend-tls`

+ Default value: `false`
+ Support hot-reload: yes, but only for new connections
+ Require TLS between TiProxy and TiDB servers. If the TiDB server doesn't support TLS, clients will report an error when connecting to TiProxy.
Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved

#### `sql-tls`

A client TLS object. It is used to access TiDB SQL port (4000).
Expand Down
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 @@ It is recommended that you use TiProxy for the scenarios that TiProxy is suitabl

## Installation and usage

This section describes how to deploy and change TiProxy using TiUP. For how to deploy TiProxy using TiDB Operator in Kubernetes, see [TiDB Operator documentation](https://docs.pingcap.com/tidb-in-kubernetes/stable).
This section describes how to deploy and change TiProxy using TiUP. For how to deploy TiProxy using TiDB Operator in Kubernetes, see [TiDB Operator documentation](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy).

### Deploy TiProxy

Expand Down Expand Up @@ -126,7 +126,7 @@ When using TiUP to change the TiProxy configuration, if the configuration item t

When you deploy TiProxy, it is recommended to specify the version of TiProxy so that TiProxy will not be upgraded when you upgrade the TiDB cluster.

If you need to upgrade TiProxy, add [`--tiproxy-version`](/tiup/tiup-component-cluster-upgrade.md) in the upgrade command to specify the version of TiProxy:
If you need to upgrade TiProxy, add [`--tiproxy-version`](/tiup/tiup-component-cluster-upgrade.md#--tiproxy-version) in the upgrade command to specify the version of TiProxy:

```shell
tiup cluster upgrade <cluster-name> <version> --tiproxy-version <tiproxy-version>
Expand Down
66 changes: 66 additions & 0 deletions tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,78 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- Data type: `BOOLEAN`
- Default: false

### --ignore-version-check

- Before upgrading, TiUP checks whether the target version is greater than or equal to the current version. To skip this check, you can use the `--ignore-version-check` option.
- Data type: `BOOLEAN`
- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value.

### --offline

- Declares that the current cluster is not running. When this option is specified, TiUP does not evict the service leader to another node or restart the service, but only replaces the binary files of the cluster components.
- Data type: `BOOLEAN`
- This option is disabled by default with the `false` value. To enable this option, add this option to the command, and either pass the `true` value or do not pass any value.

### --pd-version

- Specifies the version of PD. If this option is set, the version of PD will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of PD remains consistent with the cluster version.

### --tikv-version

- Specifies the version of TiKV. If this option is set, the version of TiKV will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiKV remains consistent with the cluster version.

### --tikv-cdc-version

- Specifies the version of TiKV CDC. If this option is set, the version of TiKV CDC will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiKV CDC remains consistent with the cluster version.

### --tiflash-version

- Specifies the version of TiFlash. If this option is set, the version of TiFlash will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiFlash remains consistent with the cluster version.

### --cdc-version

- Specifies the version of TiCDC. If this option is set, the version of TiCDC will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiCDC remains consistent with the cluster version.

### --tiproxy-version

- Specifies the version of TiProxy. If this option is set, the version of TiProxy will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiProxy remains consistent with the cluster version.

### --tidb-dashboard-version

- Specifies the version of TiDB Dashboard. If this option is set, the version of TiDB Dashboard will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of TiDB Dashboard remains consistent with the cluster version.

### --alertmanager-version

- Specifies the version of alert manager. If this option is set, the version of alert manager will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of alert manager remains consistent with the cluster version.

### --blackbox-exporter-version

- Specifies the version of Blackbox Exporter. If this option is set, the version of Blackbox Exporter will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of Blackbox Exporter remains consistent with the cluster version.

### --node-exporter-version

- Specifies the version of Node Exporter. If this option is set, the version of Node Exporter will no longer be consistent with the cluster version.
- Data type: `STRINGS`
- If this option is not set, the version of Node Exporter remains consistent with the cluster version.

### -h, --help

Oreoxmt marked this conversation as resolved.
Show resolved Hide resolved
- Prints the help information.
Expand Down