PKO-275 Add documentation for Global Image Prefix Override feature #20
Conversation
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
erdii
requested changes
May 5, 2025
…refix Override feature
radimous
suggested changes
Aug 11, 2025
| weight: 2001 | ||
| --- | ||
|
|
||
| The Global Image Prefix Override feature enables deployment of upstream package-operator artifacts from private registries without rebuilding them in downstream pipelines. This solves the previously impossible scenario where organizations needed to mirror upstream images while maintaining original deployment manifests, without referencing the workload images with PKO's internal image digest feature. |
There was a problem hiding this comment.
the feature enables using mirrored package and workload images without needing to rebuild the images with new image references
mirroring pko artifacts to private registry is just our use case of this feature
|
|
||
| ## Usage Example | ||
|
|
||
| The following `mirror.sh` script demonstrates a the mirroring of the images and the modification of the bootstrap job manifests. (Images for version v1.82.2 are mirrored from the namespace `quary.io/package-operator` into the namespace `quay.io/erdii-test/pko-mirror`). |
There was a problem hiding this comment.
Suggested change
| The following `mirror.sh` script demonstrates a the mirroring of the images and the modification of the bootstrap job manifests. (Images for version v1.82.2 are mirrored from the namespace `quary.io/package-operator` into the namespace `quay.io/erdii-test/pko-mirror`). | |
| The following `mirror.sh` script demonstrates a the mirroring of the images and the modification of the bootstrap job manifests. (Images for version v1.82.2 are mirrored from the namespace `quay.io/package-operator` into the namespace `quay.io/erdii-test/pko-mirror`). |
Contributor
Author
There was a problem hiding this comment.
Good catch. Will commit manually.
| Modifying the container's `.image` field | ||
| Updating the first command-line argument in .args[0] | ||
|
|
||
| This is required as some componenets might directly reference images without respecting the prefix override, so the need to be explicitly changed. This ensures all PKO package image pulls during bootstrap come from your mirror location. |
There was a problem hiding this comment.
Suggested change
| This is required as some componenets might directly reference images without respecting the prefix override, so the need to be explicitly changed. This ensures all PKO package image pulls during bootstrap come from your mirror location. | |
| This is required as some components might directly reference images without respecting the prefix override, so the need to be explicitly changed. This ensures all PKO package image pulls during bootstrap come from your mirror location. |
Contributor
Author
There was a problem hiding this comment.
I will make this change manually, I noticed that the "the" should be "they need to be.." as well.
avollmer-redhat
requested review from
pbabic-redhat and
robshelly
as code owners
Contributor
Author
|
All change requests were made. Pending final review. |
erdii
requested changes
Aug 25, 2025
erdii
approved these changes
Sep 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This PR adds documentation to the package-operator documentation website for global image prefix overrides.
Documents:
Jira: PKO-237
Documentation ticket:
Jira: PKO-275
This PR does not contain integration tests as it is documentation. It can be previewed by running a hugo server locally. Screenshots of localhost version attached to JIRA ticket.
Change Type
New Feature documentation