TiDBTiDB Docs Dash 2024

Jan 9 - Jan 12 (UTC)
Join us to improve docs and win a prize!
Sign InTry Free

tiup dm scale-out

The tiup dm scale-out command is used for scaling out the cluster. The internal logic of scaling out the cluster is similar to the cluster deployment. The tiup-dm components first establish an SSH connection to the new node, create the necessary directories on the target node, then perform the deployment and start the service.

Syntax

tiup dm scale-out <cluster-name> <topology.yaml> [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 command.

<topology.yaml>: the prepared topology file. This topology file should only contain the new nodes that are to be added to the current cluster.

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 and -i/--identity_file at the same time.
  • Data type: BOOLEAN
  • Default: false

-h, --help

  • Prints the help information.
  • Data type: BOOLEAN
  • Default: false

Output

The log of scaling out.

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

Was this page helpful?

Download PDFRequest docs changesAsk questions on Discord
Playground
New
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
Products
TiDB
TiDB Dedicated
TiDB Serverless
Pricing
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.