Doc Menu

Quick Start Guide for the TiDB Database Platform


For production environments, do not deploy TiDB with the following two methods. Instead, it is recommended that you deploy TiDB using TiUP.

This document describes how to try out TiDB, a distributed SQL database, in a few minutes. You can choose any of the following two methods to get started with the TiDB database platform:

Deploy a local test environment using TiUP Playground

  • Scenario: Quickly deploy a TiDB cluster on a local Mac or Linux OS machine. You can see the basic architecture of TiDB and how TiDB, TiKV, PD, monitoring, and other components run in a TiDB cluster.
  • Time required: 1 minute


Currently, some TiDB components do not have a released version that supports the Apple M1 chip. Therefore, the tiup playground command currently cannot be executed on the local Mac machine that uses the Apple M1 chip.

As a distributed system, a basic TiDB test cluster usually consists of 2 TiDB instances, 3 TiKV instances, 3 PD instances, and optional TiFlash instances. With TiUP Playground, you can quickly build the above test cluster by taking the following steps:

  1. Download and install TiUP:

    curl --proto '=https' --tlsv1.2 -sSf | sh
  2. Declare the global environment variable:


    After the installation, TiUP displays the absolute path of the corresponding profile file. You need to modify the following source command according to the path.

    source .bash_profile
  3. Start the cluster in the current session:

    • If you want to start a TiDB cluster of the latest version with 1 TiDB instance, 1 TiKV instance, 1 PD instance, and 1 TiFlash instance, run the following command:

      tiup playground
    • If you want to specify the TiDB version and the number of the instances of each component, run a command like this:

      tiup playground v5.0.0 --db 2 --pd 3 --kv 3 --monitor

      The command downloads a version cluster to the local machine and starts it, such as v5.0.0. --monitor means that the monitoring component is also deployed.

      To view the latest version, run tiup list tidb.

      This command returns the access methods of the cluster:

      To connect TiDB: mysql --host --port 4000 -u root
      To connect TiDB: mysql --host --port 4001 -u root
      To view the dashboard:
      To view the monitor:


      For the playground operated in this way, after the test is finished, TiUP will clean up the original cluster data. You will get a new cluster after re-running the command. If you want the data to be persisted on storage,run tiup --tag <your-tag> playground .... For details, refer to TiUP Reference Guide.

  4. Start a new session to access TiDB:

    • Use the TiUP client to connect to TiDBs.

      tiup client
    • You can also use the MySQL client to connect to TiDB.

      mysql --host --port 4000 -u root
  5. Access the Prometheus dashboard of TiDB at

  6. Access the TiDB Dashboard at The default username is root, with an empty password.

  7. (Optional) Load data to TiFlash for analysis.

  8. After the test, you can clean the cluster by taking the following steps:

    1. Stop the process by pressing ctrl-c.

    2. Run the following command:

      tiup clean --all


TiUP Playground listens on by default, and the service is only locally accessible; if you want the service to be externally accessible, you can specify the listening address using the --host parameter to bind the network interface card (NIC) to an externally accessible IP address.

Set up a test environment on a single machine using TiUP cluster

  • Scenario: Experience a smallest TiDB cluster with the complete topology and simulate the production deployment steps on a single Linux server.
  • Time required: 10 minutes

This section describes how to deploy a TiDB cluster using a YAML file of the smallest topology in TiUP.


Prepare a target machine that meets the following requirements:

  • CentOS 7.3 or a later version is installed
  • The Linux OS has access to the Internet, which is required to download TiDB and related software installation packages

The smallest TiDB cluster topology is as follows:

Avoid conflict between the port and the directory
TiDB110.0.1.1The default port
Global directory configuration
PD110.0.1.1The default port
Global directory configuration
TiFlash110.0.1.1The default port
Global directory configuration
Monitor110.0.1.1The default port
Global directory configuration

Other requirements for the target machine:

  • The root user and its password is required

  • Stop the firewall service of the target machine, or open the port needed by the TiDB cluster nodes

  • Currently, TiUP supports deploying TiDB on the x86_64 (AMD64 and ARM) architectures:

    • It is recommended to use CentOS 7.3 or later versions on AMD64
    • It is recommended to use CentOS 7.6 1810 on ARM



You can log in to the target machine as a regular user or the root user. The following steps use the root user as an example.

  1. Download and install TiUP:

    curl --proto '=https' --tlsv1.2 -sSf | sh
  2. Install the cluster component of TiUP:

    tiup cluster
  3. If the TiUP cluster is already installed on the machine, update the software version:

    tiup update --self && tiup update cluster
  4. Use the root user privilege to increase the connection limit of the sshd service. This is because TiUP needs to simulate deployment on multiple machines.

    1. Modify /etc/ssh/sshd_config, and set MaxSessions to 20.

    2. Restart the sshd service:

      service sshd restart
  5. Create and start the cluster:

    Edit the configuration file according to the following template, and name it as topo.yaml:

    # # Global variables are applied to all deployments and used as the default value of
    # # the deployments if a specific deployment value is missing.
     user: "tidb"
     ssh_port: 22
     deploy_dir: "/tidb-deploy"
     data_dir: "/tidb-data"
    # # Monitored variables are applied to all the machines.
     node_exporter_port: 9100
     blackbox_exporter_port: 9115
       log.slow-threshold: 300
     tikv: false
       readpool.coprocessor.use-unified-pool: true
       replication.enable-placement-rules: true
       replication.location-labels: ["host"]
       logger.level: "info"
     - host:
     - host:
     - host:
       port: 20160
       status_port: 20180
         server.labels: { host: "logic-host-1" }
     - host:
       port: 20161
       status_port: 20181
         server.labels: { host: "logic-host-2" }
     - host:
       port: 20162
       status_port: 20182
         server.labels: { host: "logic-host-3" }
     - host:
     - host:
     - host:
    • user: "tidb": Use the tidb system user (automatically created during deployment) to perform the internal management of the cluster. By default, use port 22 to log in to the target machine via SSH.
    • replication.enable-placement-rules: This PD parameter is set to ensure that TiFlash runs normally.
    • host: The IP of the target machine.
  6. Execute the cluster deployment command:

    tiup cluster deploy <cluster-name> <tidb-version> ./topo.yaml --user root -p
    • <cluster-name>: Set the cluster name
    • <tidb-version>: Set the TiDB cluster version. You can see all the supported TiDB versions by running the tiup list tidb command

    Enter "y" and the root user's password to complete the deployment:

    Do you want to continue? [y/N]:  y
    Input SSH password:
  7. Start the cluster:

    tiup cluster start <cluster-name>
  8. Access the cluster:

    • Install the MySQL client. If it is already installed, skip this step.

      yum -y install mysql
    • Access TiDB. The password is empty:

      mysql -h -P 4000 -u root
    • Access the Grafana monitoring dashboard at http://{grafana-ip}:3000. The default username and password are both admin.

    • Access the TiDB Dashboard at http://{pd-ip}:2379/dashboard. The default username is root, and the password is empty.

    • To view the currently deployed cluster list:

      tiup cluster list
    • To view the cluster topology and status:

      tiup cluster display <cluster-name>

What's next


By default, TiDB, TiUP and TiDB Dashboard share usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see Telemetry.