Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Feature] Server image: map server.urls_to_pd and server.deploy_in_k8s from the environment, and stop editing conf files in place

Open
  • Is something wrong?
#3,286 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
docker, helm, java, kubernetes
Domain
backend, databases, infrastructure

Research direction

Start with hugegraph-server/hugegraph-dist/docker/docker-entrypoint.sh, especially the existing HG_SERVER_* mappings and set_prop_encoded; then inspect the Helm wrapper in helm/hugegraph/templates/server-deployment.yaml and the read-only filesystem constraint in _helpers.tpl. The work includes adding both environment mappings and rendering effective configuration without modifying the image's conf/; verify the chart can rely on the entrypoint rather than its wrapper. The issue notes this is not proposed for 1.8.0.

Written by the indexing model from the issue text.

Description

Feature Description (功能描述)

The Server image entrypoint maps a set of environment variables onto the conf files (docker-entrypoint.sh:161-172), but two keys a Server on PD needs in Kubernetes have no mapping:

  • server.urls_to_pd: the URL the Server registers with PD
  • server.deploy_in_k8s

The Helm chart therefore wraps the entrypoint and rewrites rest-server.properties itself before execing it (server-deployment.yaml:161-232).

The entrypoint also edits the conf files in place: set_prop_encoded runs sed -ri on the file under conf/ (docker-entrypoint.sh:65-66). The image's conf/ must be writable, so the chart refuses readOnlyRootFilesystem for Server (_helpers.tpl:838-839).

Proposal:

  1. Map HG_SERVER_URLS_TO_PD to server.urls_to_pd and HG_SERVER_DEPLOY_IN_K8S to server.deploy_in_k8s, next to the existing HG_SERVER_* mappings.
  2. Render the effective conf into a writable directory (a copy of conf/ under a data or temp path) and start the Server from it. The image's own conf/ is then never modified, and readOnlyRootFilesystem becomes possible once #3211 (non-root image) also lands. #3253 makes the conf path overridable, which this step could build on.

With both, the chart can drop its wrapper. The TODO at docker-entrypoint.sh:156 (from #3260) points here.

Not proposed for 1.8.0: the chart's wrapper covers it.

Dominant language
Java
Stars
3.2k
Forks
641
Avg merge
1d 16h
Merged PRs (30d)
38

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/hugegraph

All issues in apache/hugegraph

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.