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.
If you're interested in contributing to PD, see CONTRIBUTING.md. For more contributing information, please click on the contributor icon above.
- Make sure Go (version 1.16) is installed.
- Use
make
to install PD. PD is installed in thebin
directory.
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="https://${HostIP}:2379" \
--peer-urls="https://${HostIP}:2380" \
--log-file=pd.log
Using curl
to see PD member:
curl https://${HostIP}:2379/pd/api/v1/members
{
"members": [
{
"name":"pd",
"member_id":"f62e88a6e81c149",
"peer_urls": [
"https://192.168.199.105:2380"
],
"client_urls": [
"https://192.168.199.105:2379"
]
}
]
}
A better tool httpie is recommended:
http https://${HostIP}:2379/pd/api/v1/members
Access-Control-Allow-Headers: accept, content-type, authorization
Access-Control-Allow-Methods: POST, GET, OPTIONS, PUT, DELETE
Access-Control-Allow-Origin: *
Content-Length: 673
Content-Type: application/json; charset=UTF-8
Date: Thu, 20 Feb 2020 09:49:42 GMT
{
"members": [
{
"client_urls": [
"https://192.168.199.105:2379"
],
"member_id": "f62e88a6e81c149",
"name": "pd",
"peer_urls": [
"https://192.168.199.105:2380"
]
}
]
}
You can use the following command to build a PD image directly:
docker build -t tikv/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 tikv/pd \
--name="pd" \
--data-dir="pd" \
--client-urls="https://0.0.0.0:2379" \
--advertise-client-urls="https://${HostIP}:2379" \
--peer-urls="https://0.0.0.0:2380" \
--advertise-peer-urls="https://${HostIP}:2380" \
--log-file=pd.log
As a component of TiKV project, PD needs to run with TiKV to work. The cluster can also include TiDB to provide SQL services. You can refer Deploy a TiDB Cluster Using TiUP or TiDB in Kubernetes Documentation for detailed instructions to deploy a cluster.