mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-13342: Update example outputs, CRs, and other nits
This commit is contained in:
Michael Ryan Peter
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
9db472ca6b
commit
7452f7bf3c
@@ -2050,7 +2050,7 @@ Topics:
|
||||
Distros: openshift-origin
|
||||
- Name: Cluster Operators reference
|
||||
File: operator-reference
|
||||
- Name: OLM v1 (Technology Preview)
|
||||
- Name: OLM v1
|
||||
Dir: olm_v1
|
||||
Distros: openshift-origin,openshift-enterprise
|
||||
Topics:
|
||||
|
||||
@@ -16,19 +16,22 @@ To add a catalog to a cluster for {olmv1-first} usage, create a `ClusterCatalog`
|
||||
.Example `my-redhat-operators.yaml` file
|
||||
[source,yaml,subs="attributes+"]
|
||||
----
|
||||
apiVersion: catalogd.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterCatalog
|
||||
metadata:
|
||||
name: my-redhat-operators
|
||||
name: my-redhat-operators <1>
|
||||
spec:
|
||||
priority: 1000 <2>
|
||||
source:
|
||||
type: image
|
||||
image:
|
||||
ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} <1>
|
||||
pollInterval: <poll_interval_duration> <2>
|
||||
pollIntervalMinutes: 10 <3>
|
||||
ref: registry.redhat.io/redhat/community-operator-index:v{product-version} <4>
|
||||
type: Image
|
||||
----
|
||||
<1> Specify the catalog's image in the `spec.source.image` field.
|
||||
<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`.
|
||||
<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".
|
||||
<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".
|
||||
<3> Specify the interval in minutes for polling the remote registry for newer image digests. To disable polling, do not set the field.
|
||||
<4> Specify the catalog image in the `spec.source.image.ref` field.
|
||||
|
||||
. Add the catalog to your cluster by running the following command:
|
||||
+
|
||||
@@ -40,7 +43,7 @@ $ oc apply -f my-redhat-operators.yaml
|
||||
.Example output
|
||||
[source,text]
|
||||
----
|
||||
catalog.catalogd.operatorframework.io/my-redhat-operators created
|
||||
clustercatalog.olm.operatorframework.io/my-redhat-operators created
|
||||
----
|
||||
|
||||
.Verification
|
||||
@@ -57,15 +60,19 @@ $ oc get clustercatalog
|
||||
.Example output
|
||||
[source,text]
|
||||
----
|
||||
NAME AGE
|
||||
my-redhat-operators 20s
|
||||
NAME LASTUNPACKED SERVING AGE
|
||||
my-redhat-operators 55s True 64s
|
||||
openshift-certified-operators 83m True 84m
|
||||
openshift-community-operators 43m True 84m
|
||||
openshift-redhat-marketplace 83m True 84m
|
||||
openshift-redhat-operators 54m True 84m
|
||||
----
|
||||
|
||||
.. Check the status of your catalog by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc describe clustercatalog
|
||||
$ oc describe clustercatalog my-redhat-operators
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
@@ -78,39 +85,43 @@ Annotations: <none>
|
||||
API Version: olm.operatorframework.io/v1
|
||||
Kind: ClusterCatalog
|
||||
Metadata:
|
||||
Creation Timestamp: 2024-06-10T17:34:53Z
|
||||
Creation Timestamp: 2025-02-18T20:28:50Z
|
||||
Finalizers:
|
||||
catalogd.operatorframework.io/delete-server-cache
|
||||
olm.operatorframework.io/delete-server-cache
|
||||
Generation: 1
|
||||
Resource Version: 46075
|
||||
UID: 83c0db3c-a553-41da-b279-9b3cddaa117d
|
||||
Resource Version: 50248
|
||||
UID: 86adf94f-d2a8-4e70-895b-31139f2eeab7
|
||||
Spec:
|
||||
Availability Mode: Available
|
||||
Priority: 0
|
||||
Priority: 1000
|
||||
Source:
|
||||
Image:
|
||||
Poll Interval Minutes: 10
|
||||
Ref: registry.redhat.io/redhat/redhat-operator-index:v4.18
|
||||
Type: image
|
||||
Ref: registry.redhat.io/redhat/community-operator-index:v{product-version}
|
||||
Type: Image
|
||||
Status: <1>
|
||||
Conditions:
|
||||
Last Transition Time: 2024-06-10T17:35:15Z
|
||||
Message:
|
||||
Reason: UnpackSuccessful <2>
|
||||
Last Transition Time: 2025-02-18T20:29:00Z
|
||||
Message: Successfully unpacked and stored content from resolved source
|
||||
Observed Generation: 1
|
||||
Reason: Succeeded <2>
|
||||
Status: True
|
||||
Type: Unpacked
|
||||
Content URL: https://catalogd-catalogserver.openshift-catalogd.svc/catalogs/redhat-operators/all.json
|
||||
Observed Generation: 1
|
||||
Phase: Unpacked <3>
|
||||
Type: Progressing
|
||||
Last Transition Time: 2025-02-18T20:29:00Z
|
||||
Message: Serving desired content from resolved source
|
||||
Observed Generation: 1
|
||||
Reason: Available
|
||||
Status: True
|
||||
Type: Serving
|
||||
Last Unpacked: 2025-02-18T20:28:59Z
|
||||
Resolved Source:
|
||||
Image:
|
||||
Last Poll Attempt: 2024-06-10T17:35:10Z
|
||||
Ref: registry.redhat.io/redhat/redhat-operator-index:v4.18
|
||||
Resolved Ref: registry.redhat.io/redhat/redhat-operator-index@sha256:f2ccc079b5e490a50db532d1dc38fd659322594dcf3e653d650ead0e862029d9 <4>
|
||||
Type: image
|
||||
Events: <none>
|
||||
Ref: registry.redhat.io/redhat/community-operator-index@sha256:11627ea6fdd06b8092df815076e03cae9b7cede8b353c0b461328842d02896c5 <3>
|
||||
Type: Image
|
||||
Urls:
|
||||
Base: https://catalogd-service.openshift-catalogd.svc/catalogs/my-redhat-operators
|
||||
Events: <none>
|
||||
----
|
||||
<1> Describes the status of the catalog.
|
||||
<2> Displays the reason the catalog is in the current state.
|
||||
<3> Displays the phase of the installation process.
|
||||
<4> Displays the image reference of the catalog.
|
||||
<3> Displays the image reference of the catalog.
|
||||
|
||||
@@ -47,7 +47,7 @@ a|
|
||||
[source,terminal]
|
||||
----
|
||||
$ opm render <catalog_registry_url>:<tag> \
|
||||
\| jq -s '.[] \| select( .schema == "olm.package")
|
||||
\| jq -s '.[] \| select( .schema == "olm.package")'
|
||||
----
|
||||
|
||||
|Packages that support `AllNamespaces` install mode and do not use webhooks
|
||||
|
||||
@@ -20,13 +20,19 @@ For more information about the earlier behavior, see _Multitenancy and Operator
|
||||
.Example `ClusterExtension` object
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: <operator_name>
|
||||
name: <extension_name>
|
||||
spec:
|
||||
packageName: <package_name>
|
||||
installNamespace: <namespace_name>
|
||||
channel: <channel_name>
|
||||
version: <version_number>
|
||||
namespace: <namespace_name>
|
||||
serviceAccount:
|
||||
name: <service_account_name>
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: <package_name>
|
||||
channels:
|
||||
- <channel>
|
||||
version: "<version>"
|
||||
----
|
||||
|
||||
@@ -25,7 +25,7 @@ $ oc delete clustercatalog <catalog_name>
|
||||
.Example output
|
||||
[source,text]
|
||||
----
|
||||
catalog.catalogd.operatorframework.io "my-catalog" deleted
|
||||
clustercatalog.olm.operatorframework.io "my-redhat-operators" deleted
|
||||
----
|
||||
|
||||
.Verification
|
||||
|
||||
@@ -17,28 +17,47 @@ You can install an extension from a catalog by creating a custom resource (CR) a
|
||||
|
||||
. Create a CR, similar to the following example:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: <clusterextension_name>
|
||||
spec:
|
||||
namespace: <installed_namespace> <1>
|
||||
serviceAccount:
|
||||
name: <service_account_installer_name> <2>
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: <package_name>
|
||||
channels:
|
||||
- <channel_name> <3>
|
||||
version: <version_or_version_range> <4>
|
||||
----
|
||||
<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.
|
||||
<2> Specifies the name of the service account you created to install, update, and manage your extension.
|
||||
<3> Optional: Specifies channel names as an array, such as `pipelines-1.14` or `latest`.
|
||||
<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".
|
||||
|
||||
.Example `pipelines-operator.yaml` CR
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: pipelines-operator
|
||||
spec:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
installNamespace: <namespace>
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: <service_account>
|
||||
channel: <channel>
|
||||
version: "<version>"
|
||||
name: pipelines-installer
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
version: "1.14.x"
|
||||
----
|
||||
+
|
||||
where:
|
||||
+
|
||||
`<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.
|
||||
`<service_account>`:: Specifies the name of the service account you created to install, update, and manage your extension.
|
||||
`<channel>`:: Optional: Specifies the channel, such as `pipelines-1.11` or `latest`, for the package you want to install or update.
|
||||
`<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".
|
||||
|
||||
|
||||
. Apply the CR to the cluster by running the following command:
|
||||
+
|
||||
@@ -69,76 +88,76 @@ $ oc get clusterextension pipelines-operator -o yaml
|
||||
----
|
||||
apiVersion: v1
|
||||
items:
|
||||
- apiVersion: olm.operatorframework.io/v1alpha1
|
||||
- apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
annotations:
|
||||
kubectl.kubernetes.io/last-applied-configuration: |
|
||||
{"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"}}
|
||||
creationTimestamp: "2024-06-10T17:50:51Z"
|
||||
{"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"}}}
|
||||
creationTimestamp: "2025-02-18T21:48:13Z"
|
||||
finalizers:
|
||||
- olm.operatorframework.io/cleanup-unpack-cache
|
||||
- olm.operatorframework.io/cleanup-contentmanager-cache
|
||||
generation: 1
|
||||
name: pipelines-operator
|
||||
resourceVersion: "53324"
|
||||
uid: c54237be-cde4-46d4-9b31-d0ec6acc19bf
|
||||
resourceVersion: "72725"
|
||||
uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
|
||||
spec:
|
||||
channel: latest
|
||||
installNamespace: pipelines
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
upgradeConstraintPolicy: Enforce
|
||||
source:
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: CatalogProvided
|
||||
version: 1.14.x
|
||||
sourceType: Catalog
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
|
||||
observedGeneration: 1
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Resolved
|
||||
- lastTransitionTime: "2024-06-10T17:51:11Z"
|
||||
message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
|
||||
observedGeneration: 1
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: Deprecated
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: PackageDeprecated
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: ChannelDeprecated
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: BundleDeprecated
|
||||
- lastTransitionTime: "2024-06-10T17:50:58Z"
|
||||
message: 'unpack successful:
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:f7b19ce26be742c4aaa458d37bc5ad373b5b29b20aaa7d308349687d3cbd8838
|
||||
successfully
|
||||
observedGeneration: 1
|
||||
reason: UnpackSuccess
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Unpacked
|
||||
installedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.14.4
|
||||
version: 1.14.4
|
||||
resolvedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.14.4
|
||||
version: 1.14.4
|
||||
type: Installed
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: desired state reached
|
||||
observedGeneration: 1
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Progressing
|
||||
install:
|
||||
bundle:
|
||||
name: openshift-pipelines-operator-rh.v1.14.5
|
||||
version: 1.14.5
|
||||
kind: List
|
||||
metadata:
|
||||
resourceVersion: ""
|
||||
----
|
||||
where:
|
||||
|
||||
@@ -156,6 +175,4 @@ where:
|
||||
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.
|
||||
`installedBundle.name`:: Displays the name of the bundle installed.
|
||||
`installedBundle.version`:: Displays the version of the bundle installed.
|
||||
`resolvedBundle.name`:: Displays the name of the resolved bundle.
|
||||
`resolvedBundle.version`:: Displays the version of the resolved bundle.
|
||||
====
|
||||
|
||||
@@ -11,10 +11,9 @@ You can update your cluster extension or Operator by manually editing the custom
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have a catalog installed.
|
||||
* You have downloaded a local copy of the catalog file.
|
||||
* You have an Operator or extension installed.
|
||||
* You have installed the `jq` CLI tool.
|
||||
* You have installed the `opm` CLI tool.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -24,19 +23,19 @@ You can update your cluster extension or Operator by manually editing the custom
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ jq -s '.[] | select( .schema == "olm.channel" ) | \
|
||||
select( .package == "<package_name>") | \
|
||||
.name' /<path>/<catalog_name>.json
|
||||
$ opm render <catalog_registry_url>:<tag> \
|
||||
| jq -s '.[] | select( .schema == "olm.channel" ) \
|
||||
| select( .package == "openshift-pipelines-operator-rh") | .name'
|
||||
----
|
||||
+
|
||||
.Example command
|
||||
[%collapsible]
|
||||
====
|
||||
[source,terminal]
|
||||
[source,terminal,subs=attributes+]
|
||||
----
|
||||
$ jq -s '.[] | select( .schema == "olm.channel" ) | \
|
||||
select( .package == "openshift-pipelines-operator-rh") | \
|
||||
.name' /home/username/rhoc.json
|
||||
$ opm render registry.redhat.io/redhat/redhat-operator-index:v{product-version} \
|
||||
| jq -s '.[] | select( .schema == "olm.channel" ) \
|
||||
| select( .package == "openshift-pipelines-operator-rh") | .name'
|
||||
----
|
||||
====
|
||||
+
|
||||
@@ -46,10 +45,10 @@ $ jq -s '.[] | select( .schema == "olm.channel" ) | \
|
||||
[source,text]
|
||||
----
|
||||
"latest"
|
||||
"pipelines-1.11"
|
||||
"pipelines-1.12"
|
||||
"pipelines-1.13"
|
||||
"pipelines-1.14"
|
||||
"pipelines-1.15"
|
||||
"pipelines-1.16"
|
||||
"pipelines-1.17"
|
||||
----
|
||||
====
|
||||
|
||||
@@ -57,20 +56,22 @@ $ jq -s '.[] | select( .schema == "olm.channel" ) | \
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ jq -s '.[] | select( .package == "<package_name>" ) | \
|
||||
select( .schema == "olm.channel" ) | \
|
||||
select( .name == "<channel_name>" ) | .entries | \
|
||||
.[] | .name' /<path>/<catalog_name>.json
|
||||
$ opm render <catalog_registry_url>:<tag> \
|
||||
| jq -s '.[] | select( .package == "<package_name>" ) \
|
||||
| select( .schema == "olm.channel" ) \
|
||||
| select( .name == "<channel_name>" ) | .entries \
|
||||
| .[] | .name'
|
||||
----
|
||||
+
|
||||
.Example command
|
||||
[%collapsible]
|
||||
====
|
||||
[source,terminal]
|
||||
[source,terminal,subs=attributes+]
|
||||
----
|
||||
$ jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) | \
|
||||
select( .schema == "olm.channel" ) | select( .name == "latest" ) | \
|
||||
.entries | .[] | .name' /home/username/rhoc.json
|
||||
$ opm render registry.redhat.io/redhat/redhat-operator-index:v{product-version} \
|
||||
| jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) \
|
||||
| select( .schema == "olm.channel" ) | select( .name == "latest" ) \
|
||||
| .entries | .[] | .name'
|
||||
----
|
||||
====
|
||||
+
|
||||
@@ -79,15 +80,10 @@ select( .schema == "olm.channel" ) | select( .name == "latest" ) | \
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
"openshift-pipelines-operator-rh.v1.11.1"
|
||||
"openshift-pipelines-operator-rh.v1.12.0"
|
||||
"openshift-pipelines-operator-rh.v1.12.1"
|
||||
"openshift-pipelines-operator-rh.v1.12.2"
|
||||
"openshift-pipelines-operator-rh.v1.13.0"
|
||||
"openshift-pipelines-operator-rh.v1.14.1"
|
||||
"openshift-pipelines-operator-rh.v1.14.2"
|
||||
"openshift-pipelines-operator-rh.v1.14.3"
|
||||
"openshift-pipelines-operator-rh.v1.14.4"
|
||||
"openshift-pipelines-operator-rh.v1.15.0"
|
||||
"openshift-pipelines-operator-rh.v1.16.0"
|
||||
"openshift-pipelines-operator-rh.v1.17.0"
|
||||
"openshift-pipelines-operator-rh.v1.17.1"
|
||||
----
|
||||
====
|
||||
|
||||
@@ -109,134 +105,167 @@ $ oc get clusterextension pipelines-operator -o yaml
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
kind: ClusterExtension
|
||||
apiVersion: v1
|
||||
items:
|
||||
- apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
annotations:
|
||||
kubectl.kubernetes.io/last-applied-configuration: |
|
||||
{"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"}}}
|
||||
creationTimestamp: "2025-02-18T21:48:13Z"
|
||||
finalizers:
|
||||
- olm.operatorframework.io/cleanup-unpack-cache
|
||||
- olm.operatorframework.io/cleanup-contentmanager-cache
|
||||
generation: 1
|
||||
name: pipelines-operator
|
||||
resourceVersion: "72725"
|
||||
uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
|
||||
spec:
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: CatalogProvided
|
||||
version: 1.14.x
|
||||
sourceType: Catalog
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: Deprecated
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: PackageDeprecated
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: ChannelDeprecated
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: BundleDeprecated
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:f7b19ce26be742c4aaa458d37bc5ad373b5b29b20aaa7d308349687d3cbd8838
|
||||
successfully
|
||||
observedGeneration: 1
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: desired state reached
|
||||
observedGeneration: 1
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Progressing
|
||||
install:
|
||||
bundle:
|
||||
name: openshift-pipelines-operator-rh.v1.14.5
|
||||
version: 1.14.5
|
||||
kind: List
|
||||
metadata:
|
||||
annotations:
|
||||
kubectl.kubernetes.io/last-applied-configuration: |
|
||||
{"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"openshift-operators","packageName":"openshift-pipelines-operator-rh","pollInterval":"30m","version":"\u003c1.12"}}
|
||||
creationTimestamp: "2024-06-11T15:55:37Z"
|
||||
generation: 1
|
||||
name: pipelines-operator
|
||||
resourceVersion: "69776"
|
||||
uid: 6a11dff3-bfa3-42b8-9e5f-d8babbd6486f
|
||||
spec:
|
||||
channel: latest
|
||||
installNamespace: openshift-operators
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: Enforce
|
||||
version: <1.12
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2024-06-11T15:56:09Z"
|
||||
message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
|
||||
observedGeneration: 1
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2024-06-11T15:55:50Z"
|
||||
message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
|
||||
observedGeneration: 1
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Resolved
|
||||
- lastTransitionTime: "2024-06-11T15:55:50Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: Deprecated
|
||||
- lastTransitionTime: "2024-06-11T15:55:50Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: PackageDeprecated
|
||||
- lastTransitionTime: "2024-06-11T15:55:50Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: ChannelDeprecated
|
||||
- lastTransitionTime: "2024-06-11T15:55:50Z"
|
||||
message: ""
|
||||
observedGeneration: 1
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: BundleDeprecated
|
||||
installedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.11.1
|
||||
version: 1.11.1
|
||||
resolvedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.11.1
|
||||
version: 1.11.1
|
||||
resourceVersion: ""
|
||||
----
|
||||
====
|
||||
|
||||
. Edit your CR by using one of the following methods:
|
||||
|
||||
** If you want to pin your Operator or extension to specific version, such as `1.12.1`, edit your CR similar to the following example:
|
||||
** If you want to pin your Operator or extension to specific version, such as `1.15.0`, edit your CR similar to the following example:
|
||||
+
|
||||
.Example `pipelines-operator.yaml` CR
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: pipelines-operator
|
||||
spec:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
installNamespace: <namespace>
|
||||
version: "1.12.1" <1>
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
version: "1.15.0" <1>
|
||||
----
|
||||
<1> Update the version from `1.11.1` to `1.12.1`
|
||||
<1> Update the version from `1.14.x` to `1.15.0`
|
||||
|
||||
** If you want to define a range of acceptable update versions, edit your CR similar to the following example:
|
||||
+
|
||||
.Example CR with a version range specified
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: pipelines-operator
|
||||
spec:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
installNamespace: <namespace>
|
||||
version: ">1.11.1, <1.13" <1>
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
version: ">1.15, <1.17" <1>
|
||||
----
|
||||
<1> Specifies that the desired version range is greater than version `1.11.1` and less than `1.13`. For more information, see "Support for version ranges" and "Version comparison strings".
|
||||
<1> Specifies that the desired version range is greater than version `1.15` and less than `1.17`. For more information, see "Support for version ranges" and "Version comparison strings".
|
||||
|
||||
** If you want to update to the latest version that can be resolved from a channel, edit your CR similar to the following example:
|
||||
+
|
||||
.Example CR with a specified channel
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: pipelines-operator
|
||||
spec:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
installNamespace: <namespace>
|
||||
channel: pipelines-1.13 <1>
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
channels:
|
||||
- latest <1>
|
||||
----
|
||||
<1> Installs the latest release that can be resolved from the specified channel. Updates to the channel are automatically installed.
|
||||
<1> Installs the latest release that can be resolved from the specified channel. Updates to the channel are automatically installed. Enter values as an array.
|
||||
|
||||
** If you want to specify a channel and version or version range, edit your CR similar to the following example:
|
||||
+
|
||||
.Example CR with a specified channel and version range
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
name: pipelines-operator
|
||||
spec:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
installNamespace: <namespace>
|
||||
channel: latest
|
||||
version: "<1.13"
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
sourceType: Catalog
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
channels:
|
||||
- latest
|
||||
version: "<1.16"
|
||||
----
|
||||
+
|
||||
For more information, see "Example custom resources (CRs) that specify a target version".
|
||||
@@ -253,24 +282,6 @@ $ oc apply -f pipelines-operator.yaml
|
||||
----
|
||||
clusterextension.olm.operatorframework.io/pipelines-operator configured
|
||||
----
|
||||
+
|
||||
[TIP]
|
||||
====
|
||||
You can patch and apply the changes to your CR from the CLI by running the following command:
|
||||
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc patch clusterextension/pipelines-operator -p \
|
||||
'{"spec":{"version":"<1.13"}}' \
|
||||
--type=merge
|
||||
----
|
||||
|
||||
.Example output
|
||||
[source,text]
|
||||
----
|
||||
clusterextension.olm.operatorframework.io/pipelines-operator patched
|
||||
----
|
||||
====
|
||||
|
||||
.Verification
|
||||
|
||||
@@ -286,67 +297,73 @@ $ oc get clusterextension pipelines-operator -o yaml
|
||||
====
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
annotations:
|
||||
kubectl.kubernetes.io/last-applied-configuration: |
|
||||
{"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"openshift-operators","packageName":"openshift-pipelines-operator-rh","pollInterval":"30m","version":"\u003c1.13"}}
|
||||
creationTimestamp: "2024-06-11T18:23:26Z"
|
||||
{"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":"\u003c1.16"},"sourceType":"Catalog"}}}
|
||||
creationTimestamp: "2025-02-18T21:48:13Z"
|
||||
finalizers:
|
||||
- olm.operatorframework.io/cleanup-unpack-cache
|
||||
- olm.operatorframework.io/cleanup-contentmanager-cache
|
||||
generation: 2
|
||||
name: pipelines-operator
|
||||
resourceVersion: "66310"
|
||||
uid: ce0416ba-13ea-4069-a6c8-e5efcbc47537
|
||||
name: pipes
|
||||
resourceVersion: "90693"
|
||||
uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
|
||||
spec:
|
||||
channel: latest
|
||||
installNamespace: openshift-operators
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: Enforce
|
||||
version: <1.13
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: CatalogProvided
|
||||
version: <1.16
|
||||
sourceType: Catalog
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2024-06-11T18:23:33Z"
|
||||
message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:814742c8a7cc7e2662598e114c35c13993a7b423cfe92548124e43ea5d469f82"
|
||||
observedGeneration: 2
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Resolved
|
||||
- lastTransitionTime: "2024-06-11T18:23:52Z"
|
||||
message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:814742c8a7cc7e2662598e114c35c13993a7b423cfe92548124e43ea5d469f82"
|
||||
observedGeneration: 2
|
||||
reason: Success
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2024-06-11T18:23:33Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: Deprecated
|
||||
- lastTransitionTime: "2024-06-11T18:23:33Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: PackageDeprecated
|
||||
- lastTransitionTime: "2024-06-11T18:23:33Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: ChannelDeprecated
|
||||
- lastTransitionTime: "2024-06-11T18:23:33Z"
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: BundleDeprecated
|
||||
installedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.12.2
|
||||
version: 1.12.2
|
||||
resolvedBundle:
|
||||
name: openshift-pipelines-operator-rh.v1.12.2
|
||||
version: 1.12.2
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:8a593c1144709c9aeffbeb68d0b4b08368f528e7bb6f595884b2474bcfbcafcd
|
||||
successfully
|
||||
observedGeneration: 2
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: desired state reached
|
||||
observedGeneration: 2
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Progressing
|
||||
install:
|
||||
bundle:
|
||||
name: openshift-pipelines-operator-rh.v1.15.2
|
||||
version: 1.15.2
|
||||
----
|
||||
====
|
||||
|
||||
@@ -364,61 +381,73 @@ $ oc get clusterextension <operator_name> -o yaml
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
apiVersion: olm.operatorframework.io/v1alpha1
|
||||
apiVersion: olm.operatorframework.io/v1
|
||||
kind: ClusterExtension
|
||||
metadata:
|
||||
annotations:
|
||||
kubectl.kubernetes.io/last-applied-configuration: |
|
||||
{"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"openshift-operators","packageName":"openshift-pipelines-operator-rh","pollInterval":"30m","version":"3.0"}}
|
||||
creationTimestamp: "2024-06-11T18:23:26Z"
|
||||
{"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":"9.x"},"sourceType":"Catalog"}}}
|
||||
creationTimestamp: "2025-02-18T21:48:13Z"
|
||||
finalizers:
|
||||
- olm.operatorframework.io/cleanup-unpack-cache
|
||||
- olm.operatorframework.io/cleanup-contentmanager-cache
|
||||
generation: 3
|
||||
name: pipelines-operator
|
||||
resourceVersion: "71852"
|
||||
uid: ce0416ba-13ea-4069-a6c8-e5efcbc47537
|
||||
name: pipes
|
||||
resourceVersion: "93334"
|
||||
uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
|
||||
spec:
|
||||
channel: latest
|
||||
installNamespace: openshift-operators
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: Enforce
|
||||
version: "3.0"
|
||||
namespace: pipelines
|
||||
serviceAccount:
|
||||
name: pipelines-installer
|
||||
source:
|
||||
catalog:
|
||||
packageName: openshift-pipelines-operator-rh
|
||||
upgradeConstraintPolicy: CatalogProvided
|
||||
version: 9.x
|
||||
sourceType: Catalog
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: 'error upgrading from currently installed version "1.12.2": no package
|
||||
"openshift-pipelines-operator-rh" matching version "3.0" found in channel "latest"'
|
||||
observedGeneration: 3
|
||||
reason: ResolutionFailed
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: "False"
|
||||
type: Resolved
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: installation has not been attempted as resolution failed
|
||||
observedGeneration: 3
|
||||
reason: InstallationStatusUnknown
|
||||
status: Unknown
|
||||
type: Installed
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: deprecation checks have not been attempted as resolution failed
|
||||
observedGeneration: 3
|
||||
reason: Deprecated
|
||||
status: Unknown
|
||||
type: Deprecated
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: deprecation checks have not been attempted as resolution failed
|
||||
observedGeneration: 3
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: Unknown
|
||||
status: "False"
|
||||
type: PackageDeprecated
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: deprecation checks have not been attempted as resolution failed
|
||||
observedGeneration: 3
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: Unknown
|
||||
status: "False"
|
||||
type: ChannelDeprecated
|
||||
- lastTransitionTime: "2024-06-11T18:29:02Z"
|
||||
message: deprecation checks have not been attempted as resolution failed
|
||||
observedGeneration: 3
|
||||
- lastTransitionTime: "2025-02-18T21:48:13Z"
|
||||
message: ""
|
||||
observedGeneration: 2
|
||||
reason: Deprecated
|
||||
status: Unknown
|
||||
status: "False"
|
||||
type: BundleDeprecated
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:8a593c1144709c9aeffbeb68d0b4b08368f528e7bb6f595884b2474bcfbcafcd
|
||||
successfully
|
||||
observedGeneration: 3
|
||||
reason: Succeeded
|
||||
status: "True"
|
||||
type: Installed
|
||||
- lastTransitionTime: "2025-02-18T21:48:16Z"
|
||||
message: 'error upgrading from currently installed version "1.15.2": no bundles
|
||||
found for package "openshift-pipelines-operator-rh" matching version "9.x"'
|
||||
observedGeneration: 3
|
||||
reason: Retrying
|
||||
status: "True"
|
||||
type: Progressing
|
||||
install:
|
||||
bundle:
|
||||
name: openshift-pipelines-operator-rh.v1.15.2
|
||||
version: 1.15.2
|
||||
----
|
||||
====
|
||||
|
||||
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
{olm-first} has been included with {product-title} 4 since its initial release. {product-title} 4.17 includes components for a next-generation iteration of {olm} as a Technology Preview feature, known during this phase as _{olmv1}_. This updated framework evolves many of the concepts that have been part of previous versions of {olm} and adds new capabilities.
|
||||
{olm-first} has been included with {product-title} 4 since its initial release. {product-title} 4.18 includes components for a next-generation iteration of {olm} as a Generally Available (GA) feature, known during this phase as _{olmv1}_. This updated framework evolves many of the concepts that have been part of previous versions of {olm} and adds new capabilities.
|
||||
|
||||
Starting in {product-title} 4.17, documentation for {olmv1} has been moved to the following new guide:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user