Red Hat OpenShift Container Platform

Add a catalog to a cluster

To add a catalog to a cluster for Operator Lifecycle Manager (OLM) v1 usage, create a ClusterCatalog custom resource (CR) and apply it to the cluster.

Procedure

Create a catalog custom resource (CR), similar to the following example:
Example my-redhat-operators.yaml file
```
apiVersion: olm.operatorframework.io/v1
kind: ClusterCatalog
metadata:
  name: my-redhat-operators
spec:
  priority: 1000
  source:
    image:
      pollIntervalMinutes: 10
      ref: registry.redhat.io/redhat/community-operator-index:v{product-version}
    type: Image
```
where:

metadata.name

The catalog is automatically labeled with the value of the metadata.name field when it is applied to the cluster. For more information about labels and catalog selection, see "Catalog content resolution".

spec.priority

Optional: Specifies the priority of the catalog in relation to the other catalogs on the cluster. For more information, see "Catalog selection by priority".

spec.source.image.pollIntervalMinutes

Specifies the interval in minutes for polling the remote registry for newer image digests. To disable polling, do not set the field.

spec.source.image.ref

Specifies the catalog image in the spec.source.image.ref field.

Add the catalog to your cluster by running the following command:

$ oc apply -f my-redhat-operators.yaml

Example output

clustercatalog.olm.operatorframework.io/my-redhat-operators created

Verification

Run the following commands to verify the status of your catalog:

Check if your catalog is available by running the following command:

$ oc get clustercatalog

Example output

NAME                            LASTUNPACKED   SERVING   AGE
my-redhat-operators             55s            True      64s
openshift-certified-operators   83m            True      84m
openshift-community-operators   43m            True      84m
openshift-redhat-marketplace    83m            True      84m
openshift-redhat-operators      54m            True      84m

Check the status of your catalog by running the following command:

$ oc describe clustercatalog my-redhat-operators

Example output

Name:         my-redhat-operators
Namespace:
Labels:       olm.operatorframework.io/metadata.name=my-redhat-operators
Annotations:  <none>
API Version:  olm.operatorframework.io/v1
Kind:         ClusterCatalog
Metadata:
  Creation Timestamp:  2025-02-18T20:28:50Z
  Finalizers:
    olm.operatorframework.io/delete-server-cache
  Generation:        1
  Resource Version:  50248
  UID:               86adf94f-d2a8-4e70-895b-31139f2eeab7
Spec:
  Availability Mode:  Available
  Priority:           1000
  Source:
    Image:
      Poll Interval Minutes:  10
      Ref:                    registry.redhat.io/redhat/community-operator-index:v{product-version}
    Type:                     Image
Status:
  Conditions:
    Last Transition Time:  2025-02-18T20:29:00Z
    Message:               Successfully unpacked and stored content from resolved source
    Observed Generation:   1
    Reason:                Succeeded
    Status:                True
    Type:                  Progressing
    Last Transition Time:  2025-02-18T20:29:00Z
    Message:               Serving desired content from resolved source
    Observed Generation:   1
    Reason:                Available
    Status:                True
    Type:                  Serving
  Last Unpacked:           2025-02-18T20:28:59Z
  Resolved Source:
    Image:
      Ref:  registry.redhat.io/redhat/community-operator-index@sha256:11627ea6fdd06b8092df815076e03cae9b7cede8b353c0b461328842d02896c5
    Type:   Image
  Urls:
    Base:  https://catalogd-service.openshift-catalogd.svc/catalogs/my-redhat-operators
Events:    <none>

In the output, the Status section describes the status of the catalog. In the Status section, the Reason field displays the reason the catalog is in the current state. In the Resolved Source section, the Ref field displays the image reference of the catalog.