Skip to content

docs: document -d flag and Docker process supervision model #3056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bitflicker64 wants to merge 2 commits into
base: master
Choose a base branch
from
+18 −2
Open

docs: document -d flag and Docker process supervision model #3056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97b197d
docs: document -d flag and Docker process supervision model
bitflicker64 Jun 9, 2026
532f8cd
docs(docker): qualify restart-policy behavior for non-compose users
bitflicker64 Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion hugegraph-pd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,13 @@ bin/stop-hugegraph-pd.sh
#### Startup Options

```bash
bin/start-hugegraph-pd.sh [-g GC_TYPE] [-j "JVM_OPTIONS"] [-y ENABLE_OTEL]
bin/start-hugegraph-pd.sh [-g GC_TYPE] [-j "JVM_OPTIONS"] [-y ENABLE_OTEL] [-d DAEMON]
```

- `-g`: GC type (`g1` or `ZGC`, default: `g1`)
- `-j`: Custom JVM options (e.g., `-j "-Xmx4g -Xms4g"`)
- `-y`: Enable OpenTelemetry tracing (`true` or `false`, default: `false`)
- `-d`: Daemon mode (`true` = daemon, `false` = foreground; default: `true`). Set to `false` when running under Docker or a process supervisor so the container exits if Java dies.

### Configuration

Expand Down
14 changes: 14 additions & 0 deletions hugegraph-server/hugegraph-dist/docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,17 @@ HUGEGRAPH_VERSION=1.7.0 docker compose -f docker-compose-3pd-3store-3server.yml

See [docker/README.md](../../../docker/README.md) for the full setup guide,
environment variable reference, and troubleshooting.

## 6. Process Supervision & Health Checks

All four HugeGraph Docker images (PD, Store, Server, Server-hstore) include
native `HEALTHCHECK` instructions. `docker ps` shows real health status:

| Image | Health endpoint |
|---|---|
| `hugegraph/hugegraph` | `GET /versions` on port 8080 |
| `hugegraph/hugegraph-hstore` | `GET /versions` on port 8080 |
| `hugegraph/hugegraph-pd` | `GET /v1/health` on port 8620 |
| `hugegraph/hugegraph-store` | `GET /v1/health` on port 8520 |

The entrypoints supervise the Java process directly — when Java exits, the container exits. If started with a restart policy (the provided compose files use `restart: unless-stopped`), Docker will bring it back automatically. The old cron-based monitor (`-m true`) is for VM/bare-metal deployments only and is not used in Docker images.
3 changes: 2 additions & 1 deletion hugegraph-store/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,12 @@ bin/restart-hugegraph-store.sh
#### Startup Options

```bash
bin/start-hugegraph-store.sh [-g GC_TYPE] [-j "JVM_OPTIONS"]
bin/start-hugegraph-store.sh [-g GC_TYPE] [-j "JVM_OPTIONS"] [-d DAEMON]
```

- `-g`: GC type (`g1` or `ZGC`, default: `g1`)
- `-j`: Custom JVM options (e.g., `-j "-Xmx16g -Xms8g"`)
- `-d`: Daemon mode (`true` = daemon, `false` = foreground; default: `true`). Set to `false` when running under Docker or a process supervisor so the container exits if Java dies.

Default JVM memory settings (defined in `start-hugegraph-store.sh`):
- Max heap: 32GB
Expand Down
Loading