add bundle release version attribute, substitutes template #342
+636
−3
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
Signed-off-by: grokspawn <jordan@nimblewidget.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for a new bundle release version attribute that enables packaging-only revisions of operators. The feature introduces an optional release field for ClusterServiceVersions and file-based catalog bundles, along with a new substitutes template for managing bundle replacements.
Changes:
- Extended
olm.packageproperty schema to support optionalreleasefield with format constraints and validation rules - Documented new substitutes template (
olm.template.substitutes) for safely replacing bundles with packaging revisions - Added
releasefield documentation to ClusterServiceVersion spec with naming conventions and version ordering rules
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| content/en/docs/Reference/file-based-catalogs.md | Adds Bundle Release Property section documenting the optional release field in olm.package, including use cases, naming conventions, format constraints, and composite version ordering |
| content/en/docs/Reference/catalog-templates.md | Documents the new substitutes template for replacing bundles, including schema, workflow diagrams, validation rules, and complete working examples |
| content/en/docs/Concepts/crds/clusterserviceversion.md | Adds Release Field section to CSV documentation with format validation, naming conventions, and version ordering behavior |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
grokspawn
force-pushed
the
release-version
branch
from
63fc0e5 to
d8f8404
Compare
Signed-off-by: grokspawn <jordan@nimblewidget.com>
grokspawn
force-pushed
the
release-version
branch
from
d8f8404 to
05659c6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
With merge of operator-framework/api#454 (for CSV) and operator-framework/operator-registry#1792 (for FBC and substitutes template support), we have new capabilities to express the concept of a packaging-only revision of an operator.
Expressed in the ClusterServiceVersion as an optional release field, captured in the
olm.bundleFBC schema version propertyolm.packageand leveraged in the new substitutes template type, this attribute opens up a new axis in bundle operator versioning.This release version allows migration to the new version on clusters with the old version installed, and facilitates graph updates to prefer the new release version over previous versions.