Skip to content

Commit 507c347

Browse files
Merge pull request #88848 from michaelryanpeter/osdocs-13342-4.18-update-example-outputs-CRs-and-nits
OSDOCS#13342: OLM v1 update example outputs, CRs, and nits
2 parents 4c89c57 + 292e628 commit 507c347

8 files changed

+359
-296
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2051,7 +2051,7 @@ Topics:
20512051
Distros: openshift-origin
20522052
- Name: Cluster Operators reference
20532053
File: operator-reference
2054-
- Name: OLM v1 (Technology Preview)
2054+
- Name: OLM v1
20552055
Dir: olm_v1
20562056
Distros: openshift-origin,openshift-enterprise
20572057
Topics:

modules/olmv1-adding-a-catalog.adoc

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,22 @@ To add a catalog to a cluster for {olmv1-first} usage, create a `ClusterCatalog`
1616
.Example `my-redhat-operators.yaml` file
1717
[source,yaml,subs="attributes+"]
1818
----
19-
apiVersion: catalogd.operatorframework.io/v1alpha1
19+
apiVersion: olm.operatorframework.io/v1
2020
kind: ClusterCatalog
2121
metadata:
22-
name: my-redhat-operators
22+
name: my-redhat-operators <1>
2323
spec:
24+
priority: 1000 <2>
2425
source:
25-
type: image
2626
image:
27-
ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} <1>
28-
pollInterval: <poll_interval_duration> <2>
27+
pollIntervalMinutes: 10 <3>
28+
ref: registry.redhat.io/redhat/community-operator-index:v{product-version} <4>
29+
type: Image
2930
----
30-
<1> Specify the catalog's image in the `spec.source.image` field.
31-
<2> Specify the interval for polling the remote registry for newer image digests. The default value is `24h`. Valid units include seconds (`s`), minutes (`m`), and hours (`h`). To disable polling, set a zero value, such as `0s`.
31+
<1> The catalog is automatically labeled with the value of the `metadata.name` field when it is applied to the cluster. For more information about labels and catalog selection, see "Catalog content resolution".
32+
<2> Optional: Specify the priority of the catalog in relation to the other catalogs on the cluster. For more information, see "Catalog selection by priority".
33+
<3> Specify the interval in minutes for polling the remote registry for newer image digests. To disable polling, do not set the field.
34+
<4> Specify the catalog image in the `spec.source.image.ref` field.
3235

3336
. Add the catalog to your cluster by running the following command:
3437
+
@@ -40,7 +43,7 @@ $ oc apply -f my-redhat-operators.yaml
4043
.Example output
4144
[source,text]
4245
----
43-
catalog.catalogd.operatorframework.io/my-redhat-operators created
46+
clustercatalog.olm.operatorframework.io/my-redhat-operators created
4447
----
4548

4649
.Verification
@@ -57,15 +60,19 @@ $ oc get clustercatalog
5760
.Example output
5861
[source,text]
5962
----
60-
NAME AGE
61-
my-redhat-operators 20s
63+
NAME LASTUNPACKED SERVING AGE
64+
my-redhat-operators 55s True 64s
65+
openshift-certified-operators 83m True 84m
66+
openshift-community-operators 43m True 84m
67+
openshift-redhat-marketplace 83m True 84m
68+
openshift-redhat-operators 54m True 84m
6269
----
6370

