Adding catalog sources to a cluster

Add a separate catalog source for each operator in your OpenShift cluster, to make the IBM operators available for installation. This task is also required to apply the fix packs for catalog sources, prior to an upgrade.

This task requires a user with the cluster administrator role (for more information, see OpenShift Roles and permissions) and must be done by using the CLI.

By using a separate catalog source for each operator, you gain full control of software versioning on a cluster. For example:

  • You can upgrade each Cloud Pak component independently.

  • You can have a fully declarative set of artifacts, which you can use to recreate exact installations.

  • You can easily control upgrade and promotion through environments (such as from test to production environments) with a CI/CD pipeline.

  • You can control when upgrades happen. A new operator version becomes available in an OpenShift cluster only after you update the catalog source for that operator. This process effectively gives you manual control of upgrades, without actually using the Manual option (which is not recommended; see "Before you begin" for more information).

Important: Do not use the IBM Operator Catalog; it is used for proof-of-concept environments only and is not suitable for production environments.

Before you begin

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. Because the Manual option forces all possible upgrades to be done at the same time and can block upgrades, you should only use the default Automatic option.

Procedure

  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. Apply the catalog source for the operator by copying the applicable command in Catalog sources for operators.

    For example:

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-integration-platform-navigator/7.3.4/OLM/catalog-sources.yaml

  3. Confirm that the catalog source was created in the openshift-marketplace project/namespace:

    oc get catalogsource -n openshift-marketplace

  4. Repeat steps 2-3 for each operator that you need to install.

Catalog sources for operators

Copy the command for each operator that you need to install.

  • IBM Cloud Pak for Integration

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-integration-platform-navigator/7.3.4/OLM/catalog-sources.yaml

  • IBM Automation foundation assets

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-integration-asset-repository/1.7.3/OLM/catalog-sources-linux-amd64.yaml

  • IBM API Connect

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-apiconnect/5.2.0/OLM/catalog-sources.yaml

  • IBM App Connect

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-appconnect/12.0.3/OLM/catalog-sources.yaml

  • IBM MQ

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-mq/3.2.4/OLM/catalog-sources.yaml

  • IBM Event Streams

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-eventstreams/3.5.0/OLM/catalog-sources.yaml

  • IBM Event Endpoint Management

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-eventendpointmanagement/11.2.3/OLM/catalog-sources.yaml

  • IBM DataPower Gateway

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-datapower-operator/1.11.2/OLM/catalog-sources.yaml

  • IBM Aspera HSTS *

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-aspera-hsts-operator/1.5.13/OLM/catalog-sources.yaml

  • IBM Operator for Redis

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-cloud-databases-redis/1.6.11/OLM/catalog-sources.yaml

  • IBM Cloud Pak foundational services

    oc apply --filename https://raw.githubusercontent.com/IBM/cloud-pak/master/repo/case/ibm-cp-common-services/4.6.5/OLM/catalog-sources.yaml
Notes

  • * If you are planning to install the IBM Aspera HSTS operator, you also need to apply the catalog source for the IBM Operator for Redis.

  • Catalog sources are located on the cloud-pak repo. For example, all the IBM Cloud Pak for Integration operator versions are in the ibm-integration-platform-navigator folder.

    Reviewing these files can assist you with the following:

    • Finding the catalog sources for all fix packs

    • Getting the YAML for the catalog source and creating it by using the OpenShift web console

    • Identifying when a new fix pack has been released

    You can also modify the version in the oc apply command to create a catalog source for a previous fix pack. For example, if you review Version information for the IBM Cloud Pak for Integration operator and decide that you want to get the first fix pack for the IBM Cloud Pak for Integration operator, you can change the version in the URL to 7.3.0.