docs: document -d flag and Docker process supervision model #3056
Conversation
- Add -d true|false option to PD and Store startup options sections (default: true = daemon; false = foreground for Docker/supervisors) - Add section to docker/README.md explaining HEALTHCHECK endpoints and the Java process supervision model (replaces old cron monitor) Chunk 10 of apache#3043.
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## master #3056 +/- ##
============================================
- Coverage 34.89% 1.48% -33.42%
+ Complexity 338 21 -317
============================================
Files 803 781 -22
Lines 68241 65726 -2515
Branches 8965 8517 -448
============================================
- Hits 23815 975 -22840
- Misses 41826 64667 +22841
+ Partials 2600 84 -2516 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
imbajin
left a comment
There was a problem hiding this comment.
Blocking: no. Summary: The Docker supervision docs overstate restart behavior for direct docker run users. Evidence: static review of hugegraph-server/hugegraph-dist/docker/README.md and the compose files.
Latest-head CI has a visible failure; please also check codecov/project: 🔗 https://app.codecov.io/gh/apache/hugegraph/pull/3056
Clarify that automatic container restart requires a restart policy (e.g. restart: unless-stopped in the provided compose files). Direct docker run users need to pass --restart unless-stopped explicitly. Addresses review feedback on apache#3056.
imbajin
left a comment
There was a problem hiding this comment.
+1, the doc update matches the current Docker supervision behavior.
One non-blocking follow-up: since the README also has direct docker run examples, it may be helpful to add a small --restart unless-stopped example or note there as well. The new section already scopes restart behavior correctly, but an inline example would make it harder for users to miss.
ill make a follow up pr later with the chore fixes 🫡 |
Purpose of the PR
-dflag to PD/Store startup scripts) and fix(docker): supervise Java process in entrypoints instead of tail -f /dev/null #3051/chore(docker): add HEALTHCHECK & clean Dockerfiles #3052 (Docker entrypoint supervision + HEALTHCHECK)Documents the new
-d true|falsedaemon flag and the Docker-native process supervision model introduced in the preceding PRs.Main Changes
hugegraph-pd/README.md:-d DAEMONto the startup options signaturetrue= daemon,false= foreground; default:true); set tofalseunder Docker or a process supervisorhugegraph-store/README.md:hugegraph-server/hugegraph-dist/docker/README.md::8080/versions,:8620/v1/health,:8520/v1/health) and the Java process supervision model-m true) is for VM/bare-metal only, not DockerVerifying these changes
docker inspect <image> | grep -A5 Healthcheck— confirms HEALTHCHECK is presentdocker stop <container>— container exits cleanly (SIGTERM forwarded to Java)kill -9 <java-pid>inside container — container exits, restart policy firesDoes this PR potentially affect the following parts?
Documentation Status
Doc - Updated(in-repo README files only;hugegraph-docfollow-up is tracked separately)