Skip to content

Commit f454c8c

Browse files
committed
docs: update Docker Compose cluster guidance
Revise Chinese and English docs for HugeGraph Docker deployment to standardize on Docker Compose wording and usage. Add notes that users should clone/pull the HugeGraph repo (or at least the docker/ directory), include a reminder to keep the HUGEGRAPH_VERSION aligned with releases, and adjust memory recommendations for Mac (3-node cluster ~12 GB) with platform guidance. Clarify compose file descriptions, emphasize container hostnames for HG_* env vars, change some example log years to 2026, reformat deprecated-alias lines, and number/troubleshooting items for clarity. Minor phrasing and section-title tweaks across hugegraph-docker-cluster.md, hugegraph-hstore.md, hugegraph-pd.md, and hugegraph-server.md (EN & CN). Signed-off-by: imbajin <jin@apache.org>
1 parent d04a001 commit f454c8c

File tree

8 files changed

+79
-63
lines changed

8 files changed

+79
-63
lines changed

content/cn/docs/guides/hugegraph-docker-cluster.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,33 @@ weight: 5
66

77
## 概述
88

9-
HugeGraph 支持通过 Docker 桥接网络运行完整的分布式集群(PD + Store + Server)。该方式适用于 Linux 和 Mac(Docker Desktop)。
10-
11-
早期版本使用 `network_mode: host`,仅在 Linux 上可用。集群现在使用 Docker 桥接网络(`hg-net`),服务通过容器主机名而非 `127.0.0.1` 进行通信。
9+
HugeGraph 通过 Docker-Compose 可快速运行完整的分布式集群版(PD + Store + Server)。该方式适用于 Linux 和 Mac。
1210

1311
## 前置条件
1412

1513
- Docker Engine 20.10+ 或 Docker Desktop 4.x+
1614
- Docker Compose v2
17-
- Mac(Docker Desktop)运行 3 节点集群时,需分配至少 **12 GB** 内存(设置 → 资源 → 内存)。Linux 上 Docker 直接使用宿主机内存,无需额外分配
15+
- Mac 运行 3 节点集群时,建议分配至少 **12 GB** 内存(设置 → 资源 → 内存)。[其他平台根据实际情况调整]
1816

19-
> **已测试平台**:Linux(原生 Docker)和 macOS(Docker Desktop,已在 Apple M4 上测试)。Windows Docker Desktop 未经测试。
17+
> **已测试环境**:Linux(原生 Docker)和 macOS(Docker Desktop with ARM M4)
2018
2119
## Compose 文件
2220

23-
[`docker/`](https://github.com/apache/hugegraph/tree/master/docker) 目录下提供了三个 compose 文件:
21+
在 HugeGraph 主仓库 [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) 目录下提供了三个 compose 文件:
2422

2523
| 文件 | 描述 |
2624
|------|------|
27-
| `docker-compose.yml` | 使用预构建镜像的单节点快速启动 |
28-
| `docker-compose.dev.yml` | 从源码构建的单节点开发模式 |
29-
| `docker-compose-3pd-3store-3server.yml` | 3 节点分布式集群 |
25+
| `docker-compose.yml` | 使用预构建镜像的** 1x3 单进程(节点)**快速启动 |
26+
| `docker-compose.dev.yml` | 从源码构建的单节点**开发模式** |
27+
| `docker-compose-3pd-3store-3server.yml` | ** 3x3 进程**(模拟节点)分布式集群 |
28+
29+
> 注: 后续步骤皆为假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录)
3030
3131
## 单节点快速启动
3232

3333
```bash
3434
cd hugegraph/docker
35+
# 注意版本号请随时保持更新 → 1.x.0
3536
HUGEGRAPH_VERSION=1.7.0 docker compose up -d
3637
```
3738