6471
.. Check the status of your catalog by running the following command:
6572
+
6673
[source,terminal]
6774
----
68-
$ oc describe clustercatalog
75+
$ oc describe clustercatalog my-redhat-operators
6976
----
7077
+
7178
.Example output
@@ -78,39 +85,43 @@ Annotations: <none>
7885
API Version: olm.operatorframework.io/v1
7986
Kind: ClusterCatalog
8087
Metadata:
81-
Creation Timestamp: 2024-06-10T17:34:53Z
88+
Creation Timestamp: 2025-02-18T20:28:50Z
8289
Finalizers:
83-
catalogd.operatorframework.io/delete-server-cache
90+
olm.operatorframework.io/delete-server-cache
8491
Generation: 1
85-
Resource Version: 46075
86-
UID: 83c0db3c-a553-41da-b279-9b3cddaa117d
92+
Resource Version: 50248
93+
UID: 86adf94f-d2a8-4e70-895b-31139f2eeab7
8794
Spec:
8895
Availability Mode: Available
89-
Priority: 0
96+
Priority: 1000
9097
Source:
9198
Image:
9299
Poll Interval Minutes: 10
93-
Ref: registry.redhat.io/redhat/redhat-operator-index:v4.18
94-
Type: image
100+
Ref: registry.redhat.io/redhat/community-operator-index:v{product-version}
101+
Type: Image
95102
Status: <1>
96103
Conditions:
97-
Last Transition Time: 2024-06-10T17:35:15Z
98-
Message:
99-
Reason: UnpackSuccessful <2>
104+
Last Transition Time: 2025-02-18T20:29:00Z
105+
Message: Successfully unpacked and stored content from resolved source
106+
Observed Generation: 1
107+
Reason: Succeeded <2>
100108
Status: True
101-
Type: Unpacked
102-
Content URL: https://catalogd-catalogserver.openshift-catalogd.svc/catalogs/redhat-operators/all.json
103-
Observed Generation: 1
104-
Phase: Unpacked <3>
109+
Type: Progressing
110+
Last Transition Time: 2025-02-18T20:29:00Z
111+
Message: Serving desired content from resolved source
112+
Observed Generation: 1
113+
Reason: Available
114+
Status: True
115+
Type: Serving
116+
Last Unpacked: 2025-02-18T20:28:59Z
105117
Resolved Source:
106118
Image:
107-
Last Poll Attempt: 2024-06-10T17:35:10Z
108-
Ref: registry.redhat.io/redhat/redhat-operator-index:v4.18
109-
Resolved Ref: registry.redhat.io/redhat/redhat-operator-index@sha256:f2ccc079b5e490a50db532d1dc38fd659322594dcf3e653d650ead0e862029d9 <4>
110-
Type: image
111-
Events: <none>
119+
Ref: registry.redhat.io/redhat/community-operator-index@sha256:11627ea6fdd06b8092df815076e03cae9b7cede8b353c0b461328842d02896c5 <3>
120+
Type: Image
121+
Urls:
122+
Base: https://catalogd-service.openshift-catalogd.svc/catalogs/my-redhat-operators
123+
Events: <none>
112124
----
113125
<1> Describes the status of the catalog.
114126
<2> Displays the reason the catalog is in the current state.
115-
<3> Displays the phase of the installation process.
116-
<4> Displays the image reference of the catalog.
127+
<3> Displays the image reference of the catalog.

modules/olmv1-catalog-queries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ a|
4747
[source,terminal]
4848
----
4949
$ opm render <catalog_registry_url>:<tag> \
50-
\| jq -s '.[] \| select( .schema == "olm.package")
50+
\| jq -s '.[] \| select( .schema == "olm.package")'
5151
----
5252

5353
|Packages that support `AllNamespaces` install mode and do not use webhooks

modules/olmv1-clusterextension-api.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,19 @@ For more information about the earlier behavior, see _Multitenancy and Operator
2020
.Example `ClusterExtension` object
2121
[source,yaml]
2222
----
23-
apiVersion: olm.operatorframework.io/v1alpha1
23+
apiVersion: olm.operatorframework.io/v1
2424
kind: ClusterExtension
2525
metadata:
26-
name: <operator_name>
26+
name: <extension_name>
2727
spec:
28-
packageName: <package_name>
29-
installNamespace: <namespace_name>
30-
channel: <channel_name>
31-
version: <version_number>
28+
namespace: <namespace_name>
29+
serviceAccount:
30+
name: <service_account_name>
31+
source:
32+
sourceType: Catalog
33+
catalog:
34+
packageName: <package_name>
35+
channels:
36+
- <channel>
37+
version: "<version>"
3238
----

modules/olmv1-deleting-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ $ oc delete clustercatalog <catalog_name>
2525
.Example output
2626
[source,text]
2727
----
28-
catalog.catalogd.operatorframework.io "my-catalog" deleted
28+
clustercatalog.olm.operatorframework.io "my-redhat-operators" deleted
2929
----
3030

