Skip to content

docs: Image Digest Pinning#6870

Closed
adambkaplan wants to merge 1 commit into
operator-framework:masterfrom
adambkaplan:doc-advanced-digest-pinning
Closed

docs: Image Digest Pinning#6870
adambkaplan wants to merge 1 commit into
operator-framework:masterfrom
adambkaplan:doc-advanced-digest-pinning

Conversation

@adambkaplan
Copy link
Copy Markdown

Description of the change:

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.

Motivation for the change:

I was very confused by the behavior of relatedImages and digest pinning. For example - when attempting to set relatedImages in the base CSV manifest, I discovered that operator-sdk generate bundle would always overwrite the relatedImages field 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:

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 <adam.kaplan@redhat.com>
@openshift-ci openshift-ci Bot requested review from fabianvf and grokspawn November 20, 2024 17:31
@openshift-bot
Copy link
Copy Markdown

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci Bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 19, 2025
@openshift-bot
Copy link
Copy Markdown

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci Bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 21, 2025
@adambkaplan
Copy link
Copy Markdown
Author

@sdk-approvers is operator-sdk accepting documentation improvements?

@openshift-bot
Copy link
Copy Markdown

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

@openshift-ci openshift-ci Bot closed this Apr 21, 2025
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 21, 2025

@openshift-bot: Closed this PR.

Details

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants