diff --git a/hugegraph-pd/README.md b/hugegraph-pd/README.md index b900673ace..794dba9b98 100644 --- a/hugegraph-pd/README.md +++ b/hugegraph-pd/README.md @@ -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 diff --git a/hugegraph-server/hugegraph-dist/docker/README.md b/hugegraph-server/hugegraph-dist/docker/README.md index 7ee88ab1fe..9214aa830e 100644 --- a/hugegraph-server/hugegraph-dist/docker/README.md +++ b/hugegraph-server/hugegraph-dist/docker/README.md @@ -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. diff --git a/hugegraph-store/README.md b/hugegraph-store/README.md index 223517525e..4e6bc8aca2 100644 --- a/hugegraph-store/README.md +++ b/hugegraph-store/README.md @@ -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