Repository navigation
docs: document image pinning, add make module-pin - #178
Merged
Merged
Conversation
Companion to gameplane-module#35, which pins every module image by digest. - docs/module-authoring.md gains a "Pinning images by digest" section: what the rule requires (defaults are ERROR, other version entries may float), why the readable repo:tag@sha256 form is preferred over a bare digest, the `# gameplane:floating` opt-out and when it is legitimate, and why the written digest is the tag/index digest rather than a per-platform one. Also fixes the version-catalog example, which showed unpinned refs the new rule would now reject. - `make module-pin` sits next to module-schema as the other module codegen entry point. - docs/roadmap.md: correct a stale claim. It listed "restore-path coverage against a real restic repository" as outstanding, but TestRestore_RoundTrip has covered exactly that for some time -- writing a marker, backing up, wiping, restoring and asserting the bytes return, against the real in-cluster restic server. Only the human-facing drill runbook is missing. Signed-off-by: valgulnecron <39313199+ValgulNecron@users.noreply.github.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
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.
Companion to gameplane-module#35, which pins every module image by digest and gives 8 games a version list. The submodule pointer bump follows in a separate PR once that one merges.
docs/module-authoring.mdgains a Pinning images by digest section: what the rule requires (spec.imageand anydefault: trueentry are ERROR if unpinned; other version entries may float), why the readablerepo:tag@sha256:…form is preferred over a bare digest, the# gameplane:floatingopt-out and when it is legitimate, and why the written digest is the tag/index digest rather than a per-platform one (so pinned modules still run on arm64). Also fixes the version-catalog example, which showed unpinned refs the new rule would now reject.make module-pinsits next tomodule-schemaas the other module codegen entry point.docs/roadmap.md: corrects a stale claim. It listed "restore-path coverage against a real restic repository" as outstanding, butTestRestore_RoundTrip(test/e2e/restore_e2e_test.go) has covered exactly that for some time — it writes a marker into a server's PVC, backs it up, wipes it, restores, and asserts the bytes came back, against the real in-cluster restic-serverensureResticRepoprovisions. Only the human-facing drill runbook is actually missing, and the roadmap now says so.Docs + a Makefile target, so no CI checks are expected to run.