Chapter 10. Cluster extensions

Procedure

1. To return a list of extensions that support the AllNamespaces install mode and do not use webhooks, enter the following command:

   $ opm render <catalog_registry_url>:<tag> \
     | jq -cs '[.[] | select(.schema == "olm.bundle" \
     and (.properties[] | select(.type == "olm.csv.metadata").value.installModes[] \
     | select(.type == "AllNamespaces" and .supported == true)) \
     and .spec.webhookdefinitions == null) | .package] | unique[]'

   where:

   catalog_registry_url

   Specifies the URL of the catalog registry, such as registry.redhat.io/redhat/redhat-operator-index.

   tag

   Specifies the tag or version of the catalog, such as v4.18 or latest.

   Example 10.1. Example command

   $ opm render \
     registry.redhat.io/redhat/redhat-operator-index:v4.18 \
     | jq -cs '[.[] | select(.schema == "olm.bundle" \
     and (.properties[] | select(.type == "olm.csv.metadata").value.installModes[] \
     | select(.type == "AllNamespaces" and .supported == true)) \
     and .spec.webhookdefinitions == null) | .package] | unique[]'

   Example 10.2. Example output

   "3scale-operator"
   "amq-broker-rhel8"
   "amq-online"
   "amq-streams"
   "amq-streams-console"
   "ansible-automation-platform-operator"
   "ansible-cloud-addons-operator"
   "apicast-operator"
   "authorino-operator"
   "aws-load-balancer-operator"
   "bamoe-kogito-operator"
   "cephcsi-operator"
   "cincinnati-operator"
   "cluster-logging"
   "cluster-observability-operator"
   "compliance-operator"
   "container-security-operator"
   "cryostat-operator"
   "datagrid"
   "devspaces"
   ...

2. Inspect the contents of an extension’s metadata by running the following command:

   $ opm render <catalog_registry_url>:<tag> \
     | jq -s '.[] | select( .schema == "olm.package") \
     | select( .name == "<package_name>")'

   Example 10.3. Example command

   $ opm render \
     registry.redhat.io/redhat/redhat-operator-index:v4.18 \
     | jq -s '.[] | select( .schema == "olm.package") \
     | select( .name == "openshift-pipelines-operator-rh")'

   Example 10.4. Example output

   {
     "schema": "olm.package",
     "name": "openshift-pipelines-operator-rh",
     "defaultChannel": "latest",
     "icon": {
       "base64data": "iVBORw0KGgoAAAANSUhE...",
       "mediatype": "image/png"
     }
   }

Procedure

1. Create a CR, similar to the following example:

   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
           upgradeConstraintPolicy: CatalogProvided 5

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

   5

   Optional: Specifies the upgrade constraint policy. If unspecified, the default setting is CatalogProvided. The CatalogProvided setting only updates if the new version satisfies the upgrade constraints set by the package author. To force an update or rollback, set the field to SelfCertified. For more information, see "Forcing an update or rollback".

1. Apply the CR to the cluster by running the following command:

   $ oc apply -f pipeline-operator.yaml

   Example output

   clusterextension.olm.operatorframework.io/pipelines-operator created

Verification

1. View the Operator or extension’s CR in the YAML format by running the following command:

   $ oc get clusterextension pipelines-operator -o yaml

   Example 10.11. Example output

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

Procedure

1. Inspect a package for channel and version information from a local copy of your catalog file by completing the following steps:

   1. Get a list of channels from a selected package by running the following command:

      $ opm render <catalog_registry_url>:<tag> \
        | jq -s '.[] | select( .schema == "olm.channel" ) \
        | select( .package == "openshift-pipelines-operator-rh") | .name'

      Example 10.12. Example command

      $ opm render registry.redhat.io/redhat/redhat-operator-index:v4.18 \
        | jq -s '.[] | select( .schema == "olm.channel" ) \
        | select( .package == "openshift-pipelines-operator-rh") | .name'

      Example 10.13. Example output

      "latest"
      "pipelines-1.14"
      "pipelines-1.15"
      "pipelines-1.16"
      "pipelines-1.17"

   2. Get a list of the versions published in a channel by running the following command:

      $ opm render <catalog_registry_url>:<tag> \
        | jq -s '.[] | select( .package == "<package_name>" ) \
        | select( .schema == "olm.channel" ) \
        | select( .name == "<channel_name>" ) | .entries \
        | .[] | .name'

      Example 10.14. Example command

      $ opm render registry.redhat.io/redhat/redhat-operator-index:v4.18 \
        | jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) \
        | select( .schema == "olm.channel" ) | select( .name == "latest" ) \
        | .entries | .[] | .name'

      Example 10.15. Example output

      "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"

2. Find out what version or channel is specified in your Operator or extension’s CR by running the following command:

   $ oc get clusterextension <operator_name> -o yaml

   Example command

   $ oc get clusterextension pipelines-operator -o yaml

   Example 10.16. Example output

   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:
     resourceVersion: ""