@@ -47,12 +48,12 @@ cd hugegraph/docker
4748
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
4849
```
4950

50-
启动顺序自动强制执行
51-
1. PD 节点首先启动,必须通过 `/v1/health` 健康检查
52-
2. Store 节点在所有 PD 节点健康后启动
53-
3. Server 节点在所有 Store 节点健康后启动
51+
默认内置的启动顺序
52+
1. PD (节点)最先启动,且必须通过 `/v1/health` 健康检查
53+
2. Store (节点)在所有 PD 健康后再启动
54+
3. Server (节点)在所有 Store + PD 健康后最后启动
5455

55-
验证集群:
56+
验证集群正常:(重要)
5657
```bash
5758
curl http://localhost:8620/v1/health # PD 健康检查
5859
curl http://localhost:8520/v1/health # Store 健康检查
@@ -76,7 +77,7 @@ curl http://localhost:8620/v1/partitions # 分区分配
7677
| `HG_PD_DATA_PATH` || `/hugegraph-pd/pd_data` | `pd.data-path` |
7778
| `HG_PD_INITIAL_STORE_COUNT` || `1` | `pd.initial-store-count` |
7879

79-
**已弃用的别名**`GRPC_HOST``HG_PD_GRPC_HOST``RAFT_ADDRESS``HG_PD_RAFT_ADDRESS``RAFT_PEERS``HG_PD_RAFT_PEERS_LIST`
80+
> **已弃用的别名**`GRPC_HOST``HG_PD_GRPC_HOST``RAFT_ADDRESS``HG_PD_RAFT_ADDRESS``RAFT_PEERS``HG_PD_RAFT_PEERS_LIST`
8081
8182
### Store 变量
8283

@@ -89,7 +90,7 @@ curl http://localhost:8620/v1/partitions # 分区分配
8990
| `HG_STORE_REST_PORT` || `8520` | `server.port` |
9091
| `HG_STORE_DATA_PATH` || `/hugegraph-store/storage` | `app.data-path` |
9192

92-
**已弃用的别名**`PD_ADDRESS``HG_STORE_PD_ADDRESS``GRPC_HOST``HG_STORE_GRPC_HOST``RAFT_ADDRESS``HG_STORE_RAFT_ADDRESS`
93+
> **已弃用的别名**`PD_ADDRESS``HG_STORE_PD_ADDRESS``GRPC_HOST``HG_STORE_GRPC_HOST``RAFT_ADDRESS``HG_STORE_RAFT_ADDRESS`
9394
9495
### Server 变量
9596

@@ -100,7 +101,7 @@ curl http://localhost:8620/v1/partitions # 分区分配
100101
| `STORE_REST` ||| `wait-partition.sh` 使用 |
101102
| `PASSWORD` ||| 启用鉴权模式 |
102103

103-
**已弃用的别名**`BACKEND``HG_SERVER_BACKEND``PD_PEERS``HG_SERVER_PD_PEERS`
104+
> **已弃用的别名**`BACKEND``HG_SERVER_BACKEND``PD_PEERS``HG_SERVER_PD_PEERS`
104105
105106
## 端口参考
106107

@@ -124,10 +125,10 @@ curl http://localhost:8620/v1/partitions # 分区分配
124125

125126
## 故障排查
126127

127-
**容器 OOM 被杀(退出码 137)**:将 Docker Desktop 内存增加到 12 GB 以上
128+
1. **容器 OOM 退出(exit code 137)**:将 Docker Desktop 内存增加到 12 GB 以上 (或调整被 kill 的启动 jvm 内存设置)
128129

129-
**Raft 选举超时**:检查所有 PD 节点的 `HG_PD_RAFT_PEERS_LIST` 是否一致。验证连通性:`docker exec hg-pd0 ping pd1`
130+
2. **Raft 选举超时**:检查所有 PD 节点的 `HG_PD_RAFT_PEERS_LIST` 是否一致。验证连通性:`docker exec hg-pd0 ping pd1`
130131

131-
**分区分配未完成**:检查 `curl http://localhost:8620/v1/stores`所有 3 个 Store 必须显示 `"state":"Up"` 才能完成分区分配
132+
3. **分区分配未完成**:检查 `curl http://localhost:8620/v1/stores` — 3 个 Store 必须都显示 `"state":"Up"` 才能完成分区分配
132133

133-
**连接被拒**:确保 `HG_*` 环境变量使用容器主机名(`pd0``store0`),而非 `127.0.0.1`
134+
4. **连接被拒**:确保 `HG_*` 环境变量使用容器主机名(`pd0``store0`),而非 `127.0.0.1`

content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
---
23
title: "HugeGraph-Store Quick Start"
34
linkTitle: "安装/构建 HugeGraph-Store"
@@ -52,12 +53,15 @@ mvn clean install -DskipTests=true
5253

5354
#### 3.3 Docker 部署
5455

55-
HugeGraph-Store Docker 镜像已发布在 Docker Hub,镜像名为 `hugegraph/store:1.7.0`
56+
HugeGraph-Store Docker 镜像已发布在 DockerHub,镜像名是 `hugegraph/store`
57+
58+
> 注: 后续步骤皆假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录)
5659
57-
使用 compose 文件部署完整的 3 节点集群(PD + Store + Server):
60+
使用 docker-compose 文件部署完整的 3 节点集群(PD + Store + Server):
5861

5962
```bash
6063
cd hugegraph/docker
64+
# 注意版本号请随时保持更新 → 1.x.0
6165
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
6266
```
6367

@@ -157,7 +161,7 @@ logging:
157161
启动成功后,可以在 `logs/hugegraph-store-server.log` 中看到类似以下的日志:
158162

159163
```
160-
2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.s.n.StoreNodeApplication - Started StoreNodeApplication in x.xxx seconds (JVM running for x.xxx)
164+
2026-xx-xx xx:xx:xx [main] [INFO] o.a.h.s.n.StoreNodeApplication - Started StoreNodeApplication in x.xxx seconds (JVM running for x.xxx)
161165
```
162166
163167
#### 5.2 停止 Store
@@ -229,7 +233,7 @@ pdserver:
229233
address: 127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688
230234
```
231235
232-
#### 6.3 Docker 集群快速启动
236+
#### 6.3 Docker 分布式集群配置
233237
234238
3 节点 Store 集群包含在 `docker/docker-compose-3pd-3store-3server.yml` 中。每个 Store 节点拥有独立的主机名和环境变量:
235239

content/cn/docs/quickstart/hugegraph/hugegraph-pd.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,14 @@ mvn clean install -DskipTests=true
5151

5252
#### 3.3 Docker 部署
5353

54-
HugeGraph-PD Docker 镜像已发布在 Docker Hub,镜像名为 `hugegraph/pd:1.7.0`
54+
HugeGraph-PD Docker 镜像已发布在 Docker Hub,镜像名为 `hugegraph/pd`
55+
> 注: 后续步骤皆假设你本地**已拉取** `hugegraph` 主仓库代码 (至少是 docker 目录)
5556
56-
使用 compose 文件部署完整的 3 节点集群(PD + Store + Server):
57+
使用 docker-compose 模式部署完整的 3 节点集群(PD + Store + Server):
5758

5859
```bash
5960
cd hugegraph/docker
61+
# 注意版本号请随时保持更新 → 1.x.0
6062
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
6163
```
6264

@@ -164,7 +166,7 @@ partition:
164166
启动成功后,可以在 `logs/hugegraph-pd-stdout.log` 中看到类似以下的日志:
165167

166168
```
167-
2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.p.b.HugePDServer - Started HugePDServer in x.xxx seconds (JVM running for x.xxx)
169+
2026-xx-xx xx:xx:xx [main] [INFO] o.a.h.p.b.HugePDServer - Started HugePDServer in x.xxx seconds (JVM running for x.xxx)
168170
```
169171

170172
#### 5.2 停止 PD

content/cn/docs/quickstart/hugegraph/hugegraph-server.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,15 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存
5757

5858
> **注意**:Docker compose 文件使用桥接网络(`hg-net`),适用于 Linux 和 Mac(Docker Desktop)。如需运行 3 节点分布式集群,请为 Docker Desktop 分配至少 **12 GB** 内存(设置 → 资源 → 内存)。
5959
60-
另外,如果我们希望能够在一个文件中管理 HugeGraph 相关的实例,可以使用 `docker compose` 完成部署
60+
另外,如果我们希望能够一体化管理 HugeGraph 多模块实例,则可以使用 `docker compose` 方式
6161
[`docker/`](https://github.com/apache/hugegraph/tree/master/docker) 目录下提供了两个 compose 文件:
6262

6363
- **单节点快速启动**(预构建镜像):`docker/docker-compose.yml`
6464
- **单节点开发构建**(从源码构建):`docker/docker-compose.dev.yml`
6565

6666
```bash
6767
cd hugegraph/docker
68+
# 注意版本号请随时保持更新 → 1.x.0
6869
HUGEGRAPH_VERSION=1.7.0 docker compose up -d
6970
```
7071

@@ -308,9 +309,9 @@ curl http://localhost:8081/graphs
308309
bin/stop-hugegraph.sh
309310
```
310311

