OSDOCS-10502: Cluster extension status improvments

Author: michaelryanpeter

modules/olmv1-adding-a-catalog.adoc

@@ -89,12 +89,12 @@ Annotations:  <none>
 API Version:  catalogd.operatorframework.io/v1alpha1
 Kind:         Catalog
 Metadata:
-  Creation Timestamp:  2024-01-10T16:18:38Z
+  Creation Timestamp:  2024-06-10T17:34:53Z
   Finalizers:
     catalogd.operatorframework.io/delete-server-cache
   Generation:        1
-  Resource Version:  57057
-  UID:               128db204-49b3-45ee-bfea-a2e6fc8e34ea
+  Resource Version:  46075
+  UID:               83c0db3c-a553-41da-b279-9b3cddaa117d
 Spec:
   Source:
     Image:
@@ -103,7 +103,7 @@ Spec:
     Type:           image
 Status: <1>
   Conditions:
-    Last Transition Time:  2024-01-10T16:18:55Z
+    Last Transition Time:  2024-06-10T17:35:15Z
     Message:
     Reason:                UnpackSuccessful <2>
     Status:                True
@@ -113,9 +113,9 @@ Status: <1>
   Phase:                   Unpacked <3>
   Resolved Source:
     Image:
-      Last Poll Attempt:  2024-01-10T16:18:51Z
+      Last Poll Attempt:  2024-06-10T17:35:10Z
       Ref:                registry.redhat.io/redhat/redhat-operator-index:v4.16
-      Resolved Ref:       registry.redhat.io/redhat/redhat-operator-index@sha256:7b536ae19b8e9f74bb521c4a61e5818e036ac1865a932f2157c6c9a766b2eea5 <4>
+      Resolved Ref:       registry.redhat.io/redhat/redhat-operator-index@sha256:f2ccc079b5e490a50db532d1dc38fd659322594dcf3e653d650ead0e862029d9 <4>
     Type:                 image
 Events:                   <none>
 ----

modules/olmv1-installing-an-operator.adoc

@@ -5,18 +5,18 @@
 :_mod-docs-content-type: PROCEDURE
 
 [id="olmv1-installing-an-operator_{context}"]
-= Installing an Operator from a catalog
+= Installing a cluster extension from a catalog
 
-{olmv1-first} supports installing Operators and extensions scoped to the cluster. You can install an Operator or extension from a catalog by creating a custom resource (CR) and applying it to the cluster.
+{olmv1-first} supports installing cluster extensions, including {olmv0} Operators via the `registry+v1` bundle format, that are scoped to the cluster. You can install an extension from a catalog by creating a custom resource (CR) and applying it to the cluster.
 
 [IMPORTANT]
 ====
-Currently, {olmv1} supports the installation Operators and extensions that meet the following criteria:
+Currently, {olmv1} supports the installation of extensions that meet the following criteria:
 
-* The Operator or extension must use the `AllNamespaces` install mode.
-* The Operator or extension must not use webhooks.
+* The extension must use the `AllNamespaces` install mode.
+* The extension must not use webhooks.
 
-Operators and extensions that use webhooks or that target a single or specified set of namespaces cannot be installed.
+Cluster extensions that use webhooks or that target a single or specified set of namespaces cannot be installed.
 ====
 
 .Prerequisite
@@ -58,6 +58,7 @@ $ jq -s '.[] | select( .schema == "olm.channel" ) | \
 "pipelines-1.11"
 "pipelines-1.12"
 "pipelines-1.13"
+"pipelines-1.14"
 ----
 ====
 
@@ -87,14 +88,29 @@ 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.13.1"
+"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"
+
 ----
 ====
+. If you want to install your extension into a new namespace, run the following command:
++
+[source,terminal]
+----
+$ oc adm new-project <new_namespace>
+----
 
 . Create a CR, similar to the following example:
 +
@@ -107,14 +123,16 @@ metadata:
   name: pipelines-operator
 spec:
   packageName: openshift-pipelines-operator-rh
+  installNamespace: <namespace>
   channel: <channel>
   version: "<version>"
 ----
 +
 where:
 +