3. 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.15.0, edit your CR similar to the following example:

     Example pipelines-operator.yaml CR

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       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.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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       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.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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       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. 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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       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".

4. Apply the update to the cluster by running the following command:

   $ oc apply -f pipelines-operator.yaml

   Example output

   clusterextension.olm.operatorframework.io/pipelines-operator configured

Procedure

1. If the installed cluster extension does not provide default cluster roles, manually create one or more roles:

   1. Consider the use cases for the set of roles described in "Common default cluster roles for users".

      For example, create one or more of the following ClusterRole object definitions, replacing <cluster_extension_api_group> and <cluster_extension_custom_resource> with the actual API group and resource names provided by the installed cluster extension:

      Example view-custom-resource.yaml file

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: view-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - get
        - list
        - watch

      Example edit-custom-resource.yaml file

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: edit-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - get
        - list
        - watch
        - create
        - update
        - patch
        - delete

      Example admin-custom-resource.yaml file

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: admin-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - '*' 1

      1

      Setting a wildcard (*) in verbs allows all actions on the specified resources.

   2. Create the cluster roles by running the following command for any YAML files you created:

      $ oc create -f <filename>.yaml

2. Associate a cluster role to specific users or groups to grant them the necessary permissions for the resource by binding the cluster roles to individual user or group names:

   1. Create an object definition for either a cluster role binding to grant access across all namespaces or a role binding to grant access within a specific namespace:

      • The following example cluster role bindings grant read-only view access to the custom resource across all namespaces:

        Example ClusterRoleBinding object for a user

        apiVersion: rbac.authorization.k8s.io/v1
        kind: ClusterRoleBinding
        metadata:
          name: view-custom-resource-binding
        subjects:
        - kind: User
          name: <user_name>
        roleRef:
          kind: ClusterRole
          name: view-custom-resource
          apiGroup: rbac.authorization.k8s.io

        Example ClusterRoleBinding object for a user

        apiVersion: rbac.authorization.k8s.io/v1
        kind: ClusterRoleBinding
        metadata:
          name: view-custom-resource-binding
        subjects:
        - kind: Group
          name: <group_name>
        roleRef:
          kind: ClusterRole
          name: view-custom-resource
          apiGroup: rbac.authorization.k8s.io

      • The following role binding restricts edit permissions to a specific namespace:

        Example RoleBinding object for a user

        apiVersion: rbac.authorization.k8s.io/v1
        kind: RoleBinding
        metadata:
          name: edit-custom-resource-edit-binding
          namespace: <namespace>
        subjects:
        - kind: User
          name: <username>
        roleRef:
          kind: Role
          name: custom-resource-edit
          apiGroup: rbac.authorization.k8s.io

   2. Save your object definition to a YAML file.

   3. Create the object by running the following command:

      $ oc create -f <filename>.yaml

Procedure

1. Create an object definition for a cluster role that specifies the API groups and resources provided by the cluster extension and add an aggregation label to extend one or more existing default cluster roles:

   Example ClusterRole object with an aggregation label

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: view-custom-resource-aggregated
     labels:
       rbac.authorization.k8s.io/aggregate-to-view: "true"
   rules:
     - apiGroups:
         - <cluster_extension_api_group>
       resources:
         - <cluster_extension_custom_resource>
       verbs:
         - get
         - list
         - watch

   You can create similar ClusterRole objects for edit and admin with appropriate verbs, such as create, update, and delete. By using aggregation labels, the permissions for the custom resources are added to the default roles.

2. Save your object definition to a YAML file.

3. Create the object by running the following command:

   $ oc create -f <filename>.yaml

Procedure

1. Edit the custom resource (CR) of your Operator or extension as shown in the following example:

   Example CR

   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
           upgradeConstraintPolicy: SelfCertified 5

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

   5

   Optional: Specifies the upgrade constraint policy. To force an update or rollback, set the field to SelfCertified. If unspecified, the default setting is CatalogProvided. The CatalogProvided setting only updates if the new version satisfies the upgrade constraints set by the package author.

2. Apply the changes to your Operator or extensions CR by running the following command:

   $ oc apply -f <extension_name>.yaml

Procedure

1. Edit the ClusterExtension object of the CRD:

   $ oc edit clusterextension <clusterextension_name>

2. Set the preflight.crdUpgradeSafety.disabled field to true:

   Example 10.19. Example ClusterExtension object

   apiVersion: olm.operatorframework.io/v1alpha1
   kind: ClusterExtension
   metadata:
       name: clusterextension-sample
   spec:
       installNamespace: default
       packageName: argocd-operator
       version: 0.6.0
       preflight:
           crdUpgradeSafety:
               disabled: true 1

   1

   Set to true.