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.

Sign up for GitHub

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

Jump to bottom

Document pre/post upgrade and reload scripts #17611

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Document pre/post upgrade and reload scripts #17611

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99a282a
Document pre/post upgrade and reload scripts
dveeden May 23, 2024
3f71a0c
Apply suggestions from code review
dveeden Jun 26, 2024
e7709cd
Merge remote-tracking branch 'upstream/master' into tiup_pre_post_scr…
dveeden Jul 5, 2024
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
20 changes: 20 additions & 0 deletions tiup/tiup-component-cluster-reload.md
View file
Open in desktop
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.

- Run a script before the reload.
- Data type: `STRINGS`
- This option specifies the path of the command that will be ran on the host that is to be reloaded.
dveeden marked this conversation as resolved.
Show resolved Hide resolved

### --post-restart-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.

- Run a script after the reload.
- Data type: `STRINGS`
- This option specifies the path of the command that will be ran on the host that was reloaded.
dveeden marked this conversation as resolved.
Show resolved Hide resolved

## Output

The execution log of the tiup-cluster.
Expand Down
20 changes: 20 additions & 0 deletions tiup/tiup-component-cluster-upgrade.md
View file
Open in desktop
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.

- Run a script before the upgrade.
- Data type: `STRINGS`
- This option specifies the path of the command that will be ran on the host that is to be upgraded.
dveeden marked this conversation as resolved.
Show resolved Hide resolved

### ---post-upgrade-script

> **Warning:**
>
> This option is experimental and is not recommended for production deployments.

- Run a script after the upgrade.
- Data type: `STRINGS`
- This option specifies the path of the command that will be ran after the upgrade of a host. This command will be executed on the upgraded host itself.
dveeden marked this conversation as resolved.
Show resolved Hide resolved

## Output

The log of the upgrading progress.
Expand Down
Loading