You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: content/en/docs/guides/hugegraph-docker-cluster.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,32 +6,33 @@ weight: 5
6
6
7
7
## Overview
8
8
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.
12
10
13
11
## Prerequisites
14
12
15
13
- Docker Engine 20.10+ or Docker Desktop 4.x+
16
14
- 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.
18
16
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).
20
18
21
19
## Compose Files
22
20
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:
24
22
25
23
| File | Description |
26
24
|------|-------------|
27
-
|`docker-compose.yml`| Single-node quickstart using pre-built images |
28
-
|`docker-compose.dev.yml`| Single-node dev build from source |
|`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.
30
30
31
31
## Single-Node Quickstart
32
32
33
33
```bash
34
34
cd hugegraph/docker
35
+
# Keep the version aligned with the latest release, for example 1.x.0
35
36
HUGEGRAPH_VERSION=1.7.0 docker compose up -d
36
37
```
37
38
@@ -47,12 +48,12 @@ cd hugegraph/docker
47
48
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
48
49
```
49
50
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
54
55
55
-
Verify the cluster:
56
+
Verify that the cluster is healthy:
56
57
```bash
57
58
curl http://localhost:8620/v1/health # PD health
58
59
curl http://localhost:8520/v1/health # Store health
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.
128
129
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`.
130
131
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.
132
133
133
-
**Connection refused**: Ensure `HG_*`env vars use container hostnames (`pd0`, `store0`), not`127.0.0.1`.
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`.
56
56
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):
58
60
59
61
```bash
60
62
cd hugegraph/docker
63
+
# Keep the version aligned with the latest release, for example 1.x.0
61
64
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
62
65
```
63
66
@@ -157,7 +160,7 @@ Ensure that the PD service is already started, then in the Store installation di
157
160
After successful startup, you can see logs similar to the following in `logs/hugegraph-store-server.log`:
158
161
159
162
```
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)
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:
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`.
55
55
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):
57
59
58
60
```bash
59
61
cd hugegraph/docker
62
+
# Keep the version aligned with the latest release, for example 1.x.0
60
63
HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml up -d
61
64
```
62
65
@@ -164,7 +167,7 @@ In the PD installation directory, execute:
164
167
After successful startup, you can see logs similar to the following in `logs/hugegraph-pd-stdout.log`:
165
168
166
169
```
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)
Copy file name to clipboardExpand all lines: content/en/docs/quickstart/hugegraph/hugegraph-server.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,14 +58,15 @@ If you use docker desktop, you can set the option like:
58
58
59
59
> **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.
60
60
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`.
62
62
Two compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
0 commit comments