311-
#### Docker 集群快速启动
312+
#### Docker 分布式集群
312313

313-
通过 Docker 运行完整的分布式集群(3 PD + 3 Store + 3 Server):
314+
通过 Docker-Compose 运行完整的分布式集群(3 PD + 3 Store + 3 Server):
314315

315316

316317
```bash

content/en/docs/guides/hugegraph-docker-cluster.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,33 @@ weight: 5
66

77
## Overview
88

9-
HugeGraph supports running a full distributed cluster (PD + Store + Server) via Docker using bridge networking. This works on Linux and Mac (Docker Desktop).
10-
11-
Previous versions used `network_mode: host` which only worked on Linux. The cluster now uses a Docker bridge network (`hg-net`) where services communicate via container hostnames instead of `127.0.0.1`.
9+
HugeGraph can quickly run a full distributed deployment (PD + Store + Server) with Docker Compose. This works on Linux and Mac.
1210

1311
## Prerequisites
1412

1513
- Docker Engine 20.10+ or Docker Desktop 4.x+
1614
- Docker Compose v2
17-
- For the 3-node cluster on Mac (Docker Desktop): allocate at least **12 GB** memory (Settings → Resources → Memory)
15+
- For a 3-node cluster on Mac: allocate at least **12 GB** memory (Settings → Resources → Memory). Adjust this on other platforms as needed.
1816

19-
> **Tested platforms**: Linux (native Docker) and macOS (Docker Desktop, tested on Apple M4). Windows Docker Desktop is untested.
17+
> **Tested environments**: Linux (native Docker) and macOS (Docker Desktop with ARM M4).
2018
2119
## Compose Files
2220

23-
Three compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
21+
Three compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory of the HugeGraph main repository:
2422

2523
| File | Description |
2624
|------|-------------|
27-
| `docker-compose.yml` | Single-node quickstart using pre-built images |
28-
| `docker-compose.dev.yml` | Single-node dev build from source |
29-
| `docker-compose-3pd-3store-3server.yml` | 3-node distributed cluster |
25+
| `docker-compose.yml` | Quickstart for a single-host deployment using pre-built images |
26+
| `docker-compose.dev.yml` | Development mode for a single-host deployment built from source |
27+
| `docker-compose-3pd-3store-3server.yml` | Distributed cluster with 3 PD, 3 Store, and 3 Server processes |
28+
29+
> **Note**: The following steps assume you have already cloned or pulled the HugeGraph main repository locally, or at least have its `docker/` directory available.
3030
3131
## Single-Node Quickstart
3232

3333
```bash
3434
cd hugegraph/docker
35+
# Keep the version aligned with the latest release, for example 1.x.0
3536
HUGEGRAPH_VERSION=1.7.0 docker compose up -d
3637
```
3738

@@ -47,12 +48,12 @@ cd hugegraph/docker
4748
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
4849
```
4950

50-
Startup ordering is enforced automatically:
51-
1. PD nodes start first and must pass `/v1/health`
52-
2. Store nodes start after all PD nodes are healthy
53-
3. Server nodes start after all Store nodes are healthy
51+
Built-in startup ordering:
52+
1. PD nodes start first and must pass the `/v1/health` check
53+
2. Store nodes start only after all PD nodes are healthy
54+
3. Server nodes start last, after all PD and Store nodes are healthy
5455

