Preparing and configuring Sterling Order Management System Software Operator catalog source

Prepare and configure the operators as explained in the following steps:

Preparing the catalog source manifest

From your local computer create a YAML file called catalog_source.yaml with the following content:
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-oms-catalog
  namespace: <catalog_source_namespace>
spec:
  displayName: IBM OMS Operator Catalog
  # For the image name, see the following catalog source image names table and use the appropriate value.
  image: '<image_name>' 
  publisher: IBM
  sourceType: grpc 
  updateStrategy:
    registryPoll:
      interval: 10m0s
Note: The updateStrategy must be adjusted to the desired frequency for the Operator to check the registry for future updates. In the given example, the Operator will check for new updates every 10 minutes. To minimize the frequency of checks and reduce resource utilization, you can set the interval to a higher value.
Catalog source image names

Use the image names from the following table to update <image_name> in your YAML file.

Edition Image name
IBM® Sterling Order Management System Software Professional case cp.icr.io/cpopen/ibm-oms-pro-case-catalog:v1.0
IBM Sterling Order Management System Software Enterprise case cp.icr.io/cpopen/ibm-oms-ent-case-catalog:v1.0
Note:
  • If you are using the OpenShift® Container Platform cluster, ensure that you create the catalog source in openshift-marketplace namespace .
  • If you want to make use of IBM Operator Catalog instead of directly using the Operator catalog, ensure to change following parameters from the example.
    • metadata.name changed to ibm-operator-catalog.
    • spec.displayName changed to IBM Operator Catalog.
    • spec.image changed to cp.icr.io/cpopen/ibm-operator-catalog.
    • Ensure to use ibm-operator-catalog in place of ibm-oms-catalog in all the following steps.

Configuring the catalog source by using CLI

To configure the catalog source by using the CLI, complete the following steps:

Note: In the following procedure, oc commands are used. The oc commands are interchangeable with kubectl. Hence, if you are connected to non-OpenShift Kubernetes cluster, ensure to replace the oc commands with kubectl counterparts.
  1. Log in to the OpenShift Container Platform or Kubernetes cluster. Ensure to run the oc cluster-info sub-command to verify that the correct cluster information is displayed.
  2. Run the following command:
    oc apply -f catalog_source.yaml -n <catalog_source_namespace>
  3. Verify the installation by running this command:
    oc get CatalogSources ibm-oms-catalog -n <catalog_source_namespace>
    • If the installation was successful, you should see output that is similar to this:
      NAME                   DISPLAY                 TYPE   PUBLISHER      AGE
      ibm-oms-catalog   IBM OMS Operator Catalog      grpc     IBM            50s
    • If the installation failed, the following message is displayed:

      Error from server (NotFound): catalogsources.operators.coreos.com "ibm-oms-catalog" not found

      To help resolve this error, run the following command to check the pods and CatalogSource resources in the <catalog_source_namespace> namespace:
      oc get catalogsource,pods -n <catalog_source_namespace>
      The output should provide information about your CatalogSource resources and status of the pods; for example:
      NAME                                                                          DISPLAY                     TYPE   PUBLISHER   AGE
      catalogsource.operators.coreos.com/certified-operators                        Certified Operators         grpc   Red Hat     20d
      catalogsource.operators.coreos.com/community-operators                        Community Operators         grpc   Red Hat     20d
      catalogsource.operators.coreos.com/ibm-oms-catalog                            IBM OMS Operator Catalog    grpc   IBM         48s
      catalogsource.operators.coreos.com/opencloud-operators                        IBMCS Operators             grpc   IBM         48s
      catalogsource.operators.coreos.com/redhat-marketplace                         Red Hat Marketplace         grpc   Red Hat     20d
      catalogsource.operators.coreos.com/redhat-operators                           Red Hat Operators           grpc   Red Hat     20d
      NAME                                                 READY   STATUS      RESTARTS   AGE
      pod/certified-operators-575f586fd8-m2ldh             1/1     Running     0          41m
      pod/community-operators-57fd7676ff-sqzgs             1/1     Running     0          15h
      pod/ibm-oms-catalog-85b2w                            1/1     Running     0          48s
      pod/marketplace-operator-5fcf68c65c-l8tcg            1/1     Running     0          5d8h
      pod/opencloud-operators-wbb9k                        1/1     Running     0          48s
      pod/redhat-marketplace-665c9c6db4-hhfkd              1/1     Running     0          41m
      pod/redhat-operators-8678ddbc5-6szpp                 1/1     Running     0          4d1h

Configuring the catalog source by using OpenShift web console

To configure the catalog source by using the OpenShift web console, complete the following steps:

  1. Log in to the OpenShift web console.
  2. Click the Import YAML icon.
  3. In the text area, paste the contents of the catalog source manifest prepared in Preparing and configuring Sterling Order Management System Software Operator catalog source.
  4. Update the namespace to openshift-marketplace.
  5. Click Create.