TiUP: add three docs for cluster start, stop, and more info

tiup/tiup-component-cluster-start.md

@@ -0,0 +1,47 @@
+---
+title: tiup cluster start
+---
+
+# tiup cluster start
+
+The `tiup cluster start` command is used to start all services or some services of the specified cluster.
+
+## Syntax
+
+```sh
+tiup cluster start <cluster-name> [flags]
+```
+
+`<cluster-name>` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md).
+
+## Options
+
+### -N, --node
+
+Specifies the IDs of the nodes to start, splitting by commas if starting multiple nodes. The node IDs are in the first column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table.
+Data type: `STRING`
+Default: []. If this option is not specified in the command, the command starts all the nodes.
+
+> **Note:**
+> 
+> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles will be started.
+
+### -R, --role strings
+
+Specifies the roles to be started, splitting by commas if starting multiple roles. The roles are in the second column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table.
+Data type: `STRING`
+Default: []. If this option is not specified in the command, the command starts all the roles.
+
+> **Note:**
+> 
+> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles will be started.
+
+### -h, --help
+
+- Prints the help information.
+- 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.
+
+## Output
+
+The output contains the starting logs.

tiup/tiup-component-cluster-stop.md

@@ -0,0 +1,51 @@
+---
+title: tiup cluster stop
+---
+
+# tiup cluster stop
+
+The `tiup cluster stop` command is used to stop all services or some services of the specified cluster.
+
+> **Note:**
+> 
+> If the core services of a cluster are stopped, the cluster cannot provide services anymore.
+
+## Syntax
+
+```sh
+tiup cluster stop <cluster-name> [flags]
+```
+
+``<cluster-name>` is the name of the cluster to operate on. If you forget the cluster name, check it in [tiup cluster list](/tiup/tiup-component-cluster-list.md).
+
+## Options
+
+### -N, --node
+
+Specifies the IDs of the nodes to stop, splitting by commas for multiple nodes. The node IDs are in the first column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table.
+Data type: `STRING`
+Default: []. If this option is not specified in the command, the command stops all the nodes.
+
+> **Note:**
+> 
+> If `-R, --role` is also specified, only the services in the intersection of the specified nodes and roles are stopped.
+
+### -R, --role strings
+
+Specifies the roles to stop, splitting by commas for multiple roles. The roles are in the second column of the [tiup cluster display](/tiup/tiup-component-cluster-display.md) table.
+Data type: `STRING`
+Default: []. If this option is not specified in the command, the command stops all the roles.
+
+> **Note:**
+> 
+> If `-N, --node` is also specified, only the services in the intersection of the specified nodes and roles are stopped.
+
+### -h, --help
+
+- Prints the help information.
+- 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.
+
+## Output
+
+The output contains the stopping logs.

tiup/tiup-component-cluster.md

@@ -0,0 +1,83 @@
+---
+title: TiUP cluster
+---
+
+# TiUP Cluster
+
+TiUP Cluster is a cluster management component of TiUP written in Golang. You can use the TiUP Cluster component to perform daily operations and maintenance tasks, including deploying, starting, shutting down, destroying, elastic scaling, upgrading TiDB clusters, and managing TiDB cluster parameters.
+
+## Syntax
+
+```shell
+tiup cluster [command] [flags]
+```
+
+`[command]` is the command name as in the following command list:
+
+## Options
+
+### --ssh
+
+- Specifies the SSH client to connect to the remote end (the machine where the TiDB service is deployed) for the command execution.
+- Data type: `STRING`
+- Supported values:
+
+  - `builtin`: uses the easyssh client built in tiup-cluster as the SSH client.
+  - `system`: uses the default SSH client of the current operating system.
+  - `none`: The SSH client is not used. The deployment is only for the current machine.
+
+- The option is enabled by default with `builtin` (the default value) passed in.
+
+### --ssh-timeout
+
+- Specifies the SSH connection timeout in seconds.
+- Data type: `UINT`
+- The option is enabled by default with `5` seconds (the default value) passed in.
+
+### --wait-timeout
+
+- Specifies the maximum waiting time (in seconds) for each step in the operation process. The operation process consists of many steps, such as specifying systemctl to start or stop services, and waiting for ports to be online or offline. Each step may take several seconds. If the execution time of a step exceeds the specified timeout, the step exits with an error.
+- Data type: `UINT`
+- The option is enabled by default with `120` seconds (the default value) passed in.
+
+### -y, --yes
+
+- Skips the secondary confirmation of all risky operations. Using this option is not recommended, unless you are using a script to call TiUP.
+- 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.
+
+### -v, --version
+
+- Prints the current version of TiUP Cluster.
+- 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.
+
+### -h, --help (boolean, default false)
+
+- Prints the help information of the related commands.
+- 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.
+
+## List of commands
+
+- [import](/tiup/tiup-component-cluster-import.md): import a cluster deployed by Ansible
+- [check](/tiup/tiup-component-cluster-check.md): check a cluster before and after the deployment
+- [deploy](/tiup/tiup-component-cluster-deploy.md): deploy a cluster based on a specified topology
+- [list](/tiup/tiup-component-cluster-list.md): query the list of deployed clusters
+- [display](/tiup/tiup-component-cluster-display.md): display the status of a specified cluster
+- [start](/tiup/tiup-component-cluster-start.md): start a specified cluster
+- [stop](/tiup/tiup-component-cluster-stop.md): stop a specified cluster
+- [restart](/tiup/tiup-component-cluster-restart.md): restart a specified cluster
+- [scale-in](/tiup/tiup-component-cluster-scale-in.md): scale in a specified cluster
+- [scale-out](/tiup/tiup-component-cluster-scale-out.md): scale out a specified cluster
+- [upgrade](/tiup/tiup-component-cluster-upgrade.md): upgrade a specified cluster
+- [prune](/tiup/tiup-component-cluster-prune.md): clean up the instances in the Tombstone status for a specified cluster
+- [edit-config](/tiup/tiup-component-cluster-edit-config.md): modify the configuration of a specified cluster
+- [reload](/tiup/tiup-component-cluster-reload.md): reload the configuration of a specified cluster
+- [patch](/tiup/tiup-component-cluster-patch.md): replace a service in a deployed cluster
+- [rename](/tiup/tiup-component-cluster-rename.md): rename a cluster
+- [clean](/tiup/tiup-component-cluster-clean.md): delete data from the specified cluster
+- [destroy](/tiup/tiup-component-cluster-destroy.md): destroy a specified cluster
+- [audit](/tiup/tiup-component-cluster-audit.md): query the operation audit log of a specified cluster
+- [enable](/tiup/tiup-component-cluster-enable.md): enable a specified cluster or service to start on boot
+- [disable](/tiup/tiup-component-cluster-disable.md): disable a specified cluster or service to start on boot
+- [help](/tiup/tiup-component-cluster-help.md): print help information