Updating the catalog sources and images for an IBM App Connect upgrade on Red Hat OpenShift

When a new version of the IBM® App Connect Operator is released, it needs to be made available in your cluster so that you can upgrade your existing Operator and instances with the latest features, enhancements, and fixes. If you are upgrading from a Red Hat OpenShift cluster, the catalog source and images for the new Operator version are available either through the IBM Operator Catalog or through a dedicated product-specific catalog.

Note: This task is applicable only for Operator deployments on Red Hat OpenShift, which are managed by the Operator Lifecycle Manager (OLM). In a Kubernetes environment, Operator deployments are managed by Helm and you can obtain the Helm chart for the latest IBM App Connect Operator from the IBM Charts Helm Repository on GitHub. For more information, see Upgrading the IBM App Connect Operator from an earlier to a later Continuous Delivery (CD) version on Kubernetes.

Complete the task that matches your installation environment and the type of catalog source that you installed.

Updating the catalog source and images in an online environment
Updating the catalog source and images in an air-gapped environment
Updating the image location of the IBM Operator Catalog (online only)

Updating the catalog source and images in an online environment

In a Red Hat OpenShift cluster that is connected to the internet, you can install the IBM App Connect Operator either from the IBM Operator Catalog or from a product-specific IBM App Connect catalog.

In an online environment, no action is needed to update the catalog source and images because the IBM Operator Catalog and the product-specific catalog are configured to poll for updates every 45 minutes. This configuration is defined in the YAML manifest for their deployed CatalogSource objects as shown in the following example.

spec:
  updateStrategy:
    registryPoll:
      interval: 45m

For more information about these catalog sources, see Adding catalog sources to a cluster on Red Hat OpenShift.

What to do next

Upgrade the IBM App Connect Operator and your existing instances as described in Upgrading from an earlier to a later Continuous Delivery (CD) release.

Updating the catalog source and images in an air-gapped environment

In an air-gapped environment on Red Hat OpenShift, you can install the IBM App Connect Operator only from a product-specific IBM App Connect catalog. Because the cluster is not connected to the internet, you need to manually update the catalog source and images when a new Operator version becomes available. You can do so by mirroring the images to an internal registry and then adding the catalog source to your cluster.

Procedure

To update the catalog source and images in an air-gapped environment, complete the following steps:

Mirror the images to a registry in your restricted network environment.
- If you are using a bastion host, follow the instructions in Mirroring images with a bastion host. If the setup of your mirroring environment for the previous Operator installation is still in place, you might be able to skip some of the earlier tasks; for example, the steps under 1. Set up your mirroring environment.
- If you are using a portable compute device or a portable storage device, follow the instructions in Mirroring images with a portable compute or storage device (file system). If the setup of your mirroring environment for the previous Operator installation is still in place, you might be able to skip some of the earlier tasks; for example, the steps under 1. Set up your mirroring environment.

Run the following command to add the catalog source to your cluster.

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

You should see the following output.

catalogsource.operators.coreos.com/appconnect-operator-catalogsource configured

What to do next

Upgrade the IBM App Connect Operator and your existing instances as described in Upgrading from an earlier to a later Continuous Delivery (CD) release.

Updating the image location of the IBM Operator Catalog (online only)

If you are upgrading from a Red Hat OpenShift cluster with internet access, and are using the IBM Operator Catalog, ensure that the catalog image is being pulled from the IBM Container Registry copen namespace instead of Docker Hub (docker.io/ibmcom). The IBM Container Registry (icr.io/cpopen) is a trusted public location for pulling this installation image.

Before you begin

Ensure that you have cluster administrator authority with cluster-admin permissions.

About this task

The IBM Operator Catalog image provides a catalog of IBM offerings and is enabled in the Red Hat OpenShift Operator catalog by deploying a CatalogSource resource. You can update the image location that is specified in the deployed CatalogSource object by using the Red Hat OpenShift CLI or web console. This task needs to be completed only once in a cluster.

Procedure

To update the image location in the deployed CatalogSource object for the IBM Operator Catalog, complete either of the following steps:

Update the image location by using the Red Hat OpenShift web console:
1. Log in to the Red Hat OpenShift web console.
2. From the navigation, click Administration > Cluster Settings, and then click the Global Configuration tab.
3. From the list of configuration resources, locate and click OperatorHub, and then click the Sources tab.
4. From the list of deployed catalog sources, locate and click ibm-operator-catalog, and then click the YAML tab.
5. Update the spec.image value to point to the icr.io/cpopen location:
```
spec:
  image: icr.io/cpopen/ibm-operator-catalog
```
6. Click Save.
Update the image location by using the Red Hat OpenShift CLI:
1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
2. Run the following command to verify that a CatalogSource object is deployed for the IBM Operator Catalog:
```
oc get catalogsources -n openshift-marketplace
```
  In the output, you should see an entry for the IBM Operator Catalog; for example:
```
NAME                                       DISPLAY                     TYPE   PUBLISHER   AGE
ibm-operator-catalog                       IBM Operator Catalog        grpc   IBM         41d
...
```
3. Use commands such as oc patch or oc edit to partially update the ibm-operator-catalog CatalogSource object.
  For example, run oc patch with the following syntax (or your preferred syntax) to update the spec.image value:
```
oc patch catalogsource ibm-operator-catalog -n openshift-marketplace -p '{"spec":{"image":icr.io/cpopen/ibm-operator-catalog}}' --type merge
```
  Or run oc edit as follows. When the text editor for your operating system opens, update the spec.image value to icr.io/cpopen/ibm-operator-catalog. Then save the YAML definition and close the text editor to apply the changes.
```
oc edit catalogsource ibm-operator-catalog -n openshift-marketplace
```

What to do next

Upgrade the IBM App Connect Operator and your existing instances as described in Upgrading from an earlier to a later Continuous Delivery (CD) release.