mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-07 04:12:04 +00:00
docs(deploy): warn that an image pin is sticky and a stale pin is silent
The digest-pinning section explained how to set HEALTHLOG_IMAGE_REF and never said what happens if it is left behind. It stays until someone changes it, and every deploy in between reports success while the running instance holds the previous release. Adds the warning, the two post-deploy checks that would have caught it (the version endpoint AND the running container's image, because the first alone can be served from a cache), the note that a suspiciously fast deploy is a signal, and the duplicate-key trap: the platform accepts two rows with the same key without warning and does not define which wins.
This commit is contained in:
1 parent
a8b61abf6f
commit
207010e8fa
1 file changed
+17
@@ -131,6 +131,23 @@ without touching the file:
|
||||
- `HEALTHLOG_IMAGE_REF=:v1.16.5` — pin to a release tag (still mutable).
|
||||
- `HEALTHLOG_IMAGE_REF=@sha256:<digest>` — pin to the immutable digest.
|
||||
|
||||
> **A pin is sticky, and a stale pin is silent.** Once set, every later deploy
|
||||
> ships that reference until someone changes it. The deploy still reports
|
||||
> success, the tag still builds, the image still publishes, and the running
|
||||
> instance stays on the old release. If you pin, bumping the pin is part of
|
||||
> shipping, not an afterthought. If you would rather not carry that step, leave
|
||||
> the variable unset: `docker-publish.yml` rotates `:latest` on every release tag
|
||||
> without a pre-release suffix, so the git tag stays the single place a version is
|
||||
> declared.
|
||||
>
|
||||
> Two checks after any deploy, because the first alone can be served from a
|
||||
> cache: `/api/version` must report the version and commit you shipped, and the
|
||||
> running container's image must be the one you expect
|
||||
> (`docker inspect <container> --format '{{.Config.Image}}'`). A deploy that
|
||||
> finishes suspiciously fast is a signal rather than good news. Also watch for a
|
||||
> DUPLICATE `HEALTHLOG_IMAGE_REF` entry: Coolify accepts two rows with the same
|
||||
> key without warning, and which one wins is not defined.
|
||||
|
||||
### Promote a release to a pinned digest
|
||||
|
||||
`scripts/promote-digest.ts` automates the whole promotion after
|
||||
|
||||
Reference in new issue
Block a user