Skip to content

docs: add HG_SERVER_URLS_TO_PD and HG_SERVER_DEPLOY_IN_K8S - #529

Merged
imbajin merged 3 commits into
apache:masterfrom
byteayan:doc/server-urls-to-pd-env
Oct 17, 2026
Merged

imbajin merged 3 commits into
apache:masterfrom
byteayan:doc/server-urls-to-pd-env

Conversation

@byteayan

Copy link
Copy Markdown
Contributor

Purpose of the PR

Paired with apache/hugegraph#3352; please merge the two together. That PR makes the Server image entrypoint map HG_SERVER_URLS_TO_PD to server.urls_to_pd and HG_SERVER_DEPLOY_IN_K8S to server.deploy_in_k8s in rest-server.properties.

  • guides/hugegraph-docker-cluster.md (EN and CN): two rows in the Server variable table with the code defaults (http://0.0.0.0:8080, false). The URL row says the list is read only when server.deploy_in_k8s is true and that whitespace is removed. The note on accepted boolean spellings now covers HG_SERVER_DEPLOY_IN_K8S as well as HG_SERVER_INIT_STORE_ENABLED.
  • config/config-guide.md (EN and CN): both names added to the list of variables the master entrypoint processes.

Checked with git diff --check; no links changed. I didn't build the site locally; the edits are table rows and inline text only.

The Server image entrypoint on master now maps both variables to
server.urls_to_pd and server.deploy_in_k8s (apache/hugegraph#3286).
List them in the Docker cluster guide and the config guide, in English
and Chinese.

@bitflicker64 bitflicker64 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking: yes. Summary: Score 7/10. The documented names, defaults (http://0.0.0.0:8080, false), the switch from restserver.url to server.urls_to_pd, the whitespace removal and the accepted boolean spellings all match apache/hugegraph#3352 at 7a207d46, and the EN and CN pages agree. The blocking problem is that the pages describe master behaviour that does not exist until #3352 merges; one Minor point covers the missing per-URL scheme note. Evidence: read the full diff from merge-base a5731b8 (4 files, +8/-4); compared it with docker-entrypoint.sh on master e130233c (only the TODO at line 177) and at #3352 head 7a207d46 (the tr -d '[:space:]' step, the case check that exits on 0/1, and the two set_prop calls), ServerOptions (SERVER_URLS_TO_PD, SERVER_DEPLOY_IN_K8S and their defaults), GraphManager (split(",") and service.urls(...) only when serverDeployInK8s), and HugeConfig.prefixSchemeIfMissing. The site build CI at this head passes. I did not build the site locally.

Comment thread content/en/docs/config/config-guide.md
Comment thread content/en/docs/guides/hugegraph-docker-cluster.md Outdated
…-to-pd-env

# Conflicts:
#	content/cn/docs/guides/hugegraph-docker-cluster.md
#	content/en/docs/guides/hugegraph-docker-cluster.md
server.urls_to_pd is URL-normalized as one string, so only the first
entry gets http:// added; GraphManager then registers the rest of the
comma-separated list as written. Say so in the EN and CN variable rows.
@byteayan

Copy link
Copy Markdown
Contributor Author

@bitflicker64 @imbajin the code side, apache/hugegraph#3352, is merged, and I rechecked the wording against it (see the hold thread). This is ready to merge whenever you have a moment.

@imbajin
imbajin merged commit 3498150 into apache:master Oct 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants