hugegraph/pd

HugeGraph PD

![许可证]([***]

概述

HugeGraph PD（Placement Driver）是一个元服务器，为HugeGraph分布式部署提供集群管理和协调服务。它作为中央控制平面，负责：

• 服务发现：Store和Server节点的自动注册与发现
• 分区管理：跨Store节点的动态分区分配、平衡和再平衡
• 元数据存储：集群元数据、配置和状态信息的集中存储
• 节点调度：图操作的智能调度和负载均衡
• 健康监控：通过心跳机制进行持续健康检查和故障检测

PD使用https://github.com/sofastack/sofa-jraft%E5%AE%9E%E7%8E%B0Raft%E5%85%B1%E8%AF%86%EF%BC%8C%E5%B9%B6%E4%BD%BF%E7%94%A8RocksDB%E8%BF%9B%E8%A1%8C%E6%8C%81%E4%B9%85%E5%8C%96%E5%85%83%E6%95%B0%E6%8D%AE%E5%AD%98%E5%82%A8%EF%BC%8C%E7%A1%AE%E4%BF%9D%E5%88%86%E5%B8%83%E5%BC%8F%E7%8E%AF%E5%A2%83%E4%B8%AD%E7%9A%84%E9%AB%98%E5%8F%AF%E7%94%A8%E6%80%A7%E5%92%8C%E4%B8%80%E8%87%B4%E6%80%A7%E3%80%82

架构

HugeGraph PD是一个Maven多模块项目，包含8个模块：

有关详细的架构和设计，请参见架构文档。

快速开始

前提条件

• Java：11或更高版本
• Maven：3.5或更高版本
• 磁盘空间：PD数据目录至少需要1GB

构建

从项目根目录（构建PD和所有依赖项）：

bash
mvn clean package -pl hugegraph-pd -am -DskipTests

或者从hugegraph-pd目录构建：

bash
cd hugegraph-pd
mvn clean install -DskipTests

组装好的分发包将位于：

hugegraph-pd/hg-pd-dist/target/hugegraph-pd-<version>.tar.gz

运行

解压分发包并启动PD：

bash
tar -xzf hugegraph-pd-<version>.tar.gz
cd hugegraph-pd-<version>

# 启动PD服务器
bin/start-hugegraph-pd.sh

# 停止PD服务器
bin/stop-hugegraph-pd.sh

启动选项

bash
bin/start-hugegraph-pd.sh [-g GC_TYPE] [-j "JVM_OPTIONS"] [-y ENABLE_OTEL]

• -g：GC类型（g1或ZGC，默认：g1）
• -j：自定义JVM选项（例如：-j "-Xmx4g -Xms4g"）
• -y：启用OpenTelemetry追踪（true或false，默认：false）

配置

关键配置文件：conf/application.yml

核心设置

单节点示例

yaml
grpc:
  host: 127.0.0.1
  port: 8686

server:
  port: 8620

raft:
  address: 127.0.0.1:8610
  peers-list: 127.0.0.1:8610

pd:
  data-path: ./pd_data

3节点集群示例

对于生产环境的3节点PD集群，配置每个节点：

节点1（192.168.1.10）：

yaml
grpc:
  host: 192.168.1.10
  port: 8686
raft:
  address: 192.168.1.10:8610
  peers-list: 192.168.1.10:8610,192.168.1.11:8610,192.168.1.12:8610

节点2（192.168.1.11）：

yaml
grpc:
  host: 192.168.1.11
  port: 8686
raft:
  address: 192.168.1.11:8610
  peers-list: 192.168.1.10:8610,192.168.1.11:8610,192.168.1.12:8610

节点3（192.168.1.12）：

yaml
grpc:
  host: 192.168.1.12
  port: 8686
raft:
  address: 192.168.1.12:8610
  peers-list: 192.168.1.10:8610,192.168.1.11:8610,192.168.1.12:8610

有关详细的配置选项和生产环境调优，请参见配置指南。

验证部署

检查PD是否正在运行：

bash
# 检查进程
ps aux | grep hugegraph-pd

# 测试REST API
curl http://localhost:8620/actuator/health

# 检查日志
tail -f logs/hugegraph-pd.log

gRPC API

PD公开了多个用于集群管理的gRPC服务。关键服务包括：

• PD Service（PDGrpc）：存储注册、分区查询、领导者选举
• KV Service（KvServiceGrpc）：元数据的分布式键值操作
• Watch Service（HgPdWatchGrpc）：监视分区和存储变更
• Pulse Service（HgPdPulseGrpc）：心跳和健康监控

Proto定义位于：

hugegraph-pd/hg-pd-grpc/src/main/proto/

有关API参考和使用示例，请参见API参考。

测试

运行PD测试：

bash
# 所有PD测试
mvn test -pl hugegraph-pd/hg-pd-test -am

# 特定测试类
mvn test -pl hugegraph-pd/hg-pd-test -am -Dtest=YourTestClass

Docker

构建PD Docker镜像：

bash
# 从项目根目录
docker build -f hugegraph-pd/Dockerfile -t hugegraph-pd:latest .

# 运行容器
docker run -d \
  -p 8620:8620 \
  -p 8686:8686 \
  -p 8610:8610 \
  -v /path/to/conf:/hugegraph-pd/conf \
  -v /path/to/data:/hugegraph-pd/pd_data \
  --name hugegraph-pd \
  hugegraph-pd:latest

有关包含HugeGraph Store和Server的Docker Compose示例，请参见：

hugegraph-server/hugegraph-dist/docker/example/

文档

• 架构文档 - 系统设计、模块详情和交互流程
• API参考 - gRPC API定义和使用示例
• 配置指南 - 配置选项和生产环境调优
• 开发指南 - 构建、测试和贡献工作流

生产环境部署注意事项

集群大小

• 最小：3个节点（Raft法定人数要求）
• 推荐：生产环境使用3或5个节点（Raft选举需要奇数）

高可用性

• PD使用Raft共识进行领导者选举和数据复制
• 集群可以容忍最多(N-1)/2个节点故障（例如，3节点集群中可容忍1个故障）
• 领导者处理所有写操作；追随者处理读操作

网络要求

• 确保PD节点之间的低延迟（<5ms）以实现Raft共识
• 开放所需端口：8620（REST）、8686（gRPC）、8610（Raft）

监控

PD通过REST API公开指标：

• 健康检查：http://<pd-host>:8620/actuator/health
• 指标：http://<pd-host>:8620/actuator/metrics

社区

• 文档：[***]
• GitHub：https://github.com/apache/hugegraph

贡献

欢迎贡献！请阅读我们的开发指南并遵循Apache HugeGraph贡献指南。