TiDB Docker Compose Deployment

This document describes how to quickly deploy TiDB using Docker Compose.

With Docker Compose, you can use a YAML file to configure application services in multiple containers. Then, with a single command, you can create and start all the services from your configuration.

You can use Docker Compose to deploy a TiDB test cluster with a single command. It is required to use Docker 17.06.0 or later.

Quick start

  1. Download tidb-docker-compose.

    git clone https://github.com/pingcap/tidb-docker-compose.git
    
  2. Create and start the cluster.

    cd tidb-docker-compose && docker-compose up -d
    
  3. Access the cluster.

    mysql -h 127.0.0.1 -P 4000 -u root
    

    Access the Grafana monitoring interface:

    Access the cluster data visualization interface: http://localhost:8010

Customize the cluster

In Quick start, the following components are deployed by default:

  • 3 PD instances, 3 TiKV instances, 1 TiDB instance
  • Monitoring components: Prometheus,Pushgateway,Grafana
  • Data visualization component: tidb-vision

To customize the cluster, you can edit the docker-compose.yml file directly. It is recommended to generate docker-compose.yml using the Helm template engine, because manual editing is tedious and error-prone.

  1. Install Helm.

    Helm can be used as a template rendering engine. To use Helm, you only need to download its binary file:

    curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash
    

    For macOS, you can also install Helm using the following command in Homebrew:

    brew install kubernetes-helm
    
  2. Download tidb-docker-compose.

    git clone https://github.com/pingcap/tidb-docker-compose.git
    
  3. Customize the cluster.

    cd tidb-docker-compose
    cp compose/values.yaml values.yaml
    vim values.yaml
    

    Modify the configuration in values.yaml, such as the cluster size, TiDB image version, and so on.

    tidb-vision is the data visualization interface of the TiDB cluster, used to visually display the PD scheduling on TiKV data. If you do not need this component, leave tidbVision empty.

    For PD, TiKV, TiDB and tidb-vision, you can build Docker images from GitHub source code or local files for development and testing.

    • To build the image of a component from GitHub source code, you need to leave the image field empty and set buildFrom to remote.
    • To build PD, TiKV or TiDB images from the locally compiled binary file, you need to leave the image field empty, set buildFrom to local and copy the compiled binary file to the corresponding pd/bin/pd-server, tikv/bin/tikv-server, tidb/bin/tidb-server.
    • To build the tidb-vision image from local, you need to leave the image field empty, set buildFrom to local and copy the tidb-vision project to tidb-vision/tidb-vision.
  4. Generate the docker-compose.yml file.

    helm template -f values.yaml compose > generated-docker-compose.yml
    
  5. Create and start the cluster using the generated docker-compose.yml file.

    docker-compose -f generated-docker-compose.yml up -d
    
  6. Access the cluster.

    mysql -h 127.0.0.1 -P 4000 -u root
    

    Access the Grafana monitoring interface:

    If tidb-vision is enabled, you can access the cluster data visualization interface: http://localhost:8010.