tiup cluster deploy

The tiup cluster deploy command is used to deploy a new cluster.

Syntax

tiup cluster deploy <cluster-name> <version> <topology.yaml> [flags]

• <cluster-name>: the name of the new cluster, which cannot be the same as the existing cluster names.
• <version>: the version number of the TiDB cluster to deploy, such as v5.3.4.
• <topology.yaml>: the prepared topology file.

Options

-u, --user

• Specifies the user name used to connect to the target machine. This user must have the secret-free sudo root permission on the target machine.
• Data type: STRING
• Default: the current user who executes the command.

-i, --identity_file

• Specifies the key file used to connect to the target machine.
• Data type: STRING
• If this option is not specified in the command, the ~/.ssh/id_rsa file is used to connect to the target machine by default.

-p, --password

• Specifies the password used to connect to the target machine. Do not use this option with -i/--identity_file at the same time.
• Data type: BOOLEAN
• This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

--ignore-config-check

• This option is used to skip the configuration check. After the binary files of components are deployed, the configurations of TiDB, TiKV, and PD components are checked using <binary> --config-check <config-file>. <binary> is the path of the deployed binary file. <config-file> is the configuration file generated based on the user configuration.
• This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.
• Default: false

--no-labels

• This option is used to skip the label check.
• When two or more TiKV nodes are deployed on the same physical machine, a risk exists: PD cannot learn the cluster topology, so PD might schedule multiple replicas of a Region to different TiKV nodes on one physical machine, which makes this physical machine a single point. To avoid this risk, you can use labels to tell PD not to schedule the same Region to the same machine. See Schedule Replicas by Topology Labels for label configuration.
• For the test environment, this risk might matter and you can use --no-labels to skip the check.
• Data type: BOOLEAN
• This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

--skip-create-user

• During the cluster deployment, tiup-cluster checks whether the specified user name in the topology file exists or not. If not, it creates one. To skip this check, you can use the --skip-create-user option.
• Data type: BOOLEAN
• This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

-h, --help

• Prints help information.
• Data type: BOOLEAN
• This option is disabled by default and its default value is false. To enable this option, you can add this option to the command, and pass the true value or do not pass any value.

Output

The deployment log.

<< Back to the previous page - TiUP Cluster command list