Creating and configuring Operator catalog source

An Operator catalog source contains metadata and specifications such as catalog namespace, image name, update strategy, which are necessary to install and manage Operators.

Procedure

  1. On your local computer, make a YAML file called catalog_source.yaml to create a catalog source manifest with the following contents.
    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-oms-catalog
      namespace: <catalog_source_namespace>
    spec:
      displayName: IBM OMS Operator Catalog
      image: '<image_name>' 
      publisher: IBM
      sourceType: grpc
      updateStrategy:
        registryPoll:
          interval: 10m0s
    • Replace <catalog_source_namespace> with the namespace where you want to install the Operator. For Red Hat® OpenShift® Container Platform cluster, create the catalog source in openshift-marketplace namespace.
    • Update <image_name> with the following image names per edition.
      • IBM® Sterling Order Management System Professional case: icr.io/cpopen/ibm-oms-pro-case-catalog:v1.0
      • IBM Sterling Order Management System Enterprise case: icr.io/cpopen/ibm-oms-ent-case-catalog:v1.0
    • Update the updateStrategy to the wanted frequency for the Operator to check the registry for future updates. In the example, the Operator checks 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.
  2. Configure the catalog source either by using Red Hat OpenShift Container Platform or command-line.
    • Using Red Hat OpenShift Container Platform:
      1. Log in to the Red Hat OpenShift Container Platform.
      2. If you are not in the Administrator perspective, from the context selector in the navigation menu, select Administrator.
      3. Click the plus icon on the upper-right of the screen and then click the Import YAML icon.
      4. In the text area, paste the contents of the catalog_source.yaml that is created in step 1. Alternatively, you can start typing YAML contents to the empty text area.
      5. Update the namespace to openshift-marketplace.
      6. Click Create to apply the catalog source.
      7. Ensure that the newly created catalog source is in READY status before installing the Operator.
    • Using a command-line tool:

      In the following procedure, oc commands are used. The oc commands are interchangeable with kubectl. Hence, if you are connected to a Vanilla Kubernetes cluster, replace the oc commands with kubectl counterparts.

      1. Verify that the correct cluster information is displayed.
        oc cluster-info
      2. Run the following command to apply the catalog source that is created in step 1.
        oc apply -f catalog_source.yaml -n <catalog_source_namespace>
      3. Verify the newly created catalog source to check it is in the READY state before installing the Operator.
        oc describe catalogsource <catalog_source_name> -n <namespace>