Skip to content

docs: document Docker process supervision model and -d flag (EN + CN) #461

Open
bitflicker64 wants to merge 2 commits into
apache:masterfrom
bitflicker64:docs/docker-supervision-model
Open

docs: document Docker process supervision model and -d flag (EN + CN) #461
bitflicker64 wants to merge 2 commits into
apache:masterfrom
bitflicker64:docs/docker-supervision-model

Conversation

@bitflicker64

Copy link
Copy Markdown
Contributor

Purpose of the PR

Follow-up documentation for apache/hugegraph#3043.

Covers changes merged in:

  • apache/hugegraph#3047 — added -d true|false flag to start-hugegraph-pd.sh and start-hugegraph-store.sh
  • apache/hugegraph#3051 — replaced tail -f /dev/null in all three Docker entrypoints with proper Java process supervision
  • apache/hugegraph#3052 — added native HEALTHCHECK to all four Dockerfiles and removed unused cron

Main Changes

Docker cluster guide (hugegraph-docker-cluster.md, EN + CN):

  • Add "Container Supervision & Health Checks" section explaining the new exec/tail --pid supervision model
  • Add HEALTHCHECK endpoint table for all four images (PD, Store, Server, hstore)
  • Note that the cron-based monitor (-m true) is for VM/bare-metal only, not Docker

PD quickstart (hugegraph-pd.md, EN + CN):

  • Document the -d flag: -d true (default) = daemon, -d false = foreground for Docker/process supervisors

Store quickstart (hugegraph-hstore.md, EN + CN):

  • Same -d flag documentation for start-hugegraph-store.sh

Verifying these changes

  • Need tests and can be verified as follows:
    • Read the updated sections and confirm they match the actual script behavior in apache/hugegraph master

Does this PR potentially affect the following parts?

  • Dependencies
  • Modify configurations
  • The public API
  • Other affects
  • Nope

Documentation Status

  • Doc - Updated

- Add Container Supervision & Health Checks section to Docker cluster
  guide (EN + CN): explains exec/tail --pid supervision model,
  HEALTHCHECK endpoints for all four images, and cron monitor deprecation
- Add -d flag documentation to PD and Store quickstart guides (EN + CN):
  -d true (default) = daemon, -d false = foreground for Docker/supervisors

Follow-up to apache/hugegraph#3043, #3047, #3051, #3052.

@imbajin imbajin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Doc looks aligned with the intended direction, but the image version scope should be clarified before this is merged.

Comment thread content/en/docs/guides/hugegraph-docker-cluster.md
…ction

The supervision model and HEALTHCHECK behavior documented in this section
are not present in 1.7.0 images. Add a callout in EN and CN so users
on 1.7.0 are directed to use latest or wait for the next release tag.

Addresses review feedback on apache#461.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants