Skip to content

Commit ae63fce

Browse files
committed
docs: add docker logs tip to Docker deployment sections
1 parent 0ed1498 commit ae63fce

4 files changed

Lines changed: 9 additions & 2 deletions

File tree

content/en/docs/guides/hugegraph-docker-cluster.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Previous versions used `network_mode: host` which only worked on Linux. The clus
1414

1515
- Docker Engine 20.10+ or Docker Desktop 4.x+
1616
- Docker Compose v2
17-
- For the 3-node cluster: at least **12 GB** memory allocated to Docker Desktop (Settings → Resources → Memory)
17+
- For the 3-node cluster on Mac (Docker Desktop): allocate at least **12 GB** memory (Settings → Resources → Memory)
1818

1919
> **Tested platforms**: Linux (native Docker) and macOS (Docker Desktop, tested on Apple M4). Windows Docker Desktop is untested.
2020
@@ -131,3 +131,5 @@ curl http://localhost:8620/v1/partitions # Partition assignment
131131
**Partition assignment not completing**: Check `curl http://localhost:8620/v1/stores` — all 3 stores must show `"state":"Up"` before partitions are assigned.
132132

133133
**Connection refused**: Ensure `HG_*` env vars use container hostnames (`pd0`, `store0`), not `127.0.0.1`.
134+
135+
**Viewing runtime logs**: Use `docker logs <container-name>` (e.g. `docker logs hg-pd0`) to view logs directly without exec-ing into the container.

content/en/docs/quickstart/hugegraph/hugegraph-hstore.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,8 @@ HG_STORE_RAFT_ADDRESS: store2:8510
255255

256256
Store nodes start only after all PD nodes pass healthchecks (`/v1/health`), enforced via `depends_on: condition: service_healthy`.
257257

258+
To view runtime logs for a running Store container use `docker logs <container-name>` (e.g. `docker logs hg-store0`).
259+
258260
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full setup guide.
259261

260262
### 7 Verify Store Service

content/en/docs/quickstart/hugegraph/hugegraph-pd.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ docker run -d \
9393
9494
> **Deprecated aliases**: `GRPC_HOST`, `RAFT_ADDRESS`, `RAFT_PEERS`, `PD_INITIAL_STORE_LIST` still work but log a deprecation warning. Use the `HG_PD_*` names for new deployments.
9595
96+
To view runtime logs for a running PD container use `docker logs <container-name>` (e.g. `docker logs hg-pd0`).
97+
9698
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full cluster setup guide.
9799

98100
### 4 Configuration

content/en/docs/quickstart/hugegraph/hugegraph-server.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ If you use docker desktop, you can set the option like:
5656
<img src="/docs/images/images-server/31docker-option.jpg" alt="image" style="width:33%;">
5757
</div>
5858

59-
> **Note**: The Docker compose files use bridge networking (`hg-net`) and work on Linux and Mac (Docker Desktop). For the 3-node distributed cluster, allocate at least **12 GB** memory to Docker Desktop (Settings → Resources → Memory).
59+
> **Note**: The Docker compose files use bridge networking (`hg-net`) and work on Linux and Mac (Docker Desktop). For the 3-node distributed cluster on Mac (Docker Desktop), allocate at least **12 GB** memory (Settings → Resources → Memory). On Linux, Docker uses host memory directly.
6060
6161
Also, if we want to manage HugeGraph-related instances in one file, we can use `docker compose` to deploy.
6262
Two compose files are available in the [`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
@@ -347,6 +347,7 @@ Verify the cluster:
347347
curl http://localhost:8080/versions
348348
curl http://localhost:8620/v1/stores
349349
```
350+
To view runtime logs for any container use `docker logs <container-name>` (e.g. `docker logs hg-pd0`).
350351

351352
See [docker/README.md](https://github.com/apache/hugegraph/blob/master/docker/README.md) for the full environment variable reference, port table, and troubleshooting guide.
352353
</details>

0 commit comments

Comments
 (0)