-
Notifications
You must be signed in to change notification settings - Fork 711
tiup: add 3 docs component-help/prune/upgrade #5221
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
a760c5f
add 3 docs
Joyinqin 54fd085
Update tiup-component-cluster-upgrade.md
Joyinqin 7e8bc88
Apply suggestions from code review
Joyinqin 18c082a
Merge remote-tracking branch 'upstream/master' into tiup-joyin6
Joyinqin fa4c3a0
Update tiup-component-cluster-upgrade.md
Joyinqin eb09510
Merge remote-tracking branch 'upstream/master' into tiup-joyin6
Joyinqin 8541fc2
hide the link
Joyinqin 1887da8
Apply suggestions from code review
Joyinqin c5d1d7f
Apply suggestions from code review
Joyinqin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: tiup cluster help | ||
| --- | ||
|
|
||
| # tiup cluster help | ||
|
|
||
| tiup-cluster provides a wealth of help information for users in the command line interface. You can obtain it via the `help` command or the `--help` option. `tiup cluster help <command>` is basically equivalent to `tiup cluster <command> --help`. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster help [command] [flags] | ||
| ``` | ||
|
|
||
| `[command]` is used to specify the help information of which command that users need to view. If it is not specified, the help information of tiup-cluster is viewed. | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Prints the help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Output | ||
|
|
||
| The help information of the `[command]` or tiup-cluster. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: tiup cluster prune | ||
| --- | ||
|
|
||
| # tiup cluster prune | ||
|
|
||
| When [scaling in the cluster]<!-- (/tiup/tiup-component-cluster-scale-in.md) -->, for some components, TiUP does not immediately stop their services or delete their data. You need to wait for the data scheduling to complete and then manually execute the `tiup cluster prune` command to clean up. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster prune <cluster-name> [flags] | ||
| ``` | ||
|
|
||
| ## Option | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Prints the help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Output | ||
|
|
||
| The log of the cleanup process. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: tiup cluster upgrade | ||
| --- | ||
|
|
||
| # tiup cluster upgrade | ||
|
|
||
| The `tiup cluster upgrade` command is used to upgrade the specified cluster to a specific version. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster upgrade <cluster-name> <version> [flags] | ||
| ``` | ||
|
|
||
| - `<cluster-name>`: the cluster name to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-cluster-list.md) command. | ||
| - `<version>`: the target version to upgrade to. Currently, it is only allowed to upgrade to a version higher than the current cluster, that is, no downgrade is allowed. It is also not allowed to upgrade to the nightly version. | ||
|
|
||
| ## Options | ||
|
|
||
| ### --force | ||
|
|
||
| - To upgrade the cluster, you need to ensure that the cluster is currently started. In some cases, you might want to upgrade when the cluster is not started. At this time, you can use `--force` to ignore the error during the upgrade, forcibly replace the binary file and start the cluster. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| > **Note:** | ||
| > | ||
| > Forcing an upgrade of the cluster that is providing services might result in service unavailability. Unstarted clusters are started automatically after a successful upgrade. | ||
|
|
||
| ### --transfer-timeout | ||
|
|
||
| - When upgrading PD or TiKV, the leader of the upgraded node is migrated to other nodes first. The migration process takes some time, and you can set the maximum wait time (in seconds) by the `-transfer-timeout` option. After the timeout, the wait is skipped and the service is upgraded directly. | ||
| - Data type: `uint` | ||
| - Default: 300 | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If the wait is skipped and the service is upgraded directly, the service performance might jitter. | ||
|
|
||
| ### --ignore-config-check | ||
|
|
||
| - After the binary is updated, a configuration check is performed on the TiDB, TiKV and PD components using `<binary> --config-check <config-file>`. `<binary>` is the path to the newly deployed binary and `<config-file>` is the configuration file generated based on the user configuration. To skip this check, you can use the `--ignore-config-check` option. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Prints the help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Output | ||
|
|
||
| The log of the upgrading progress. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What this mean? Why comment the url?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To avoid ci check. After all prs are merged, we will add the url back.