Skip to content

Commit

Permalink
Document pre/post upgrade and reload scripts (#17611) (#18336)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Jul 24, 2024
1 parent d43a993 commit 02c8c0e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
20 changes: 20 additions & 0 deletions tiup/tiup-component-cluster-reload.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,26 @@ After you specify the `--skip-restart` option, it only refreshes the configurati
- Data type: `BOOLEAN`
- Default: false

### --pre-restart-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.
- Runs a script before the reload.
- Data type: `STRINGS`
- This option specifies the path of a script to be run on the node that is to be reloaded. It does not take effect when `--skip-restart` is set to `true`.

### --post-restart-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.
- Runs a script after the reload.
- Data type: `STRINGS`
- This option specifies the path of a script to be run after the reload of a node. It does not take effect when `--skip-restart` is set to `true`.

## Output

The execution log of the tiup-cluster.
Expand Down
20 changes: 20 additions & 0 deletions tiup/tiup-component-cluster-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,26 @@ tiup cluster upgrade <cluster-name> <version> [flags]
- 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.

### ---pre-upgrade-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.
- Runs a script before the upgrade.
- Data type: `STRINGS`
- This option specifies the path of a script to be run on the node that is to be upgraded.

### ---post-upgrade-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.
- Runs a script after the upgrade.
- Data type: `STRINGS`
- This option specifies the path of a script to be run after the upgrade of a node. This script will be executed on the upgraded node itself.

## Output

The log of the upgrading progress.
Expand Down

0 comments on commit 02c8c0e

Please sign in to comment.