doc: add docker-compose guide and update deployment docs#455
doc: add docker-compose guide and update deployment docs#455bitflicker64 wants to merge 4 commits intoapache:masterfrom
Conversation
|
|
||
| - Docker Engine 20.10+ or Docker Desktop 4.x+ | ||
| - Docker Compose v2 | ||
| - For the 3-node cluster: at least **12 GB** memory allocated to Docker Desktop (Settings → Resources → Memory) |
There was a problem hiding this comment.
maybe we need minimum the memory usage? (12G → 4G?)
PS: like 1~3 server + 3pd + 3 store is fine for a test?
There was a problem hiding this comment.
During testing I hit OOM kills with 8GB in Docker Desktop which caused silent Raft failures so I bumped to 12GB and it worked, that's why I documented it. I haven't done any JVM heap tuning, containers are running with default settings. If the default heaps can be reduced for a test scenario that would help lower the requirement, happy to update the docs once we know a confirmed working lower limit.
|
BTW, we could only update the EN version during the review-period, then sync the CN version in the final stage |
|
Updated all EN files pinned HUGEGRAPH_VERSION=1.7.0 on all compose commands, updated image references from :latest to 1.7.0, and removed the stale clone workaround notes. CN sync can be done in the final stage. |
| @@ -1,4 +1,4 @@ | |||
| --- | |||
| cl--- | |||
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for running HugeGraph’s Docker-based distributed cluster (bridge networking), and updates existing deployment quickstarts to reference the new Docker/compose guidance introduced in apache/hugegraph#2952.
Changes:
- Add new EN/CN “HugeGraph Docker Cluster Guide” pages with quickstarts, env var reference tables, ports, and troubleshooting.
- Update EN/CN HugeGraph-Server quickstart Docker section to reference
docker/compose files and include a cluster quickstart. - Add Docker deployment sections (with
HG_PD_*/HG_STORE_*env var tables) to the PD and Store quickstarts (EN/CN).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| content/en/docs/quickstart/hugegraph/hugegraph-server.md | Updates Docker links/compose guidance and adds a Docker cluster quickstart; removes inline compose example. |
| content/en/docs/quickstart/hugegraph/hugegraph-pd.md | Adds Docker deployment section and HG_PD_* env var reference. |
| content/en/docs/quickstart/hugegraph/hugegraph-hstore.md | Adds Docker deployment section and HG_STORE_* env var reference; adds Docker cluster quickstart notes. |
| content/en/docs/guides/hugegraph-docker-cluster.md | New EN standalone Docker cluster guide. |
| content/cn/docs/quickstart/hugegraph/hugegraph-server.md | CN mirror updates for Docker links/compose guidance plus cluster quickstart. |
| content/cn/docs/quickstart/hugegraph/hugegraph-pd.md | CN mirror Docker deployment section and env var reference. |
| content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md | CN mirror Docker deployment section and cluster quickstart notes. |
| content/cn/docs/guides/hugegraph-docker-cluster.md | New CN standalone Docker cluster guide. |
Comments suppressed due to low confidence (2)
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md:46
- The “Compile from source” instructions mention cloning the repo, but the actual
git clonecommand was removed. Please restore the clone step (or rewrite the section to clearly assume an existing working copy) so the build steps are complete.
```bash
# 1. Clone the source code
# 2. Build the project
cd hugegraph
mvn clean install -DskipTests=true
content/en/docs/quickstart/hugegraph/hugegraph-pd.md:45
- The “Compile from source” step says “# 1. Clone the source code” but no clone command is provided (it was removed), so the instructions can’t be followed as-is. Please add the appropriate
git clone+cdsteps or adjust the section text to match the intended workflow.
```bash
# 1. Clone the source code
# 2. Build the project
cd hugegraph
mvn clean install -DskipTests=true
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Purpose of the PR
Follow-up documentation update for apache/hugegraph#2952 which migrated Docker cluster setup from
network_mode: hostto Docker bridge networking.Related PR: apache/hugegraph#2952
The doc repo had no wrong content — it simply never documented the Docker-based distributed cluster setup at all. This PR adds that missing documentation.
Main Changes
content/en/docs/guides/hugegraph-docker-cluster.md— new standalone Docker cluster guide covering single-node and 3-node setup, fullHG_*env var reference tables, port reference, health checks, and troubleshootingcontent/cn/docs/guides/hugegraph-docker-cluster.md— Chinese mirrorhugegraph-server.md(EN + CN) — fix Docker README URL, replace outdated inline compose yaml with references to newdocker/files, add 3-node cluster Docker quickstart inside section 5.1.1, add auth notehugegraph-pd.md(EN + CN) — add section 3.3 Docker Deployment withHG_PD_*env var reference tablehugegraph-hstore.md(EN + CN) — add section 3.3 Docker Deployment withHG_STORE_*env var reference table, add section 6.3 Docker cluster quickstart