Skip to content

docs(docker): correct the crash-file volume and directory notes - #3332

Merged
imbajin merged 1 commit into
apache:masterfrom
byteayan:fix/docker-readme-crash-volume-notes
Oct 13, 2026
Merged

imbajin merged 1 commit into
apache:masterfrom
byteayan:fix/docker-readme-crash-volume-notes

Conversation

@byteayan

@byteayan byteayan commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Two sentences in the "Server logs and crash files" section that #3258 added are wrong. I pushed the fixes to that branch after it was squash-merged, so they never reached master. apache/hugegraph-doc#509 already has the corrected wording.

  • A later docker compose down -v does not remove a volume that an earlier plain down left behind, because it only removes anonymous volumes of the containers it removes. The README now says to note the volume name with docker inspect before down and remove it with docker volume rm <name>. It also warns that docker volume prune deletes every unused anonymous volume on the Docker host.
  • A start that fails before Java runs does not create a heapdump_* directory, so "each start leaves a directory behind" now reads "each start that gets as far as starting Java leaves a directory behind".
  • A shared logs PVC only works for pods on different nodes if its storage supports read-write mounts from several nodes (typically ReadWriteMany). The README now says so and suggests a PVC per pod otherwise.

Doc - No Need: apache/hugegraph-doc#509 has the same wording.

A later `docker compose down -v` does not remove a volume that an
earlier plain `down` left behind. Say to note its name with
`docker inspect` and remove it with `docker volume rm <name>`, and warn
that `docker volume prune` deletes every unused anonymous volume on the
Docker host. Only a start that gets as far as starting Java creates a
`heapdump_*` directory.
@imbajin
imbajin merged commit 87097bc into apache:master Oct 13, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants