Skip to content

Commit 2cd1921

Browse files
committed
review updates
Signed-off-by: Jordan <jordan@nimblewidget.com>
1 parent b6e8295 commit 2cd1921

3 files changed

Lines changed: 25 additions & 26 deletions

File tree

content/en/docs/Concepts/crds/clusterserviceversion.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,12 @@ Use the `release` field when you need to make changes to the CSV that don't affe
121121

122122
### Format and Validation
123123

124-
The `release` field must conform to the [semver prerelease format](https://semver.org/spec/v2.0.0.html#spec-item-9):
125-
- Dot-separated identifiers containing only alphanumerics and hyphens
124+
The `release` field must satisfy the following criteria:
125+
- Composed of dot-separated identifiers containing only alphanumerics and hyphens
126126
- Maximum length of 20 characters
127127
- **Cannot contain build metadata** (the `+` character and everything after it)
128-
- Examples: `1`, `alpha`, `alpha.1`, `beta-1`, `rc.2.0`
128+
129+
Examples: `1`, `alpha`, `alpha.1`, `beta-1`, `rc.2.0`
129130

130131
### Example
131132

@@ -161,15 +162,15 @@ Bundles are ordered using a composite version that considers both `version` and
161162

162163
1. Bundles are first ordered by semantic version
163164
2. For bundles with the same version, those **with** a release are ordered **before** those **without** a release
164-
3. Bundles with the same version and both having releases are ordered by their release version
165+
3. Bundles with the same version and both having releases are ordered from highest to lowest release version
165166

166167
```mermaid
167168
graph TD
168169
A[Bundle Comparison] --> B{Same Version?}
169170
B -->|No| C[Order by Version]
170171
B -->|Yes| D{Both have Release?}
171172
D -->|No| E{Has Release?}
172-
D -->|Yes| F[Order by decreasing Release]
173+
D -->|Yes| F[Order by Release]
173174
E -->|Bundle A| G[A before B]
174175
E -->|Bundle B| H[B before A]
175176
@@ -180,13 +181,13 @@ graph TD
180181
style H fill:#c3e6cb
181182
```
182183

183-
**Example ordering:**
184+
**Example versions in ascending order:**
184185
```
185186
memcached-operator.v0.9.0 # version 0.9.0, no release
186-
memcached-operator-v0.10.0-alpha # version 0.10.0, release "alpha"
187-
memcached-operator-v0.10.0-2 # version 0.10.0, release "2"
188-
memcached-operator-v0.10.0-1 # version 0.10.0, release "1"
189187
memcached-operator.v0.10.0 # version 0.10.0, no release
188+
memcached-operator-v0.10.0-1 # version 0.10.0, release "1"
189+
memcached-operator-v0.10.0-2 # version 0.10.0, release "2"
190+
memcached-operator-v0.10.0-alpha # version 0.10.0, release "alpha"
190191
```
191192
192193
### Build Metadata Restriction

content/en/docs/Reference/catalog-templates.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,8 @@ The `opm` tool provides the capability to generate a substitutes template from e
219219
],
220220
"substitutions": [
221221
{
222-
"name":,
223-
"base":
222+
"name": "",
223+
"base": ""
224224
}
225225
]
226226
}
@@ -568,9 +568,7 @@ schema: olm.channel
568568

569569
## Substitutes Template
570570

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.
574572

575573
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:
576574

@@ -597,7 +595,7 @@ When you define a substitution:
597595
1. The template validates that the substitute bundle has a higher composite version than the base bundle
598596
2. For each channel containing the base bundle, the template:
599597
- 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
601599
- Adds a skip edge from substitute to base
602600
- Updates all other entries that reference the base to reference the substitute instead
603601

@@ -651,7 +649,7 @@ properties:
651649
#### Step 2: Create New Bundle with Release
652650

653651
You discover `foo.v1.0.0` is missing a critical annotation.
654-
You
652+
You:
655653
1. update the bundle's annotation in `metadata/annotations.yaml`
656654
2. update the bundle's CSV with `spec.release` set (here set to 1)
657655
3. ensure that the bundle's `metadata-name` follows the format required for using release versions

content/en/docs/Reference/file-based-catalogs.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ OLM defines a handful of property types, again using the reserved `olm.*` prefix
357357

358358
An `olm.package` property defines the package name and version. This is a required property on bundles, and there must
359359
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.
361361

362362
The `olm.package` property [cue][cuelang-spec] schema is:
363363
```cue
@@ -646,7 +646,7 @@ The `olm.bundle.object` property [cue][cuelang-spec] schema is:
646646
#### `olm.package` with Release Version
647647

648648
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
650650

651651
Use the `release` field when you need to:
652652

@@ -788,8 +788,8 @@ flowchart LR
788788
D -->|Yes| F[Order by release]
789789
D -->|No| G{Which has<br/>release?}
790790
791-
G -->|A| H[B before A]
792-
G -->|B| I[A before B]
791+
G -->|A| H[B &lt; A]
792+
G -->|B| I[A &lt; B]
793793
794794
F --> J[Bundle A &lt; Bundle B<br/>1 &lt; 2]
795795
@@ -806,17 +806,17 @@ flowchart LR
806806
**Ordering rules:**
807807
1. Compare by version first (using semver comparison)
808808
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
810810
- Bundles both having releases are ordered by their release version (using semver prerelease comparison)
811811

812-
**Example ordering sequence:**
812+
**Example ascending order sequence:**
813813
```
814814
foo.v0.2.0 # v0.2.0, no release
815-
foo-v0.3.0-2 # v0.3.0, release "2"
816-
foo-v0.3.0-1 # v0.3.0, release "1"
817-
foo-v0.3.0-beta.1 # v0.3.0, release "beta.1"
818-
foo-v0.3.0-alpha # v0.3.0, release "alpha" (beta > alpha lexicographically)
819815
foo.v0.3.0 # v0.3.0, no release
816+
foo-v0.3.0-1 # v0.3.0, release "1" is greater than no release
817+
foo-v0.3.0-2 # v0.3.0, release "2" is greater than release "1"
818+
foo-v0.3.0-alpha # v0.3.0, release "alpha" is greater than release "2"
819+
foo-v0.3.0-beta.1 # v0.3.0, release "beta.1" is greater than release "alpha"
820820
foo.v0.4.0 # v0.4.0, no release
821821
```
822822

0 commit comments

Comments
 (0)