3131
.Verification

modules/olmv1-installing-an-operator.adoc

Lines changed: 67 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,47 @@ You can install an extension from a catalog by creating a custom resource (CR) a
1717

1818
. Create a CR, similar to the following example:
1919
+
20+
[source,yaml]
21+
----
22+
apiVersion: olm.operatorframework.io/v1
23+
kind: ClusterExtension
24+
metadata:
25+
name: <clusterextension_name>
26+
spec:
27+
namespace: <installed_namespace> <1>
28+
serviceAccount:
29+
name: <service_account_installer_name> <2>
30+
source:
31+
sourceType: Catalog
32+
catalog:
33+
packageName: <package_name>
34+
channels:
35+
- <channel_name> <3>
36+
version: <version_or_version_range> <4>
37+
----
38+
<1> Specifies the namespace where you want the bundle installed, such as `pipelines` or `my-extension`. Extensions are still cluster-scoped and might contain resources that are installed in different namespaces.
39+
<2> Specifies the name of the service account you created to install, update, and manage your extension.
40+
<3> Optional: Specifies channel names as an array, such as `pipelines-1.14` or `latest`.
41+
<4> Optional: Specifies the version or version range, such as `1.14.0`, `1.14.x`, or `>=1.16`, of the package you want to install or update. For more information, see "Example custom resources (CRs) that specify a target version" and "Support for version ranges".
42+
2043
.Example `pipelines-operator.yaml` CR
2144
[source,yaml]
2245
----
23-
apiVersion: olm.operatorframework.io/v1alpha1
46+
apiVersion: olm.operatorframework.io/v1
2447
kind: ClusterExtension
2548
metadata:
2649
name: pipelines-operator
2750
spec:
28-
packageName: openshift-pipelines-operator-rh
29-
installNamespace: <namespace>
51+
namespace: pipelines
3052
serviceAccount:
31-
name: <service_account>
32-
channel: <channel>
33-
version: "<version>"
53+
name: pipelines-installer
54+
source:
55+
sourceType: Catalog
56+
catalog:
57+
packageName: openshift-pipelines-operator-rh
58+
version: "1.14.x"
3459
----
35-
+
36-
where:
37-
+
38-
`<namespace>`:: Specifies the namespace where you want the bundle installed, such as `pipelines` or `my-extension`. Extensions are still cluster-scoped and might contain resources that are installed in different namespaces.
39-
`<service_account>`:: Specifies the name of the service account you created to install, update, and manage your extension.
40-
`<channel>`:: Optional: Specifies the channel, such as `pipelines-1.11` or `latest`, for the package you want to install or update.
41-
`<version>`:: Optional: Specifies the version or version range, such as `1.11.1`, `1.12.x`, or `>=1.12.1`, of the package you want to install or update. For more information, see "Example custom resources (CRs) that specify a target version" and "Support for version ranges".
60+
4261

