[OpenShift Container Platform][IBM Cloud Pak for Integration]

Adding the IBM MQ Operator catalog source

Adding catalog source to your OpenShift® cluster adds the IBM® operators to the list of operators you can install.

Before you begin

This task assumes that you have completed the first 3 steps of Installing the IBM MQ Operator.

This task must be performed by a cluster administrator.

About this task

The IBM MQ Operator catalog is an index of operators available to extend the API of a Red Hat OpenShift Container Platform cluster to enable IBM software products.

Complete either Option A: Air-gap or Option B: Internet, depending on whether your cluster is in a restricted (air-gapped) network environment, or your cluster has access to the Internet.

Procedure

  • [MQ 9.3.4 Dec 2023]Option A: Air-gap Add the catalog source in an air-gapped network environment.
    1. Add the IBM MQ Operator catalog source.

      Follow the instructions in Adding catalog sources to a cluster.

      Note: Because you have already completed the operator install step Mirror images (air-gap only), you only have to complete the step that applies the catalog source. For example:
      oc apply -f ~/.ibm-pak/data/mirror/${OPERATOR_PACKAGE_NAME}/${OPERATOR_VERSION}/catalog-sources.yaml
    2. Add the catalog source for additional required components.
    There are some additional required components when you deploy at least one queue manager where all of the following statements are true:
    • You are using IBM MQ 9.3.4 or later.
    • You are using an IBM Cloud Pak® for Integration license.
    • The IBM MQ Console is enabled.
    • You are using the IBM Cloud Pak for Integration Keycloak service for IBM MQ Console single sign-on (SSO) authentication and authorization (the default).
    If all the previous statements are true, then SSO is provided by Keycloak. Therefore, as well as for the IBM MQ Operator catalog source, you must also follow the steps in Adding catalog sources to a cluster for each of these additional required components:
    • IBM Cloud Pak foundational services
    • Certificate Manager. If you have installed a version of IBM Cloud Pak foundational services operator prior to version 4.4, you must mirror Certificate Manager.1
    • IBM Cloud Pak for Integration
  • Option B: Internet Add the catalog source in an environment that has access to the Internet.
    Create a CatalogSource using the OpenShift CLI.

    Add the catalog by applying the following YAML file to the Red Hat OpenShift Container Platform cluster.

    1. Create the CatalogSource YAML.
      Save the following resource definition as a file called catalog_source.yaml.
      apiVersion: operators.coreos.com/v1alpha1
      kind: CatalogSource
      metadata:
        name: ibm-operator-catalog
        namespace: openshift-marketplace
      spec:
        displayName: IBM Operator Catalog
        image: icr.io/cpopen/ibm-operator-catalog:latest
        publisher: IBM
        sourceType: grpc
        updateStrategy:
          registryPoll:
            interval: 45m
    2. Apply the CatalogSource YAML.
      Do this from the Red Hat OpenShift Container Platform web console by clicking the "+" button, or by using the command line.
      For example, apply the file by running the following command:
      oc apply -f catalog_source.yaml -n openshift-marketplace
    3. Verify successful CatalogSource creation
      Run the following command:
      oc get CatalogSources ibm-operator-catalog -n openshift-marketplace
      You receive this output on success:
      NAME                   DISPLAY                TYPE   PUBLISHER    AGE
      ibm-operator-catalog   IBM operator Catalog   grpc   IBM          28s

Results

You are now ready to complete Step 5 of Installing the IBM MQ Operator.
1 From version 4.4 of IBM Cloud Pak foundational services this mirroring is no longer required.