Adding the catalog source for the IBM App Connect Operator

OpenShift-only contentYou can add a product-specific catalog for the IBM® App Connect Operator to your cluster by adding a dedicated catalog source.

To alternatively add the catalog source to an online cluster by using the IBM Operator Catalog, see Adding catalog sources with the IBM Operator Catalog (online environments only).

Complete this procedure by using the Red Hat OpenShift CLI.

Before you begin

  • Ensure that you have cluster administrator authority with cluster-admin permissions.
  • Ensure that the IBM Catalog Management Plug-in for IBM Cloud Paks 1.1.0 or later is installed on your computer. You need this plug-in to run oc ibm-pak commands against the cluster. If you need to, you can download the plug-in from GitHub.
  • If you are working in an air-gapped environment, ensure that you have completed the steps in Mirroring images for an air-gapped cluster.

About this task

Complete the relevant tasks for your online or air-gapped environment.

Generating the catalog source files (online environment only)

This task applies to clusters in online environments only.

For clusters in air-gapped (restricted) environments, the catalog source files are generated as part of Mirroring images for an air-gapped cluster.

Procedure

To generate the catalog source files, complete the following steps:

  1. From the command line, log in to your Red Hat OpenShift cluster by using the oc login command.
  2. Export the variables for the command line to use. Replace <ARCHITECTURE> with amd64, s390x, or ppc64le, to reflect your Linux® operating system platform. 
    export CASE_NAME=ibm-appconnect
export CASE_VERSION=12.11.0
export ARCH=<ARCHITECTURE>
  3. Download the files for the IBM App Connect Operator. 
    oc ibm-pak get ${CASE_NAME} --version ${CASE_VERSION}

    By default, the plug-in uses a root directory of ~/.ibm-pak, and the files are downloaded under ~/.ibm-pak/data/cases/$CASE_NAME/$CASE_VERSION. The default location of the logs files is ~/.ibm-pak/logs/oc-ibm_pak.log.

  4. Generate the catalog source files for the IBM App Connect Operator. (The multi-architecture catalog source can be used on all platforms.) 
    oc ibm-pak generate mirror-manifests ${CASE_NAME} icr.io --version ${CASE_VERSION}

    This command generates a set of catalog source files, including the catalog-sources.yaml file that you will later use to deploy the catalog source for the IBM App Connect Operator. By default, these files are saved to ~/.ibm-pak/data/mirror/$CASE_NAME/$CASE_VERSION.

  5. In case you need to replicate this installation in the future, get the generated catalog source and save it to another directory.

    To get the catalog source, run the following command.

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

    You can also navigate to the directory in your file browser (if needed) to copy these artifacts into files that you want to keep for reuse or for pipelines.

What to do next

Apply the catalog source in your online environment.

Applying the catalog source (online and air-gapped environments)

This task applies to clusters in online and air-gapped environments.

Procedure

To apply the catalog source for the IBM App Connect Operator, complete the following steps:

  1. Run the following command to apply the catalog source to the 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
  2. Confirm that the catalog source is created in the openshift-marketplace project or namespace, which makes the catalog available to all namespaces in the cluster. 
    oc get catalogsource -n openshift-marketplace

    Check the output to ensure that an entry called appconnect-operator-catalogsource is available.

What to do next

You can now install the IBM App Connect Operator as described in Installing the IBM App Connect Operator.