-
Notifications
You must be signed in to change notification settings - Fork 710
tiup: add 3 docs disable/display/list #5176
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
16 commits
Select commit
Hold shift + click to select a range
4d88170
Create tiup-component-cluster-help.md
Joyinqin de2c0e5
Merge remote-tracking branch 'upstream/master' into tiup-joyin5
Joyinqin 682de4e
Merge remote-tracking branch 'upstream/master' into tiup-joyin5
Joyinqin 747d00c
add 2 docs
Joyinqin 1e1b994
Merge remote-tracking branch 'upstream/master' into tiup-joyin5
Joyinqin 2f106f4
Revert "Create tiup-component-cluster-help.md"
Joyinqin b43e448
refine the docs
Joyinqin 2305fde
Update tiup-component-cluster-disable.md
Joyinqin e4473bc
Merge remote-tracking branch 'upstream/master' into tiup-joyin5
Joyinqin 925c901
refine the docs
Joyinqin c7a3e71
Apply suggestions from code review
Joyinqin 2906c6c
Merge remote-tracking branch 'upstream/master' into tiup-joyin5
Joyinqin 308350e
address comments
Joyinqin aac0122
Update tiup-component-cluster-display.md
Joyinqin 7f33f58
Apply suggestions from code review
Joyinqin 774e388
Update tiflash-configuration.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: tiup cluster disable | ||
| --- | ||
|
|
||
| # tiup cluster disable | ||
|
|
||
| The `tiup cluster disable` command is used to disable the auto-enabling after restarting the machine where the cluster service is located. This command executes the `systemctl disable <service>` on the specified node to disable the auto-enabling of the service. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster disable <cluster-name> [flags] | ||
| ``` | ||
|
|
||
| `<cluster-name>`: the cluster whose auto-enabling service is to be disabled. | ||
|
|
||
| ## Options | ||
|
|
||
| ### -N, --node | ||
|
|
||
| - Data type: `strings` | ||
| - Default: `[]`, which means no node is selected. | ||
| - Specifies the nodes whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If the `-R, --role` option is specified at the same time, the auto-enabling of services in their intersection is disabled. | ||
|
|
||
| ### -R, --role strings | ||
|
|
||
| - Data type: `strings` | ||
| - Default: `[]`, which means no role is selected. | ||
| - Specifies the roles whose auto-enabling service is to be disabled. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If the `-N, --node` option is specified at the same time, the auto-enabling of services in their intersection is disabled. | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Outputs the help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Output | ||
|
|
||
| The execution log of the 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,65 @@ | ||
| --- | ||
| title: tiup cluster display | ||
| --- | ||
|
|
||
| # tiup cluster display | ||
|
|
||
| If you want to see the operation status of each component in the cluster, it is obviously inefficient to log in to each machine one by one. Therefore, tiup-cluster provides the `tiup cluster display` command to efficiently complete this task. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster display <cluster-name> [flags] | ||
| ``` | ||
|
|
||
| `<cluster-name>`: the name of the cluster to operate on. If you forget the cluster name, you can check it with the [cluster list](/tiup/tiup-component-cluster-list.md) command. | ||
|
|
||
| ## Options | ||
|
|
||
| ### --dashboard | ||
|
|
||
| - By default, all node information of the entire cluster is displayed. With the `--dashboard` option, only dashboard information is displayed. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ### -N, --node | ||
|
|
||
| - Data type: `strings` | ||
| - Default: `[]`, which means all nodes. | ||
| - Specifies the node to query. If not specified, all nodes are queried. The value of this option is a comma-separated list of node IDs. The node ID is the first column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If the `-R, --role` option is specified at the same time, then the service status in their intersection is queried. | ||
|
|
||
| ### -R, --role strings | ||
|
|
||
| - Data type: `strings` | ||
| - Default: `[]`, which means all roles. | ||
| - Specifies the role to query. If not specified, all roles are queried. The value of this option is a comma-separated list of node roles. The role is the second column of the [cluster status](/tiup/tiup-component-cluster-display.md) table. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If the `-N, --node` option is specified at the same time, then the service status in their intersection is queried. | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Prints the help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Outputs | ||
|
|
||
| - The cluster name | ||
| - The cluster version | ||
| - SSH Client Type | ||
| - Dashboard address | ||
| - The table with the following fields: | ||
| - ID: the node ID, composed of `IP:PORT` | ||
| - Role: the service role deployed on this node (such as TiDB, TiKV) | ||
| - Host: the IP of the machine corresponding to the node | ||
| - Ports: the port number occupied by the service | ||
| - OS/Arch: the operating system and the machine architecture of this node | ||
| - Status: the current status of the node service | ||
| - Data Dir: the data directory of the service. `-` means no data directory. | ||
| - Deploy Dir: the deployment directory of the service | ||
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,35 @@ | ||
| --- | ||
| title: tiup cluster list | ||
| --- | ||
|
|
||
| # tiup cluster list | ||
|
|
||
| tiup-cluster supports deploying multiple clusters using the same control machine. The `tiup cluster list` command outputs all clusters deployed by the currently logged-in user using this control machine. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > The deployed cluster data is stored in the `~/.tiup/storage/cluster/clusters/` directory by default, so on the same control machine, the currently logged-in user cannot view the clusters deployed by other users. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```shell | ||
| tiup cluster list [flags] | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ### -h, --help | ||
|
|
||
| - Prints help information. | ||
| - Data type: `BOOLEAN` | ||
| - Default: false | ||
|
|
||
| ## Outputs | ||
|
|
||
| Outputs the table with the following fields: | ||
|
|
||
| - Name: the cluster name | ||
| - User: the deployment user | ||
| - Version: the cluster version | ||
| - Path: the path of the cluster deployment data on the control machine | ||
| - PrivateKey: the path of the private key that is used to connect the cluster |
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.
Uh oh!
There was an error while loading. Please reload this page.