docs: document -d flag and Docker process supervision model #3056
Open
bitflicker64 wants to merge 1 commit into
Open
docs: document -d flag and Docker process supervision model #3056bitflicker64 wants to merge 1 commit into
bitflicker64 wants to merge 1 commit into
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:
|
11 tasks
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
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
-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)