You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/Reference/catalog-templates.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,8 +219,8 @@ The `opm` tool provides the capability to generate a substitutes template from e
219
219
],
220
220
"substitutions": [
221
221
{
222
-
"name":,
223
-
"base":
222
+
"name": "",
223
+
"base": ""
224
224
}
225
225
]
226
226
}
@@ -568,9 +568,7 @@ schema: olm.channel
568
568
569
569
## Substitutes Template
570
570
571
-
The substitutes template provides a safe and structured way to replace bundles in an upgrade graph with newer packaging versions. This is particularly useful when you need to republish a bundle with non-functional changes (documentation fixes, label updates, etc.) and want to ensure users upgrade to the new bundle.
572
-
573
-
#### Problem Statement
571
+
The substitutes template provides a safe and structured way to replace bundles in an upgrade graph with newer packaging versions. This is particularly useful when you need to republish a bundle with non-functional changes (documentation fixes, label updates, etc.) and want to ensure users can upgrade to the new bundle.
574
572
575
573
Before the substitutes template, when you needed to replace a bundle in a catalog (for example, `foo.v1.0.0` with a documentation fix), you had two options:
576
574
@@ -597,7 +595,7 @@ When you define a substitution:
597
595
1. The template validates that the substitute bundle has a higher composite version than the base bundle
598
596
2. For each channel containing the base bundle, the template:
599
597
- Adds the new bundle to the channel
600
-
- Move upgrade edges (replaces, skips, skipRange) from the base to the substitute
598
+
- Moves upgrade edges (replaces, skips, skipRange) from the base to the substitute
601
599
- Adds a skip edge from substitute to base
602
600
- Updates all other entries that reference the base to reference the substitute instead
603
601
@@ -651,7 +649,7 @@ properties:
651
649
#### Step 2: Create New Bundle with Release
652
650
653
651
You discover `foo.v1.0.0` is missing a critical annotation.
654
-
You
652
+
You:
655
653
1. update the bundle's annotation in `metadata/annotations.yaml`
656
654
2. update the bundle's CSV with `spec.release` set (here set to 1)
657
655
3. ensure that the bundle's `metadata-name` follows the format required for using release versions
Copy file name to clipboardExpand all lines: content/en/docs/Reference/file-based-catalogs.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -357,7 +357,7 @@ OLM defines a handful of property types, again using the reserved `olm.*` prefix
357
357
358
358
An `olm.package` property defines the package name and version. This is a required property on bundles, and there must
359
359
be exactly one of these properties. The `packageName` must match the bundle's first-class `package` field, the
360
-
`version`must be a valid [semantic version][semver], and it may include an optional `release` bundle packaging identifier. See the [Bundle Release Property](#bundle_release_property) section for additional format requirements and examples.
360
+
`version`must be a valid [semantic version][semver], and the package may include an optional `release` bundle packaging field. See the [Bundle Release Property](#bundle-release-property) section for additional format requirements and examples.
361
361
362
362
The `olm.package` property [cue][cuelang-spec] schema is:
363
363
```cue
@@ -646,7 +646,7 @@ The `olm.bundle.object` property [cue][cuelang-spec] schema is:
646
646
#### `olm.package` with Release Version
647
647
648
648
The `olm.package` property has been extended to support an optional `release` field that specifies the packaging version of a bundle. This allows catalog maintainers to distinguish between different builds of the same operator version.
649
-
###### Use Cases for Bundle Release
649
+
##### Use Cases for Bundle Release
650
650
651
651
Use the `release` field when you need to:
652
652
@@ -788,8 +788,8 @@ flowchart LR
788
788
D -->|Yes| F[Order by release]
789
789
D -->|No| G{Which has<br/>release?}
790
790
791
-
G -->|A| H[B before A]
792
-
G -->|B| I[A before B]
791
+
G -->|A| H[B < A]
792
+
G -->|B| I[A < B]
793
793
794
794
F --> J[Bundle A < Bundle B<br/>1 < 2]
795
795
@@ -806,17 +806,17 @@ flowchart LR
806
806
**Ordering rules:**
807
807
1. Compare by version first (using semver comparison)
808
808
2. If versions are equal:
809
-
- Bundles **with** a release come **before** bundles **without** a release
809
+
- Bundles **with** a release are **greater than** bundles **without** a release
810
810
- Bundles both having releases are ordered by their release version (using semver prerelease comparison)
0 commit comments