docs: fix stale x-healthcheck claim, document default-user convention and healthchecks - #152
Merged
Conversation
… and healthchecks
AGENTS.md claimed common.yml has a shared x-healthcheck anchor - it
never did, every service declares its own healthcheck directly.
Corrected, and added a proper "Healthchecks" section recommending
checking the image's own docs/CLI first (with cloudflared's tunnel
ready and rybbit-client's wget as real examples verified against
running containers), plus the standard shape used throughout the
catalog.
Also documents the "connect as the engine's default user, never a
scoped ${APP_NAME} user" convention in prose - previously only visible
as inline comments in each template - and notes vault env: values can
be literals as well as ${NAME} references.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
common.ymlhas a sharedx-healthcheckanchor - it never did, every service declareshealthcheck:directly in its own compose file.tunnel readyand rybbit-client'swgetas real examples (both verified against running containers before being committed). Also documents the standard field shape used throughout the catalog.postgres/root/default), never a scoped${APP_NAME}user - previously only visible as inline comments in each template. Explains why (some images' "custom user" env var renames the built-in account rather than adding one; some apps hardcode which username they connect as).env:values can be literals, not just${NAME}references.depends_onguidance (item 8) which claimed "healthchecks are in common.yml" and to never usecondition:- both no longer true now thatcondition: service_healthyis used where it matters (e.g. rybbit's backend).Test plan
deploy/tests/+encrypt-env/tests/+load-yaml-matrix/tests/(67 tests) pass