55-
Verify the cluster:
56+
Verify that the cluster is healthy:
5657
```bash
5758
curl http://localhost:8620/v1/health # PD health
5859
curl http://localhost:8520/v1/health # Store health
@@ -76,7 +77,7 @@ curl http://localhost:8620/v1/partitions # Partition assignment
7677
| `HG_PD_DATA_PATH` | No | `/hugegraph-pd/pd_data` | `pd.data-path` |
7778
| `HG_PD_INITIAL_STORE_COUNT` | No | `1` | `pd.initial-store-count` |
7879

79-
**Deprecated aliases**: `GRPC_HOST``HG_PD_GRPC_HOST`, `RAFT_ADDRESS``HG_PD_RAFT_ADDRESS`, `RAFT_PEERS``HG_PD_RAFT_PEERS_LIST`
80+
> **Deprecated aliases**: `GRPC_HOST``HG_PD_GRPC_HOST`, `RAFT_ADDRESS``HG_PD_RAFT_ADDRESS`, `RAFT_PEERS``HG_PD_RAFT_PEERS_LIST`
8081
8182
### Store Variables
8283

@@ -89,7 +90,7 @@ curl http://localhost:8620/v1/partitions # Partition assignment
8990
| `HG_STORE_REST_PORT` | No | `8520` | `server.port` |
9091
| `HG_STORE_DATA_PATH` | No | `/hugegraph-store/storage` | `app.data-path` |
9192

92-
**Deprecated aliases**: `PD_ADDRESS``HG_STORE_PD_ADDRESS`, `GRPC_HOST``HG_STORE_GRPC_HOST`, `RAFT_ADDRESS``HG_STORE_RAFT_ADDRESS`
93+
> **Deprecated aliases**: `PD_ADDRESS``HG_STORE_PD_ADDRESS`, `GRPC_HOST``HG_STORE_GRPC_HOST`, `RAFT_ADDRESS``HG_STORE_RAFT_ADDRESS`
9394
9495
### Server Variables
9596

@@ -100,7 +101,7 @@ curl http://localhost:8620/v1/partitions # Partition assignment
100101
| `STORE_REST` | No || used by `wait-partition.sh` |
101102
| `PASSWORD` | No || enables auth mode |
102103

103-
**Deprecated aliases**: `BACKEND``HG_SERVER_BACKEND`, `PD_PEERS``HG_SERVER_PD_PEERS`
104+
> **Deprecated aliases**: `BACKEND``HG_SERVER_BACKEND`, `PD_PEERS``HG_SERVER_PD_PEERS`
104105
105106
## Port Reference
106107

@@ -124,12 +125,12 @@ curl http://localhost:8620/v1/partitions # Partition assignment
124125

125126
## Troubleshooting
126127

127-
**Containers OOM killed (exit code 137)**: Increase Docker Desktop memory to 12 GB+.
128+
1. **Containers exit due to OOM (`exit code 137`)**: Increase Docker Desktop memory to at least 12 GB, or reduce the JVM heap settings for the process that is being killed.
128129

129-
**Raft leader election timeout**: Check `HG_PD_RAFT_PEERS_LIST` is identical on all PD nodes. Verify connectivity: `docker exec hg-pd0 ping pd1`
130+
2. **Raft leader election timeout**: Check that `HG_PD_RAFT_PEERS_LIST` is identical on all PD nodes. Verify connectivity with `docker exec hg-pd0 ping pd1`.
130131

131-
**Partition assignment not completing**: Check `curl http://localhost:8620/v1/stores` all 3 stores must show `"state":"Up"` before partitions are assigned.
132+
3. **Partition assignment does not complete**: Check `curl http://localhost:8620/v1/stores` and confirm that all 3 stores show `"state":"Up"` before partition assignment can finish.
132133

133-
**Connection refused**: Ensure `HG_*` env vars use container hostnames (`pd0`, `store0`), not `127.0.0.1`.
134+
4. **Connection refused**: Ensure `HG_*` environment variables use container hostnames (`pd0`, `store0`) instead of `127.0.0.1`.
134135

135136
**Viewing runtime logs**: Use `docker logs <container-name>` (e.g. `docker logs hg-pd0`) to view logs directly without exec-ing into the container.

content/en/docs/quickstart/hugegraph/hugegraph-hstore.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,15 @@ mvn clean install -DskipTests=true
5252

5353
#### 3.3 Docker Deployment
5454

55-
The HugeGraph-Store Docker image is available on Docker Hub as `hugegraph/store:1.7.0`.
55+
The HugeGraph-Store Docker image is available on Docker Hub as `hugegraph/store`.
5656

57-
For a complete 3-node cluster with PD, Store, and Server, use the compose file:
57+
> **Note**: The following steps assume you have already cloned or pulled the HugeGraph main repository locally, or at least have its `docker/` directory available.
58+
59+
Use the compose file to deploy the complete 3-node cluster (PD + Store + Server):
5860

5961
```bash
6062
cd hugegraph/docker
63+
# Keep the version aligned with the latest release, for example 1.x.0
6164
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
6265
```
6366

@@ -157,7 +160,7 @@ Ensure that the PD service is already started, then in the Store installation di
157160
After successful startup, you can see logs similar to the following in `logs/hugegraph-store-server.log`:
158161

159162
```
160-
2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.s.n.StoreNodeApplication - Started StoreNodeApplication in x.xxx seconds (JVM running for x.xxx)
163+
2026-xx-xx xx:xx:xx [main] [INFO] o.a.h.s.n.StoreNodeApplication - Started StoreNodeApplication in x.xxx seconds (JVM running for x.xxx)
161164
```
162165

163166
#### 5.2 Stop Store
@@ -229,9 +232,9 @@ pdserver:
229232
address: 127.0.0.1:8686,127.0.0.1:8687,127.0.0.1:8688
230233
```
231234

232-
#### 6.3 Docker Cluster Quickstart
235+
#### 6.3 Docker Distributed Cluster Configuration
233236

234-
The 3-node Store cluster is included in `docker/docker-compose-3pd-3store-3server.yml`. Each Store node gets its own hostname and env vars:
237+
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:
235238

236239
```yaml
237240
# store0

content/en/docs/quickstart/hugegraph/hugegraph-pd.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,15 @@ mvn clean install -DskipTests=true
5151

5252
#### 3.3 Docker Deployment
5353

54-
The HugeGraph-PD Docker image is available on Docker Hub as `hugegraph/pd:1.7.0`.
54+
The HugeGraph-PD Docker image is available on Docker Hub as `hugegraph/pd`.
5555

56-
For a complete 3-node cluster with PD, Store, and Server, use the compose file:
56+
> **Note**: The following steps assume you have already cloned or pulled the HugeGraph main repository locally, or at least have its `docker/` directory available.
57+
58+
Use the `docker compose` setup to deploy the complete 3-node cluster (PD + Store + Server):
5759

5860
```bash
5961
cd hugegraph/docker
62+
# Keep the version aligned with the latest release, for example 1.x.0
6063
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
6164
```
6265

@@ -164,7 +167,7 @@ In the PD installation directory, execute:
164167
After successful startup, you can see logs similar to the following in `logs/hugegraph-pd-stdout.log`:
165168

166169
```
167-
2024-xx-xx xx:xx:xx [main] [INFO] o.a.h.p.b.HugePDServer - Started HugePDServer in x.xxx seconds (JVM running for x.xxx)
170+
2026-xx-xx xx:xx:xx [main] [INFO] o.a.h.p.b.HugePDServer - Started HugePDServer in x.xxx seconds (JVM running for x.xxx)
168171
```
169172

170173
#### 5.2 Stop PD

content/en/docs/quickstart/hugegraph/hugegraph-server.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,15 @@ If you use docker desktop, you can set the option like:
5858

5959
> **Note**: The Docker compose files use bridge networking (`hg-net`) and work on Linux and Mac (Docker Desktop). For the 3-node distributed cluster on Mac (Docker Desktop), allocate at least **12 GB** memory (Settings → Resources → Memory). On Linux, Docker uses host memory directly.
6060
61-
Also, if we want to manage HugeGraph-related instances in one file, we can use `docker compose` to deploy.
61+
If you want a single, unified setup for multiple HugeGraph services, you can use `docker compose`.
6262
Two compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
6363

6464
- **Single-node quickstart** (pre-built images): `docker/docker-compose.yml`
6565
- **Single-node dev build** (build from source): `docker/docker-compose.dev.yml`
6666

6767
```bash
6868
cd hugegraph/docker
69+
# Keep the version aligned with the latest release, for example 1.x.0
6970
HUGEGRAPH_VERSION=1.7.0 docker compose up -d
7071
```
7172

@@ -325,9 +326,9 @@ The sequence to stop the services should be the reverse of the startup sequence:
325326
bin/stop-hugegraph.sh
326327
```
327328

328-
#### Docker Cluster Quickstart
329+
#### Docker Distributed Cluster
329330

330-
For running the full distributed cluster (3 PD + 3 Store + 3 Server) via Docker:
331+
Run the full distributed cluster (3 PD + 3 Store + 3 Server) with Docker Compose:
331332

332333
```bash
333334
cd hugegraph/docker

0 commit comments

Comments
 (0)