Doc Menu

TiUP DM

Similar to TiUP Cluster which is used to manage TiDB clusters, TiUP DM is used to manage DM clusters. You can use the TiUP DM component to perform daily operations and maintenance tasks of DM clusters, including deploying, starting, stopping, destroying, elastic scaling, upgrading DM clusters, and managing the configuration parameters of DM clusters.

Syntax

tiup dm [command] [flags]

[command] is used to pass the name of the command. See the Command list for supported commands.

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

  • Support values:

    • builtin: Uses the built-in easyssh client of tiup-cluster as the SSH client.
    • system: Uses the default SSH client of the current operating system.
    • none: No SSH client is 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 steps is 120 seconds.

-y, --yes

  • Skips the secondary confirmation of all risky operations. It is not recommended to use this option unless you use a script to call TiUP.
  • 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.

-v, --version

  • Prints the current version of TiUP DM.
  • 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 help information about the specified command.
  • 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 DM v1.0 cluster deployed by DM-Ansible.
  • template: Outputs the topology template.
  • 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 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 specified service in a deployed cluster.
  • destroy: Destroys a specified cluster.
  • audit: Queries the operation audit log of a specified cluster.
  • replay: Replays the specified commands
  • 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.
  • help: Prints help information.

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