Doc: update Docker deployment docs for bridge networking migration (#2952)#2963
Open
bitflicker64 wants to merge 3 commits intoapache:masterfrom
Open
Doc: update Docker deployment docs for bridge networking migration (#2952)#2963bitflicker64 wants to merge 3 commits intoapache:masterfrom
bitflicker64 wants to merge 3 commits intoapache:masterfrom
Conversation
- Create docker/README.md with full setup guide, env var reference, port table, health checks, and troubleshooting - Fix hugegraph-store/docs/deployment-guide.md: replace wrong env vars (GRPC_HOST, RAFT_ADDRESS etc.) with correct HG_* names - Update K8s manifest in deployment-guide.md to use HG_* env vars - Fix 7 files pointing to dead docker/example/ directory - Add Docker bridge network notes to PD configuration docs - Add distributed cluster section to server Docker README Relates to: apache#2952
The 3-node and single-node quickstart compose files currently mount entrypoint scripts from source as a workaround until updated Docker images are published with the new entrypoints baked in. Add a clear note explaining this temporary requirement so users are not confused about needing a full source clone to run the cluster. Relates to: apache#2952
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
1 participant
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
Update all Docker deployment documentation to reflect the bridge networking migration from PR #2952. The old docs referenced a dead directory, used wrong environment variable names, and had no guidance for Docker Desktop users on Mac/Windows.
Main Changes
docker/README.md(new file) — comprehensive setup guide covering single-node and 3-node cluster, fullHG_*env var reference tables for PD/Store/Server, port reference, health verification commands, troubleshooting (OOM, Raft, partitions), and a note about the temporary entrypoint mount workaround until updated images are publishedhugegraph-store/docs/deployment-guide.md— replace Docker Compose section that used completely wrong env var names (GRPC_HOST,RAFT_ADDRESS,RAFT_PEERS,PD_ADDRESS,BACKEND,PD_PEERS) with correctHG_*names; also fix K8s manifest env var nameshugegraph-server/hugegraph-dist/docker/example/directory — update to point todocker/with correct file names (docker-compose.yml,docker-compose-dev.yml,docker-compose-3pd-3store-3server.yml)hugegraph-pd/docs/configuration.md,hugegraph-pd/README.md,hugegraph-pd/AGENTS.md— clarify thatgrpc.hostaccepts container hostnames in bridge mode viaHG_PD_GRPC_HOSThugegraph-server/hugegraph-dist/docker/README.mddocker runexamples inhugegraph-pd/README.mdandhugegraph-store/README.mdto use correctHG_*env var namesVerifying these changes
Does this PR potentially affect the following parts?
Documentation Status
Doc - Done