4362
. Apply the CR to the cluster by running the following command:
4463
+
@@ -69,76 +88,76 @@ $ oc get clusterextension pipelines-operator -o yaml
6988
----
7089
apiVersion: v1
7190
items:
72-
- apiVersion: olm.operatorframework.io/v1alpha1
91+
- apiVersion: olm.operatorframework.io/v1
7392
kind: ClusterExtension
7493
metadata:
7594
annotations:
7695
kubectl.kubernetes.io/last-applied-configuration: |
77-
{"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"pipelines","packageName":"openshift-pipelines-operator-rh","serviceAccount":{"name":"pipelines-installer"},"pollInterval":"30m"}}
78-
creationTimestamp: "2024-06-10T17:50:51Z"
96+
{"apiVersion":"olm.operatorframework.io/v1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipes"},"spec":{"namespace":"pipelines","serviceAccount":{"name":"pipelines-installer"},"source":{"catalog":{"packageName":"openshift-pipelines-operator-rh","version":"1.14.x"},"sourceType":"Catalog"}}}
97+
creationTimestamp: "2025-02-18T21:48:13Z"
7998
finalizers:
8099
- olm.operatorframework.io/cleanup-unpack-cache
100+
- olm.operatorframework.io/cleanup-contentmanager-cache
81101
generation: 1
82102
name: pipelines-operator
83-
resourceVersion: "53324"
84-
uid: c54237be-cde4-46d4-9b31-d0ec6acc19bf
103+
resourceVersion: "72725"
104+
uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
85105
spec:
86-
channel: latest
87-
installNamespace: pipelines
88-
packageName: openshift-pipelines-operator-rh
106+
namespace: pipelines
89107
serviceAccount:
90108
name: pipelines-installer
91-
upgradeConstraintPolicy: Enforce
109+
source:
110+
catalog:
111+
packageName: openshift-pipelines-operator-rh
112+
upgradeConstraintPolicy: CatalogProvided
113+
version: 1.14.x
114+
sourceType: Catalog
92115
status:
93116
conditions:
94-
- lastTransitionTime: "2024-06-10T17:50:58Z"
95-
message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
96-
observedGeneration: 1
97-
reason: Success
98-
status: "True"
99-
type: Resolved
100-
- lastTransitionTime: "2024-06-10T17:51:11Z"
101-
message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
102-
observedGeneration: 1
103-
reason: Success
104-
status: "True"
105-
type: Installed
106-
- lastTransitionTime: "2024-06-10T17:50:58Z"
117+
- lastTransitionTime: "2025-02-18T21:48:13Z"
107118
message: ""
108119
observedGeneration: 1
109120
reason: Deprecated
110121
status: "False"
111122
type: Deprecated
112-
- lastTransitionTime: "2024-06-10T17:50:58Z"
123+
- lastTransitionTime: "2025-02-18T21:48:13Z"
113124
message: ""
114125
observedGeneration: 1
115126
reason: Deprecated
116127
status: "False"
117128
type: PackageDeprecated
118-
- lastTransitionTime: "2024-06-10T17:50:58Z"
129+
- lastTransitionTime: "2025-02-18T21:48:13Z"
119130
message: ""
120131
observedGeneration: 1
121132
reason: Deprecated
122133
status: "False"
123134
type: ChannelDeprecated
124-
- lastTransitionTime: "2024-06-10T17:50:58Z"
135+
- lastTransitionTime: "2025-02-18T21:48:13Z"
125136
message: ""
126137
observedGeneration: 1
127138
reason: Deprecated
128139
status: "False"
129140
type: BundleDeprecated
130-
- lastTransitionTime: "2024-06-10T17:50:58Z"
131-
message: 'unpack successful:
141+
- lastTransitionTime: "2025-02-18T21:48:16Z"
142+
message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:f7b19ce26be742c4aaa458d37bc5ad373b5b29b20aaa7d308349687d3cbd8838
143+
successfully
132144
observedGeneration: 1
133-
reason: UnpackSuccess
145+
reason: Succeeded
134146
status: "True"
135-
type: Unpacked
136-
installedBundle:
137-
name: openshift-pipelines-operator-rh.v1.14.4
138-
version: 1.14.4
139-
resolvedBundle:
140-
name: openshift-pipelines-operator-rh.v1.14.4
141-
version: 1.14.4
147+
type: Installed
148+
- lastTransitionTime: "2025-02-18T21:48:16Z"
149+
message: desired state reached
150+
observedGeneration: 1
151+
reason: Succeeded
152+
status: "True"
153+
type: Progressing
154+
install:
155+
bundle:
156+
name: openshift-pipelines-operator-rh.v1.14.5
157+
version: 1.14.5
158+
kind: List
159+
metadata:
160+
resourceVersion: ""
142161
----
143162
where:
144163
@@ -156,6 +175,4 @@ where:
156175
The value of `False` in the `status` field indicates that the `reason: Deprecated` condition is not deprecated. The value of `True` in the `status` field indicates that the `reason: Deprecated` condition is deprecated.
157176
`installedBundle.name`:: Displays the name of the bundle installed.
158177
`installedBundle.version`:: Displays the version of the bundle installed.
159-
`resolvedBundle.name`:: Displays the name of the resolved bundle.
160-
`resolvedBundle.version`:: Displays the version of the resolved bundle.
161178
====

0 commit comments

Comments
 (0)