Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
Placement driver for TiKV
Branch: master
Clone or download
rleungx and disksing fix CI and switch to golangci-lint (#1471)
Signed-off-by: rleungx <rleungx@gmail.com>
Latest commit f72cc23 Mar 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github *: make pull request template more concise (#1220) Aug 29, 2018
client server: GetAllStores should not return tombstone stores (#1440) Feb 25, 2019
cmd/pd-server
conf
docs added the doc 'development-workflow.md' (#1464) Mar 20, 2019
pkg *: log format for logutil, server/core (#1438) Feb 26, 2019
scripts
server
table
tests *: Start switching to the zap logger (#1422) Feb 14, 2019
tools simulator: make heartbeat more reasonable (#1418) Mar 7, 2019
.gitignore *: Start switching to the zap logger (#1422) Feb 14, 2019
.travis.yml upgrade go to 1.12 (#1458) Mar 13, 2019
CHANGELOG.md
CONTRIBUTING.md added the doc 'development-workflow.md' (#1464) Mar 20, 2019
Dockerfile upgrade go to 1.12 (#1458) Mar 13, 2019
Jenkinsfile
LICENSE
Makefile
README.md
circle.yml
go.mod
go.sum server: GetAllStores should not return tombstone stores (#1440) Feb 25, 2019
revive.toml revive linter: exit 1 on failure (#1217) Aug 28, 2018
tools.json

README.md

PD

TravisCI Build Status GitHub release CircleCI Build Status Go Report Card codecov

PD is the abbreviation for Placement Driver. It is used to manage and schedule the TiKV cluster.

PD supports distribution and fault-tolerance by embedding etcd.

Build

  1. Make sure Go (version 1.12) is installed.
  2. Use make to install PD. PD is installed in the bin directory.

Usage

Command flags

See configuration.

Single Node with default ports

You can run pd-server directly on your local machine, if you want to connect to PD from outside, you can let PD listen on the host IP.

# Set correct HostIP here. 
export HostIP="192.168.199.105"

pd-server --name="pd" \
          --data-dir="pd" \
          --client-urls="http://${HostIP}:2379" \
          --peer-urls="http://${HostIP}:2380" \
          --log-file=pd.log

Using curl to see PD member:

curl http://${HostIP}:2379/v2/members

{"members":[{"id":"f62e88a6e81c149","name":"pd","peerURLs":["http://192.168.199.105:2380"],"clientURLs":["http://192.168.199.105:2379"]}]}

A better tool httpie is recommended:

http http://${HostIP}:2379/v2/members
HTTP/1.1 200 OK
Content-Length: 144
Content-Type: application/json
Date: Thu, 21 Jul 2016 09:37:12 GMT
X-Etcd-Cluster-Id: 33dc747581249309

{
    "members": [
        {
            "clientURLs": [
                "http://192.168.199.105:2379"
            ], 
            "id": "f62e88a6e81c149", 
            "name": "pd", 
            "peerURLs": [
                "http://192.168.199.105:2380"
            ]
        }
    ]
}

Docker

You can use the following command to build a PD image directly:

docker build -t pingcap/pd .

Or you can also use following command to get PD from Docker hub:

docker pull pingcap/pd

Run a single node with Docker:

# Set correct HostIP here. 
export HostIP="192.168.199.105"

docker run -d -p 2379:2379 -p 2380:2380 --name pd pingcap/pd \
          --name="pd" \
          --data-dir="pd" \
          --client-urls="http://0.0.0.0:2379" \
          --advertise-client-urls="http://${HostIP}:2379" \
          --peer-urls="http://0.0.0.0:2380" \
          --advertise-peer-urls="http://${HostIP}:2380" \
          --log-file=pd.log

Cluster

PD is a component in TiDB project, you must run it with TiDB and TiKV together, see TiDB-Ansible to learn how to set up the cluster and run them.

You can also use Docker to run the cluster.

You can’t perform that action at this time.