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: add 3 docs disable/display/list #5176

Merged
merged 16 commits into from
Apr 7, 2021
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
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
2 changes: 1 addition & 1 deletion tiflash/tiflash-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ delta_index_cache_size = 0

## Storage paths settings take effect starting from v4.0.9
[storage]
## [Experimental] New in v5.0. This item limits the total write rate of background tasks in bytes per second. It is not recommanded to use this experimental feature in a production environment.
## [Experimental] New in v5.0. This item limits the total write rate of background tasks in bytes per second. It is not recommended to use this experimental feature in a production environment.
Joyinqin marked this conversation as resolved.
Show resolved Hide resolved
## The unit is bytes. Currently, the setting such as "10GB" is not supported.
## The default value is 0, which means no limit.
## This parameter is used to control the usage of machine disk bandwidth by background tasks mainly for the scenario where TiFlash is deployed on the AWS EBS (gp2/gp3) disk.
Expand Down
47 changes: 47 additions & 0 deletions tiup/tiup-component-cluster-disable.md
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.
65 changes: 65 additions & 0 deletions tiup/tiup-component-cluster-display.md
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.
Joyinqin marked this conversation as resolved.
Show resolved Hide resolved

## 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 in the [cluster list](/tiup/tiup-component-cluster-list.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<cluster-name>`: the name of the cluster to operate on. If you forget the cluster name, you can check it in the [cluster list](/tiup/tiup-component-cluster-list.md).
`<cluster-name>`: the name of the cluster to operate on. If you forget the cluster name, you can check it with the command [cluster list](/tiup/tiup-component-cluster-list.md).


## Options

### --dashboard

- By default, all node information of the entire cluster is displayed. After adding the `--dashboard` option, only dashboard information is displayed.
Joyinqin marked this conversation as resolved.
Show resolved Hide resolved
- 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
35 changes: 35 additions & 0 deletions tiup/tiup-component-cluster-list.md
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