Skip to content

docs(docker): drop --rm, add --name + restart policy in run examples - #1927

Merged
nicoloboschi merged 1 commit into
mainfrom
fix/1918-docker-docs-drop-rm
Jun 2, 2026
Merged

nicoloboschi merged 1 commit into
mainfrom
fix/1918-docker-docs-drop-rm

Conversation

@nicoloboschi

Copy link
Copy Markdown
Collaborator

Summary

Addresses the resilience half of #1918. A single child segfault under load propagates through start-all.sh's cleanup and exits the whole container; with the documented docker run --rm invocation there is no recovery, so a transient crash becomes indefinite downtime.

Replaces --rm with --name hindsight --restart unless-stopped in the documented server-run commands so a transient crash self-heals:

  • README.md
  • hindsight-api-slim/README.md, hindsight-api/README.md (no --pull/-p 9999 here — kept as-is)
  • hindsight-docs/docs/developer/installation.md, hindsight-docs/docs/developer/api/quickstart.mdx
  • skills/hindsight-docs/** — regenerated mirror (pre-commit hook), tracks the source edits

Left untouched: the throwaway docker run --rm --entrypoint sh model-inspection command in docker/docker-compose/custom-models/README.md (ephemeral; --rm is correct there), plus cookbook recipes, blog posts, and frozen versioned_docs snapshots.

On the pydantic suggestion in the issue

Investigated the suggested pydantic-core bump — it is not actionable today:

  • pydantic enforces its exact pydantic-core pin at import time (SystemError if mismatched), so you can't just swap the core.
  • Stable pydantic 2.13.4 hard-requires pydantic-core==2.46.4 (the crashing build); the only release pairing with 2.47.0 is the alpha pydantic 2.14.0a1.
  • No evidence 2.47.0 fixes this specific concurrent-recall GPF.

Also note the published image resolves pydantic fresh at build time (the Dockerfile copies only pyproject.toml and runs uv sync without --frozen), so a lockfile pin wouldn't reach the image regardless. Deferred per maintainer decision; revisit when a stable pydantic pairs with a fixed pydantic-core.

Note

With a fixed --name hindsight, re-running the quickstart errors with "name in use" until docker rm hindsight — the expected tradeoff for a stable name + restart policy on a single-instance deployment.

Refs #1918

A single child segfault under load propagates through start-all.sh and
exits the whole container; with the documented --rm run there was no
recovery. Replace --rm with --name hindsight --restart unless-stopped in
the documented server-run commands so a transient crash self-heals.

Leaves the throwaway --rm --entrypoint sh model-inspection command in
custom-models/README.md untouched. Refs #1918.
@nicoloboschi
nicoloboschi merged commit 8a1f046 into main Jun 2, 2026
79 checks passed
cdbartholomew added a commit that referenced this pull request Oct 20, 2026
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.

1 participant