docs: Image Digest Pinning #6870
Open
+42
−0
Conversation
This file contains 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
Add an "advanced" article to describe how `relatedImages` and image digest pinning works. This includes the use of `RELATED_IMAGE_*` environment variables to digest pin operands deployed by the operator, which is not currently documented. Signed-off-by: Adam Kaplan <[email protected]>
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.
Description of the change:
Add an "advanced" article to describe how
relatedImagesand image digest pinning works. This includes the use ofRELATED_IMAGE_*environment variables to digest pin operands deployed by the operator, which is not currently documented.Motivation for the change:
I was very confused by the behavior of
relatedImagesand digest pinning. For example - when attempting to setrelatedImagesin the base CSV manifest, I discovered thatoperator-sdk generate bundlewould always overwrite therelatedImagesfield in tree. It wasn't until I started iterating on a pull request (#6869) that I discovered there is an undocumented environment variable that lets operator authors define and wire in image digests for their operands.Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs