Viewing Operator status

    Subscriptions can report the following condition types:

    Additional resources

    You can view Operator subscription status by using the CLI.

    Prerequisites

    • You have installed the OpenShift CLI (oc).

    Procedure

    1. List Operator subscriptions:

    2. Use the oc describe command to inspect a Subscription resource:

      1. $ oc describe sub <subscription_name> -n <operator_namespace>

    3. In the command output, find the Conditions section for the status of Operator subscription condition types. In the following example, the CatalogSourcesUnhealthy condition type has a status of false because all available catalog sources are healthy:

      Example output

      1. Conditions:
      2.    Last Transition Time:  2019-07-29T13:42:57Z
      3.    Message:               all available catalogsources are healthy
      4.    Reason:                AllCatalogSourcesHealthy
      5.    Status:                False
      6.    Type:                  CatalogSourcesUnhealthy

    You can view the status of an Operator catalog source by using the CLI.

    Prerequisites

    • You have access to the cluster as a user with the cluster-admin role.

    Procedure

    1. List the catalog sources in a namespace. For example, you can check the olm namespace, which is used for cluster-wide catalog sources:

      1. NAME                  DISPLAY               TYPE   PUBLISHER   AGE
      2. certified-operators   Certified Operators   grpc   Red Hat     55m
      3. community-operators   Community Operators   grpc   Red Hat     55m
      4. example-catalog       Example Catalog       grpc   Example Org 2m25s
      5. redhat-marketplace    Red Hat Marketplace   grpc   Red Hat     55m
      6. redhat-operators      Red Hat Operators     grpc   Red Hat     55m

    2. Use the oc describe command to get more details and status about a catalog source:

      1. $ oc describe catalogsource example-catalog -n olm

      Example output

      In the preceding example output, the last observed state is TRANSIENT_FAILURE. This state indicates that there is a problem establishing a connection for the catalog source.

    3. List the pods in the namespace where your catalog source was created:

      1. $ oc get pods -n olm

      Example output

      1. NAME                                    READY   STATUS             RESTARTS   AGE
      2. certified-operators-cv9nn               1/1     Running            0          36m
      3. community-operators-6v8lp               1/1     Running            0          36m
      4. marketplace-operator-86bfc75f9b-jkgbc   1/1     Running            0          42m
      5. example-catalog-bwt8z                   0/1     ImagePullBackOff   0          3m55s

      When a catalog source is created in a namespace, a pod for the catalog source is created in that namespace. In the preceding example output, the status for the example-catalog-bwt8z pod is ImagePullBackOff. This status indicates that there is an issue pulling the catalog source’s index image.

    4. Use the oc describe command to inspect a pod for more detailed information:

      Example output

      1. Name:         example-catalog-bwt8z
      2. Namespace:    olm
      3. Priority:     0
      4. Node:         ci-ln-jyryyg2-f76d1-ggdbq-worker-b-vsxjd/10.0.128.2
      5. ...
      6. Events:
      7.   Type     Reason          Age                From               Message
      8.   ----     ------          ----               ----               -------
      9.   Normal   Scheduled       48s                default-scheduler  Successfully assigned olm/example-catalog-bwt8z to ci-ln-jyryyf2-f76d1-fgdbq-worker-b-vsxjd
      10.   Normal   AddedInterface  47s                multus             Add eth0 [10.131.0.40/23] from openshift-sdn
      11.   Normal   BackOff         20s (x2 over 46s)  kubelet            Back-off pulling image "quay.io/example-org/example-catalog:v1"
      12.   Warning  Failed          20s (x2 over 46s)  kubelet            Error: ImagePullBackOff
      13.   Normal   Pulling         8s (x3 over 47s)   kubelet            Pulling image "quay.io/example-org/example-catalog:v1"
      14.   Warning  Failed          8s (x3 over 47s)   kubelet            Failed to pull image "quay.io/example-org/example-catalog:v1": rpc error: code = Unknown desc = reading manifest v1 in quay.io/example-org/example-catalog: unauthorized: access to the requested resource is not authorized
      15.   Warning  Failed          8s (x3 over 47s)   kubelet            Error: ErrImagePull

      In the preceding example output, the error messages indicate that the catalog source’s index image is failing to pull successfully because of an authorization issue. For example, the index image might be stored in a registry that requires login credentials.

    Additional resources