mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
139 lines
5.6 KiB
Plaintext
139 lines
5.6 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * operators/admin/olm-status.adoc
|
|
// * support/troubleshooting/troubleshooting-operator-issues.adoc
|
|
|
|
ifdef::openshift-origin[]
|
|
:global_ns: olm
|
|
endif::[]
|
|
ifndef::openshift-origin[]
|
|
:global_ns: openshift-marketplace
|
|
endif::[]
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="olm-cs-status-cli_{context}"]
|
|
= Viewing Operator catalog source status by using the CLI
|
|
|
|
You can view the status of an Operator catalog source by using the CLI.
|
|
|
|
.Prerequisites
|
|
|
|
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
* You have access to the cluster as a user with the `cluster-admin` role.
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
* You have access to the cluster as a user with the `dedicated-admin` role.
|
|
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
|
|
* You have installed the OpenShift CLI (`oc`).
|
|
|
|
.Procedure
|
|
|
|
. List the catalog sources in a namespace. For example, you can check the `{global_ns}` namespace, which is used for cluster-wide catalog sources:
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ oc get catalogsources -n {global_ns}
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal]
|
|
----
|
|
NAME DISPLAY TYPE PUBLISHER AGE
|
|
certified-operators Certified Operators grpc Red Hat 55m
|
|
community-operators Community Operators grpc Red Hat 55m
|
|
example-catalog Example Catalog grpc Example Org 2m25s
|
|
redhat-marketplace Red Hat Marketplace grpc Red Hat 55m
|
|
redhat-operators Red Hat Operators grpc Red Hat 55m
|
|
----
|
|
|
|
. Use the `oc describe` command to get more details and status about a catalog source:
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ oc describe catalogsource example-catalog -n {global_ns}
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
Name: example-catalog
|
|
Namespace: {global_ns}
|
|
Labels: <none>
|
|
Annotations: operatorframework.io/managed-by: marketplace-operator
|
|
target.workload.openshift.io/management: {"effect": "PreferredDuringScheduling"}
|
|
API Version: operators.coreos.com/v1alpha1
|
|
Kind: CatalogSource
|
|
# ...
|
|
Status:
|
|
Connection State:
|
|
Address: example-catalog.{global_ns}.svc:50051
|
|
Last Connect: 2021-09-09T17:07:35Z
|
|
Last Observed State: TRANSIENT_FAILURE
|
|
Registry Service:
|
|
Created At: 2021-09-09T17:05:45Z
|
|
Port: 50051
|
|
Protocol: grpc
|
|
Service Name: example-catalog
|
|
Service Namespace: {global_ns}
|
|
# ...
|
|
----
|
|
+
|
|
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.
|
|
|
|
. List the pods in the namespace where your catalog source was created:
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ oc get pods -n {global_ns}
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal]
|
|
----
|
|
NAME READY STATUS RESTARTS AGE
|
|
certified-operators-cv9nn 1/1 Running 0 36m
|
|
community-operators-6v8lp 1/1 Running 0 36m
|
|
marketplace-operator-86bfc75f9b-jkgbc 1/1 Running 0 42m
|
|
example-catalog-bwt8z 0/1 ImagePullBackOff 0 3m55s
|
|
redhat-marketplace-57p8c 1/1 Running 0 36m
|
|
redhat-operators-smxx8 1/1 Running 0 36m
|
|
----
|
|
+
|
|
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.
|
|
|
|
. Use the `oc describe` command to inspect a pod for more detailed information:
|
|
+
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
$ oc describe pod example-catalog-bwt8z -n {global_ns}
|
|
----
|
|
+
|
|
.Example output
|
|
[source,terminal,subs="attributes+"]
|
|
----
|
|
Name: example-catalog-bwt8z
|
|
Namespace: {global_ns}
|
|
Priority: 0
|
|
Node: ci-ln-jyryyg2-f76d1-ggdbq-worker-b-vsxjd/10.0.128.2
|
|
...
|
|
Events:
|
|
Type Reason Age From Message
|
|
---- ------ ---- ---- -------
|
|
Normal Scheduled 48s default-scheduler Successfully assigned {global_ns}/example-catalog-bwt8z to ci-ln-jyryyf2-f76d1-fgdbq-worker-b-vsxjd
|
|
Normal AddedInterface 47s multus Add eth0 [10.131.0.40/23] from openshift-sdn
|
|
Normal BackOff 20s (x2 over 46s) kubelet Back-off pulling image "quay.io/example-org/example-catalog:v1"
|
|
Warning Failed 20s (x2 over 46s) kubelet Error: ImagePullBackOff
|
|
Normal Pulling 8s (x3 over 47s) kubelet Pulling image "quay.io/example-org/example-catalog:v1"
|
|
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
|
|
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.
|
|
|
|
ifdef::openshift-origin[]
|
|
:!global_ns:
|
|
endif::[]
|
|
ifndef::openshift-origin[]
|
|
:!global_ns:
|
|
endif::[]
|