Testing Deployment from Binary Tarball

This guide provides installation instructions for all TiDB components across multiple nodes for testing purposes. It does not match the recommended usage for production systems.

See also local deployment and production environment deployment.

Prepare

Before you start, see TiDB architecture and Software and Hardware Recommendations. Make sure the following requirements are satisfied:

Operating system

For the operating system, it is recommended to use RHEL/CentOS 7.3 or higher. The following additional requirements are recommended:

Network and firewall

Operating system parameters

Database running user settings

TiDB components and default ports

Before you deploy a TiDB cluster, see the required components and optional components.

TiDB database components (required)

See the following table for the default ports for the TiDB components:

TiDB database components (optional)

See the following table for the default ports for the optional TiDB components:

Create a database running user account

1. Log in to the machine using the root user account and create a database running user account (tidb) using the following command:

   # useradd tidb -m
   

2. Switch the user from root to tidb by using the following command. You can use this tidb user account to deploy your TiDB cluster.

   # su - tidb
   

Download the official binary package

# Download the package.
$ wget https://download.pingcap.org/tidb-v3.0-linux-amd64.tar.gz https://download.pingcap.org/tidb-v3.0-linux-amd64.sha256

# Check the file integrity. If the result is OK, the file is correct.
$ sha256sum -c tidb-v3.0-linux-amd64.sha256

# Extract the package.
$ tar -xzf tidb-v3.0-linux-amd64.tar.gz
$ cd tidb-v3.0-linux-amd64

Multiple nodes cluster deployment for test

If you want to test TiDB but have a limited number of nodes, you can use one PD instance to test the entire cluster.

Assuming that you have four nodes, you can deploy 1 PD instance, 3 TiKV instances, and 1 TiDB instance. See the following table for details:

Follow the steps below to start PD, TiKV and TiDB:

1. Start PD on Node1.

   $ ./bin/pd-server --name=pd1 \
                   --data-dir=pd \
                   --client-urls="http://192.168.199.113:2379" \
                   --peer-urls="http://192.168.199.113:2380" \
                   --initial-cluster="pd1=http://192.168.199.113:2380" \
                   --log-file=pd.log &
   

2. Start TiKV on Node2, Node3 and Node4.

   $ ./bin/tikv-server --pd="192.168.199.113:2379" \
                     --addr="192.168.199.114:20160" \
                     --data-dir=tikv \
                     --log-file=tikv.log &
   
   $ ./bin/tikv-server --pd="192.168.199.113:2379" \
                     --addr="192.168.199.115:20160" \
                     --data-dir=tikv \
                     --log-file=tikv.log &
   
   $ ./bin/tikv-server --pd="192.168.199.113:2379" \
                     --addr="192.168.199.116:20160" \
                     --data-dir=tikv \
                     --log-file=tikv.log &
   

3. Start TiDB on Node1.

   $ ./bin/tidb-server --store=tikv \
                     --path="192.168.199.113:2379" \
                     --log-file=tidb.log
   

4. Use the MySQL client to connect to TiDB.

   $ mysql -h 192.168.199.113 -P 4000 -u root -D test