Copilot commented on code in PR #455: URL: https://github.com/apache/hugegraph-doc/pull/455#discussion_r3044796804
########## content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md: ########## @@ -1,3 +1,4 @@ + Review Comment: The file starts with a blank line before the front matter (`---`). Many static site generators (including Hugo) require front matter to be the very first content in the file; the leading newline can cause the front matter to be treated as plain text and break page metadata (title/linkTitle/weight). Remove the leading empty line so the file begins with `---` on line 1. ```suggestion ``` ########## content/cn/docs/quickstart/hugegraph/hugegraph-server.md: ########## @@ -307,6 +308,34 @@ curl http://localhost:8081/graphs ```bash bin/stop-hugegraph.sh ``` + +#### Docker 分布式集群 + +通过 Docker-Compose 运行完整的分布式集群（3 PD + 3 Store + 3 Server）： + + Review Comment: This heading is inside the `##### 5.1.1 分布式存储 (HStore)` <details> block, but it uses `####`, which is a higher-level heading than its parent section. This can distort the page’s heading hierarchy/TOC. Consider changing it to a deeper level (e.g., `######`) or using bold text instead of a heading. ########## content/en/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,136 @@ +--- +title: "HugeGraph Docker Cluster Guide" +linkTitle: "Docker Cluster" +weight: 5 +--- + +## Overview + +HugeGraph can quickly run a full distributed deployment (PD + Store + Server) with Docker Compose. This works on Linux and Mac. + +## Prerequisites + +- Docker Engine 20.10+ or Docker Desktop 4.x+ +- Docker Compose v2 +- For a 3-node cluster on Mac: allocate at least **12 GB** memory (Settings → Resources → Memory). Adjust this on other platforms as needed. + +> **Tested environments**: Linux (native Docker) and macOS (Docker Desktop with ARM M4). + +## Compose Files + +Three compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory of the HugeGraph main repository: + +| File | Description | +|------|-------------| +| `docker-compose.yml` | Quickstart for a single-host deployment using pre-built images | +| `docker-compose.dev.yml` | Development mode for a single-host deployment built from source | +| `docker-compose-3pd-3store-3server.yml` | Distributed cluster with 3 PD, 3 Store, and 3 Server processes | + +> **Note**: The following steps assume you have already cloned or pulled the HugeGraph main repository locally, or at least have its `docker/` directory available. + +## Single-Node Quickstart + +```bash +cd hugegraph/docker +# Keep the version aligned with the latest release, for example 1.x.0 +HUGEGRAPH_VERSION=1.7.0 docker compose up -d +``` + +Verify: +```bash +curl http://localhost:8080/versions +``` + +## 3-Node Cluster Quickstart + +```bash +cd hugegraph/docker +HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d +``` + +Built-in startup ordering: +1. PD nodes start first and must pass the `/v1/health` check +2. Store nodes start only after all PD nodes are healthy +3. Server nodes start last, after all PD and Store nodes are healthy + +Verify that the cluster is healthy: +```bash +curl http://localhost:8620/v1/health # PD health +curl http://localhost:8520/v1/health # Store health +curl http://localhost:8080/versions # Server +curl http://localhost:8620/v1/stores # Registered stores +curl http://localhost:8620/v1/partitions # Partition assignment Review Comment: This guide uses `/v1/health` for PD/Store health checks, but the existing quickstart docs for PD/Store verification use `/actuator/health` (e.g. `content/en/docs/quickstart/hugegraph/hugegraph-pd.md:186` and `hugegraph-hstore.md:270`). Please clarify which endpoint is correct for Docker deployments (and/or document both) to avoid confusion. ```suggestion 1. PD nodes start first and must pass the Docker Compose health check (`/v1/health` in this guide) 2. Store nodes start only after all PD nodes are healthy 3. Server nodes start last, after all PD and Store nodes are healthy > **Health endpoint note**: In the Docker Compose deployment documented here, PD and Store are checked via `/v1/health`. Some other HugeGraph quickstart documents use `/actuator/health` for PD/Store verification. If you are comparing guides or using a different image/version, verify which endpoint your deployment exposes; for the compose files in this guide, start with `/v1/health`. Verify that the cluster is healthy: ```bash curl http://localhost:8620/v1/health # PD health (Docker Compose in this guide) curl http://localhost:8620/actuator/health # PD health (seen in some other docs/images) curl http://localhost:8520/v1/health # Store health (Docker Compose in this guide) curl http://localhost:8520/actuator/health # Store health (seen in some other docs/images) curl http://localhost:8080/versions # Server curl http://localhost:8620/v1/stores # Registered stores curl http://localhost:8620/v1/partitions # Partition assignment ``` ########## content/cn/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,134 @@ +--- +title: "HugeGraph Docker 集群部署指南" +linkTitle: "Docker 集群" +weight: 5 +--- + +## 概述 + +HugeGraph 通过 Docker-Compose 可快速运行完整的分布式集群版（PD + Store + Server）。该方式适用于 Linux 和 Mac。 + +## 前置条件 + +- Docker Engine 20.10+ 或 Docker Desktop 4.x+ +- Docker Compose v2 +- Mac 运行 3 节点集群时，建议分配至少 **12 GB** 内存（设置 → 资源 → 内存）。[其他平台根据实际情况调整] + +> **已测试环境**：Linux（原生 Docker）和 macOS（Docker Desktop with ARM M4） + +## Compose 文件 + +在 HugeGraph 主仓库 [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) 目录下提供了三个 compose 文件： + +| 文件 | 描述 | +|------|------| +| `docker-compose.yml` | 使用预构建镜像的** 1x3 单进程(节点)**快速启动 | +| `docker-compose.dev.yml` | 从源码构建的单节点**开发模式** | +| `docker-compose-3pd-3store-3server.yml` | ** 3x3 进程**(模拟节点)分布式集群 | Review Comment: The compose-file description strings include extra spaces inside the bold markers (e.g. `** 1x3 ...**`, `** 3x3 ...**`), which renders awkwardly and can make the emphasis inconsistent. Remove the spaces immediately after `**` and before `**` to keep the Markdown formatting clean. ```suggestion | `docker-compose.yml` | 使用预构建镜像的**1x3 单进程(节点)**快速启动 | | `docker-compose.dev.yml` | 从源码构建的单节点**开发模式** | | `docker-compose-3pd-3store-3server.yml` | **3x3 进程**(模拟节点)分布式集群 | ``` ########## content/cn/docs/quickstart/hugegraph/hugegraph-pd.md: ########## @@ -49,6 +49,56 @@ mvn clean install -DskipTests=true # target/apache-hugegraph-incubating-{version}.tar.gz ``` +#### 3.3 Docker 部署 + +HugeGraph-PD Docker 镜像已发布在 Docker Hub，镜像名为 `hugegraph/pd`。 +> 注: 后续步骤皆假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录) + +使用 docker-compose 模式部署完整的 3 节点集群（PD + Store + Server）： + +```bash +cd hugegraph/docker +# 注意版本号请随时保持更新 → 1.x.0 +HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d +``` Review Comment: The text says “Use the compose file…” but earlier uses the modern `docker compose` command. To avoid confusion with legacy Compose v1 (`docker-compose`), consider consistently referring to it as “Docker Compose” / `docker compose` throughout this section. ########## content/cn/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,134 @@ +--- +title: "HugeGraph Docker 集群部署指南" +linkTitle: "Docker 集群" +weight: 5 Review Comment: Front matter `weight: 5` duplicates the existing Guides page weight used by `backup-restore.md` (`content/cn/docs/guides/backup-restore.md:4`). Duplicate weights can lead to unstable/undesired ordering in navigation. Please pick a unique weight for this new page. ```suggestion weight: 6 ``` ########## content/en/docs/quickstart/hugegraph/hugegraph-hstore.md: ########## @@ -188,6 +232,36 @@ pdserver: address: 127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688 ``` +#### 6.3 Docker Distributed Cluster Configuration + +The distributed Store cluster definition is included in `docker/docker-compose-3pd-3store-3server.yml`. Each Store node gets its own hostname and environment variables: + +```yaml +# store0 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store0 +HG_STORE_GRPC_PORT: "8500" +HG_STORE_REST_PORT: "8520" +HG_STORE_RAFT_ADDRESS: store0:8510 +HG_STORE_DATA_PATH: /hugegraph-store/storage + +# store1 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store1 +HG_STORE_RAFT_ADDRESS: store1:8510 + +# store2 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store2 +HG_STORE_RAFT_ADDRESS: store2:8510 +``` + +Store nodes start only after all PD nodes pass healthchecks (`/v1/health`), enforced via `depends_on: condition: service_healthy`. + +To view runtime logs for a running Store container use `docker logs <container-name>` (e.g. `docker logs hg-store0`). + +See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide. Review Comment: This section states the Docker Compose healthcheck endpoint is `/v1/health`, but later in the same document the “Verify Store Service” step uses `/actuator/health` (line 270). Please align these references (or mention both explicitly) so readers know which endpoint to use and what the compose healthcheck is actually calling. ########## content/cn/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,134 @@ +--- +title: "HugeGraph Docker 集群部署指南" +linkTitle: "Docker 集群" +weight: 5 +--- + +## 概述 + +HugeGraph 通过 Docker-Compose 可快速运行完整的分布式集群版（PD + Store + Server）。该方式适用于 Linux 和 Mac。 + +## 前置条件 + +- Docker Engine 20.10+ 或 Docker Desktop 4.x+ +- Docker Compose v2 +- Mac 运行 3 节点集群时，建议分配至少 **12 GB** 内存（设置 → 资源 → 内存）。[其他平台根据实际情况调整] + +> **已测试环境**：Linux（原生 Docker）和 macOS（Docker Desktop with ARM M4） + +## Compose 文件 + +在 HugeGraph 主仓库 [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) 目录下提供了三个 compose 文件： + +| 文件 | 描述 | +|------|------| +| `docker-compose.yml` | 使用预构建镜像的** 1x3 单进程(节点)**快速启动 | +| `docker-compose.dev.yml` | 从源码构建的单节点**开发模式** | +| `docker-compose-3pd-3store-3server.yml` | ** 3x3 进程**(模拟节点)分布式集群 | + +> 注: 后续步骤皆为假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录) + +## 单节点快速启动 + +```bash +cd hugegraph/docker + # 注意版本号请随时保持更新 → 1.x.0 +HUGEGRAPH_VERSION=1.7.0 docker compose up -d +``` + +验证： +```bash +curl http://localhost:8080/versions +``` + +## 3 节点集群快速启动 + +```bash +cd hugegraph/docker +HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d +``` + +默认内置的启动顺序： +1. PD (节点)最先启动，且必须通过 `/v1/health` 健康检查 +2. Store (节点)在所有 PD 健康后再启动 +3. Server (节点)在所有 Store + PD 健康后最后启动 + +验证集群正常：(重要) +```bash +curl http://localhost:8620/v1/health # PD 健康检查 +curl http://localhost:8520/v1/health # Store 健康检查 +curl http://localhost:8080/versions # Server +curl http://localhost:8620/v1/stores # 已注册的 Store +curl http://localhost:8620/v1/partitions # 分区分配 +``` Review Comment: 本文档使用 `/v1/health` 作为 PD/Store 健康检查，但现有的 PD/Store Quickstart 验证章节使用的是 `/actuator/health`（例如 EN 文档 `hugegraph-pd.md:186`、`hugegraph-hstore.md:270`，CN 文档也同样如此）。建议在这里明确 Docker 部署应使用的健康检查端点（或同时说明两者），避免用户按错接口排查。 ########## content/en/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,136 @@ +--- +title: "HugeGraph Docker Cluster Guide" +linkTitle: "Docker Cluster" +weight: 5 +--- + +## Overview + +HugeGraph can quickly run a full distributed deployment (PD + Store + Server) with Docker Compose. This works on Linux and Mac. + +## Prerequisites + +- Docker Engine 20.10+ or Docker Desktop 4.x+ +- Docker Compose v2 +- For a 3-node cluster on Mac: allocate at least **12 GB** memory (Settings → Resources → Memory). Adjust this on other platforms as needed. + +> **Tested environments**: Linux (native Docker) and macOS (Docker Desktop with ARM M4). Review Comment: “Docker Desktop with ARM M4” is very hardware-specific and will quickly become outdated (and may incorrectly imply other Apple Silicon/amd64 environments aren’t supported). Consider generalizing this to something like “macOS (Docker Desktop on Apple Silicon/ARM64)” (or omit the chip generation entirely). ```suggestion > **Tested environments**: Linux (native Docker) and macOS (Docker Desktop on Apple Silicon/ARM64). ``` ########## content/cn/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,134 @@ +--- +title: "HugeGraph Docker 集群部署指南" +linkTitle: "Docker 集群" +weight: 5 +--- + +## 概述 + +HugeGraph 通过 Docker-Compose 可快速运行完整的分布式集群版（PD + Store + Server）。该方式适用于 Linux 和 Mac。 + +## 前置条件 + +- Docker Engine 20.10+ 或 Docker Desktop 4.x+ +- Docker Compose v2 +- Mac 运行 3 节点集群时，建议分配至少 **12 GB** 内存（设置 → 资源 → 内存）。[其他平台根据实际情况调整] + +> **已测试环境**：Linux（原生 Docker）和 macOS（Docker Desktop with ARM M4） Review Comment: “Docker Desktop with ARM M4” 过于特定（硬件型号会快速过时，也可能让读者误以为仅支持 M4）。建议改为更泛化的表述，例如 “macOS（Docker Desktop，Apple Silicon/ARM64）”，或直接省略芯片型号。 ```suggestion > **已测试环境**：Linux（原生 Docker）和 macOS（Docker Desktop，Apple Silicon/ARM64） ``` ########## content/en/docs/guides/hugegraph-docker-cluster.md: ########## @@ -0,0 +1,136 @@ +--- +title: "HugeGraph Docker Cluster Guide" +linkTitle: "Docker Cluster" +weight: 5 Review Comment: Front matter `weight: 5` duplicates the existing Guides page weight used by `backup-restore.md` (`content/en/docs/guides/backup-restore.md:4`). Duplicate weights can lead to unstable/undesired ordering in navigation. Please pick a unique weight for this new page. ```suggestion weight: 6 ``` ########## content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md: ########## @@ -50,6 +51,50 @@ mvn clean install -DskipTests=true # target/apache-hugegraph-incubating-{version}.tar.gz ``` +#### 3.3 Docker 部署 + +HugeGraph-Store Docker 镜像已发布在 DockerHub，镜像名是 `hugegraph/store`。 + +> 注: 后续步骤皆假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录) + +使用 docker-compose 文件部署完整的 3 节点集群（PD + Store + Server）： + +```bash +cd hugegraph/docker +# 注意版本号请随时保持更新 → 1.x.0 +HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d +``` Review Comment: This section refers to “docker-compose” in prose, but the commands use `docker compose` (Compose v2). Consider updating the wording to consistently say “Docker Compose” / `docker compose` to avoid mixing v1 vs v2 terminology. ########## content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md: ########## @@ -188,6 +233,36 @@ pdserver: address: 127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688 ``` +#### 6.3 Docker 分布式集群配置 + +3 节点 Store 集群包含在 `docker/docker-compose-3pd-3store-3server.yml` 中。每个 Store 节点拥有独立的主机名和环境变量： + +```yaml +# store0 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store0 +HG_STORE_GRPC_PORT: "8500" +HG_STORE_REST_PORT: "8520" +HG_STORE_RAFT_ADDRESS: store0:8510 +HG_STORE_DATA_PATH: /hugegraph-store/storage + +# store1 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store1 +HG_STORE_RAFT_ADDRESS: store1:8510 + +# store2 +HG_STORE_PD_ADDRESS: pd0:8686,pd1:8686,pd2:8686 +HG_STORE_GRPC_HOST: store2 +HG_STORE_RAFT_ADDRESS: store2:8510 +``` + +Store 节点仅在所有 PD 节点通过健康检查（`/v1/health`）后启动，通过 `depends_on: condition: service_healthy` 强制执行。 + +运行时日志可通过 `docker logs <container-name>`（如 `docker logs hg-store0`）直接查看，无需进入容器。 + +完整的部署指南请参阅 [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md)。 Review Comment: 这里使用 `/v1/health` 作为 Docker Compose 的健康检查端点，但文档后面的“验证 Store 服务”仍使用 `/actuator/health`（第 271 行）。建议统一/补充说明（例如两者都可用，或 Compose 实际使用哪一个），避免读者困惑。 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
