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, including deploying, starting, shutting down, destroying, elastic scaling, upgrading TiDB clusters, and managing TiDB cluster parameters.

Syntax

tiup cluster [command] [flags]

[command] is the name of the command. For the supported commands, refer to the command list below.

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.
If this option is not specified in the command, builtin is used as the default value.

--ssh-timeout

Specifies the SSH connection timeout in seconds.
Data type: UINT
If this option is not specified in the command, the default timeout is 5 seconds.

--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
If this option is not specified in the command, the maximum waiting time for each step is 120 seconds.

-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

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.

Command list

import: imports a cluster deployed by Ansible
template: outputs the topology template
check: checks a cluster before and after the deployment
deploy: deploys a cluster based on a specified topology
list: queries the list of deployed clusters
display: displays the status of a specified cluster
start: starts a specified cluster
stop: stops a specified cluster
restart: restarts a specified cluster
scale-in: scales in a specified cluster
scale-out: scales out a specified cluster
upgrade: upgrades a specified cluster
prune: cleans up the instances in the Tombstone status for a specified cluster
edit-config: modifies the configuration of a specified cluster
reload: reloads the configuration of a specified cluster
patch: replaces a service in a deployed cluster
rename: renames a cluster
clean: deletes data from the specified cluster
destroy: destroys a specified cluster
audit: queries the operation audit log of a specified cluster
replay: retries the specified command
enable: enables the auto-enabling of the cluster service after a machine is restarted
disable: disables the auto-enabling of the cluster service after a machine is restarted
meta backup: backs up the TiUP meta file required for the operation and maintenance of a specified cluster
meta restore: restores the TiUP meta file of a specified cluster
help: prints the help information

<< Back to the previous page - TiUP Reference component list