doc: add docker-compose guide and update deployment docs#455
Open
bitflicker64 wants to merge 2 commits intoapache:masterfrom
Open
doc: add docker-compose guide and update deployment docs#455bitflicker64 wants to merge 2 commits intoapache:masterfrom
bitflicker64 wants to merge 2 commits intoapache:masterfrom
Conversation
imbajin
reviewed
Mar 8, 2026
|
|
||
| - 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) |
Member
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?
imbajin
changed the title
Member
|
BTW, we could only update the EN version during the review-period, then sync the CN version in the final stage |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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