-<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".
+`<namespace>`:: Specifies the namespace where you want the bundle installed, such as `openshift-operators` or `my-extension`. Extensions are still cluster-scoped and might contain resources that are installed in different namespaces.
+`<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".
 +
 --
 include::snippets/olmv1-multi-catalog-admon.adoc[]
@@ -142,48 +160,95 @@ clusterextension.olm.operatorframework.io/pipelines-operator created
 $ oc get clusterextension pipelines-operator -o yaml
 ----
 +
---
-include::snippets/olmv1-version-range-cr-adomn.adoc[]
---
-+
 .Example output
 [%collapsible]
 ====
 [source,text]
 ----
-apiVersion: olm.operatorframework.io/v1alpha1
-kind: ClusterExtension
+apiVersion: v1
+items:
+- apiVersion: olm.operatorframework.io/v1alpha1
+  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"}}
+    creationTimestamp: "2024-06-10T17:50:51Z"
+    generation: 1
+    name: pipelines-operator
+    resourceVersion: "53324"
+    uid: c54237be-cde4-46d4-9b31-d0ec6acc19bf
+  spec:
+    channel: latest
+    installNamespace: openshift-operators
+    packageName: openshift-pipelines-operator-rh
+    upgradeConstraintPolicy: Enforce
+  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"
+      message: ""
+      observedGeneration: 1
+      reason: Deprecated
+      status: "False"
+      type: Deprecated
+    - lastTransitionTime: "2024-06-10T17:50:58Z"
+      message: ""
+      observedGeneration: 1
+      reason: Deprecated
+      status: "False"
+      type: PackageDeprecated
+    - lastTransitionTime: "2024-06-10T17:50:58Z"
+      message: ""
+      observedGeneration: 1
+      reason: Deprecated
+      status: "False"
+      type: ChannelDeprecated
+    - lastTransitionTime: "2024-06-10T17:50:58Z"
+      message: ""
+      observedGeneration: 1
+      reason: Deprecated
+      status: "False"
+      type: BundleDeprecated
+    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
+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","packageName":"openshift-pipelines-operator-rh","version":"1.11.x"}}
-  creationTimestamp: "2024-01-30T20:06:09Z"
-  generation: 1
-  name: pipelines-operator
-  resourceVersion: "44362"
-  uid: 4272d228-22e1-419e-b9a7-986f982ee588
-spec:
-  channel: latest
-  packageName: openshift-pipelines-operator-rh
-  upgradeConstraintPolicy: Enforce
-  version: 1.11.x
-status:
-  conditions:
-  - lastTransitionTime: "2024-01-30T20:06:15Z"
-    message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
-    observedGeneration: 1
-    reason: Success
-    status: "True"
-    type: Resolved
-  - lastTransitionTime: "2024-01-30T20:06:31Z"
-    message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
-    observedGeneration: 1
-    reason: Success
-    status: "True"
-    type: Installed
-  installedBundleResource: registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280
-  resolvedBundleResource: registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280
+  resourceVersion: ""
 ----
+where:
+
+`spec.channel`:: Displays the channel defined in the CR of the extension.
+`spec.version`:: Displays the version or version range defined in the CR of the extension.
+`status.conditions`:: Displays information about the status and health of the extension.
+`type: Deprecated`:: Displays whether one or more of following are deprecated:
++
+--
+`type: PackageDeprecated`:: Displays whether the resolved package is deprecated.
+`type: ChannelDeprecated`:: Displays whether the resolved channel is deprecated.
+`type: BundleDeprecated`:: Displays whether the resolved bundle is deprecated.
+--
++
+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 verson of the resolved bundle.
 ====
 
 . Get information about your bundle deployment by running the following command:
@@ -198,51 +263,52 @@ $ oc get bundleDeployment pipelines-operator -o yaml
 ====
 [source,text]
 ----
-apiVersion: core.rukpak.io/v1alpha1
+apiVersion: core.rukpak.io/v1alpha2
 kind: BundleDeployment
 metadata:
-  creationTimestamp: "2024-01-30T20:06:15Z"
-  generation: 2
+  creationTimestamp: "2024-06-10T17:50:58Z"
+  finalizers:
+  - core.rukpak.io/delete-cached-bundle
+  generation: 1
   name: pipelines-operator
   ownerReferences:
   - apiVersion: olm.operatorframework.io/v1alpha1
     blockOwnerDeletion: true
     controller: true
     kind: ClusterExtension
     name: pipelines-operator
-    uid: 4272d228-22e1-419e-b9a7-986f982ee588
-  resourceVersion: "44464"
-  uid: 0a0c3525-27e2-4c93-bf57-55920a7707c0
+    uid: c54237be-cde4-46d4-9b31-d0ec6acc19bf
+  resourceVersion: "53414"
+  uid: 74367cfc-578e-4da0-815f-fe40f3ca5d1c
 spec:
-  provisionerClassName: core-rukpak-io-plain
-  template:
-    metadata: {}
-    spec:
-      provisionerClassName: core-rukpak-io-registry
-      source:
-        image:
-          ref: registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280
-        type: image
+  installNamespace: openshift-operators
+  provisionerClassName: core-rukpak-io-registry
+  source:
+    image:
+      ref: registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec
+    type: image
 status:
-  activeBundle: pipelines-operator-29x720cjzx8yiowf13a3j75fil2zs3mfw
   conditions:
-  - lastTransitionTime: "2024-01-30T20:06:15Z"
-    message: Successfully unpacked the pipelines-operator-29x720cjzx8yiowf13a3j75fil2zs3mfw
-      Bundle
+  - lastTransitionTime: "2024-06-10T17:51:09Z"
+    message: Successfully unpacked the image Bundle
     reason: UnpackSuccessful
     status: "True"
-    type: HasValidBundle
-  - lastTransitionTime: "2024-01-30T20:06:28Z"
-    message: Instantiated bundle pipelines-operator-29x720cjzx8yiowf13a3j75fil2zs3mfw
-      successfully
+    type: Unpacked
+  - lastTransitionTime: "2024-06-10T17:51:10Z"
+    message: Instantiated bundle pipelines-operator successfully
     reason: InstallationSucceeded
     status: "True"
     type: Installed
-  - lastTransitionTime: "2024-01-30T20:06:40Z"
+  - lastTransitionTime: "2024-06-10T17:51:19Z"
     message: BundleDeployment is healthy
     reason: Healthy
     status: "True"
     type: Healthy
-  observedGeneration: 2
+  contentURL: https://core.openshift-rukpak.svc/bundles/pipelines-operator.tgz
+  observedGeneration: 1
+  resolvedSource:
+    image:
+      ref: registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec
+    type: image
 ----
 ====