Adding catalog sources to a cluster

If you are applying catalog sources fix packs prior to an upgrade, complete the following steps:

• Confirm that your operators are running properly.

• If there are any pending operator updates that require manual approval, approve those before starting this procedure. For more information, see "Restricting automatic updates with an approval strategy" in Installing the operators by using the Red Hat OpenShift console.

If you have not already installed it, or if it needs updating, download the IBM Catalog Management plug-in (version 1.6.0 or later) from GitHub. This plug-in allows you to run oc ibm-pak commands against the cluster.

Complete the following steps for each of the Cloud Pak operators that you want to install.

1. Log into your cluster by using the oc login command and your user credentials:

   oc login <openshift_url> -u <username> -p <password> -n <namespace>

2. Export the following environment variables for the operator:

   export OPERATOR_PACKAGE_NAME=<operator_package_name>
   export OPERATOR_VERSION=<operator_version>
   export ARCH=<architecture>

   See the following section, Export commands for all operators, for values to use for the <operator_package_name>, <operator_version>, and <architecture> placeholders, and a table with a list of export commands that you can copy. For example:

   export OPERATOR_PACKAGE_NAME=ibm-integration-platform-navigator
   export OPERATOR_VERSION=7.2.4
   export ARCH=amd64

3. Download the files for the operator. If you are completing an air-gapped installation, you should already have the files that you need after following the instructions in Mirroring images for an air-gapped cluster, in which case you can skip to step 6 to apply the catalog source files to the cluster.

   oc ibm-pak get ${OPERATOR_PACKAGE_NAME} --version ${OPERATOR_VERSION}

4. Generate the catalog sources required for this operator:

   oc ibm-pak generate mirror-manifests ${OPERATOR_PACKAGE_NAME} icr.io --version ${OPERATOR_VERSION}

5. (Optional) Generate the catalog sources and save them on another directory.

   This command might not return anything if there are no multi-architecture catalog sources for the components being installed.

   1. To get the catalog sources, run:

      cat ~/.ibm-pak/data/mirror/${OPERATOR_PACKAGE_NAME}/${OPERATOR_VERSION}/catalog-sources.yaml

   2. Run the following command to discover whether there are any architecture-specific catalog sources that you need. This command might not return anything if there are no architecture-specific catalog sources for the components being installed. Even if this is the case, those components can be installed in the supported architecture.

      cat ~/.ibm-pak/data/mirror/${OPERATOR_PACKAGE_NAME}/${OPERATOR_VERSION}/catalog-sources-linux-${ARCH}.yaml

   3. (Optional) Navigate to the directory in your file browser to copy these artifacts into files that you can keep for re-use or for pipelines.

6. Apply the catalog sources for this operator to the cluster. This command might not return anything if there are no multi-architecture catalog sources for the components being installed:

   oc apply -f ~/.ibm-pak/data/mirror/${OPERATOR_PACKAGE_NAME}/${OPERATOR_VERSION}/catalog-sources.yaml

   Also run the following command to confirm whether there are any architecture-specific catalog sources to apply. If there are no architecture-specific catalog sources, you can skip this step.

   oc apply -f ~/.ibm-pak/data/mirror/${OPERATOR_PACKAGE_NAME}/${OPERATOR_VERSION}/catalog-sources-linux-${ARCH}.yaml

7. Confirm that the catalog sources were created in the openshift-marketplace project/namespace:

   oc get catalogsource -n openshift-marketplace

These commands set environment variables for the operator package name and version:

(1) Add the IBM Cert Manager catalog source if both the following statements are true:

• You are planning to deploy instances of API management or Event Endpoint Manager.

• You are installing on OpenShift 4.12 on s390x (IBM Z®) or ppc64le (IBM® POWER®) hardware. (On OpenShift 4.12 on other hardware, and on later versions of OpenShift on any hardware, use the cert-manager Operator for Red Hat OpenShift instead. For more information about mirroring this operator, see Installing the cert-manager Operator for Red Hat OpenShift.

You must also use one of these values to set your architecture:

export ARCH=amd64

export ARCH=ppc64le

export ARCH=s390x

1. Copy this resource definition for IBM operators into a local file on your computer:

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-operator-catalog
     namespace: openshift-marketplace
     annotations:
       olm.catalogImageTemplate: "icr.io/cpopen/ibm-operator-catalog:v{kube_major_version}.{kube_minor_version}"
   spec:
     displayName: IBM Operator Catalog
     publisher: IBM
     sourceType: grpc
     image: icr.io/cpopen/ibm-operator-catalog:latest
     updateStrategy:
       registryPoll:
         interval: 45m

2. Run the following command. Replace <filename.yaml> with the name of the file you created in the first step:

   oc apply -f <filename.yaml>

1. Log into the OpenShift web console with your OpenShift cluster administrator credentials.

2. In the banner, click the plus ("+") icon to open the Import YAML dialog box.

   Note: You do not need to select a value for "Project". The YAML code in the next step already includes the correct value for metadata:namespace, which ensures that the catalog source is installed in the correct project (namespace).

3. Paste this resource definition into the dialog box:

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-operator-catalog
     namespace: openshift-marketplace
     annotations:
        olm.catalogImageTemplate: "icr.io/cpopen/ibm-operator-catalog:v{kube_major_version}.{kube_minor_version}"
   spec:
     displayName: IBM Operator Catalog
     image: 'icr.io/cpopen/ibm-operator-catalog:latest'
     publisher: IBM
     sourceType: grpc
     updateStrategy:
       registryPoll:
         interval: 45m

4. Click Create.