pingcap/pd

pingcap/pd 镜像文档

1. 镜像概述与主要用途

PD（Placement Driver）是TiDB分布式数据库生态的核心组件，全称为Placement Driver。其主要用途是作为TiKV集群的管理和调度中心，负责协调TiKV节点、管理数据分片（Region）的分布与迁移、维护集群元数据，并确保整个TiKV集群的高可用性和性能优化。PD通过嵌入etcd实现分布式协调与容错能力，是TiDB集群正常运行的关键协调组件。

2. 核心功能与特性

• TiKV集群管理：负责TiKV集群的节点发现、状态监控与生命周期管理。
• 数据调度：根据集群负载和拓扑结构，自动调度Region的分布，实现负载均衡。
• 分布式协调：基于嵌入式etcd提供分布式一致性服务，确保集群元数据的一致性与可靠性。
• 容错能力：支持多节点部署，通过Raft协议实现数据副本同步，保障集群故障时的自动恢复。
• 元数据维护：存储并管理TiKV集群的元数据信息，如Region分布、节点健康状态等。

3. 使用场景与适用范围

PD适用于TiDB分布式数据库集群环境，具体场景包括：

• 构建TiDB分布式数据库集群时，作为TiKV的调度与协调中心。
• 需要对TiKV集群进行动态扩缩容、负载均衡调整的场景。
• 保障TiDB集群高可用性，需依赖PD实现故障自动转移与数据恢复。
• 管理大规模TiKV集群的元数据与Region分片策略。

4. 使用方法与配置说明

4.1 镜像获取

4.1.1 本地构建镜像

通过源码仓库构建PD镜像：

bash
git clone https://github.com/pingcap/pd.git
cd pd
docker build -t pingcap/pd .

4.1.2 从Docker Hub拉取镜像

直接拉取官方发布的镜像：

bash
docker pull docker.xuanyuan.run/pingcap/pd

4.2 单节点部署

通过Docker快速启动单节点PD服务，适用于测试或开发环境。

4.2.1 部署命令

bash
# 设置主机IP（需替换为实际主机IP）
export HostIP="192.168.199.105"

docker run -d \
  -p 2379:2379 \  # 客户端通信端口
  -p 2380:2380 \  # 节点间对等通信端口
  --name pd \
  pingcap/pd \
  --cluster-id=1 \          # 集群唯一ID
  --name="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"  # 对外暴露的对等节点地址

4.2.2 验证部署

使用curl或httpie工具检查PD节点状态：

通过curl验证：

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

预期输出（示例）：

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

通过httpie验证（推荐）：

bash
# 安装httpie（如未安装）：pip install httpie
http ${HostIP}:2379/v2/members

预期输出（示例）：

http
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"]
        }
    ]
}

4.3 集群部署

PD作为TiDB集群的核心组件，需与TiDB（SQL层）和TiKV（存储层）协同工作。生产环境中建议部署多节点PD集群以确保高可用。

4.3.1 部署方式

• 官方文档参考：详细集群部署步骤请参考TiDB官方文档：

  • https://github.com/pingcap/docs/blob/master/op-guide/clustering.md
  • https://github.com/pingcap/docs/blob/master/op-guide/docker.md

• 关键说明：多节点PD集群需通过--initial-cluster参数指定初始成员列表，各节点通过--advertise-client-urls和--advertise-peer-urls相互发现。

4.4 配置参数说明

PD服务启动支持多种命令行参数，核心参数说明如下：

5. 注意事项

• 生产环境中，PD集群建议部署3个或以上节点，以满足Raft协议的多数派选举要求，确保高可用性。
• --advertise-client-urls和--advertise-peer-urls需配置为集群内其他节点可访问的地址，避免使用localhost或127.0.0.1。
• PD依赖etcd存储元数据，需确保磁盘IO性能满足要求，避免影响集群稳定性。