|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * updating/index.adoc |
| 4 | + |
| 5 | +:_content-type: CONCEPT |
| 6 | +[id="Understanding_clusteroperator_conditiontypes_{context}"] |
| 7 | += Understanding cluster Operator condition types |
| 8 | + |
| 9 | +The status of cluster Operators includes their condition type, informing you of the current state of your Operator's health. The following definitions cover a list of some common ClusterOperator condition types. Operators that have additional condition types and use Operator-specific language have been omitted. |
| 10 | + |
| 11 | +The Cluster Version Operator (CVO) is responsible for collecting the status conditions from cluster Operators so that cluster administrators can better understand the state of the {product-title} cluster. |
| 12 | + |
| 13 | +//Condition types, as well as additional information about your operator, can be retrieved in either YAML or JSON format through the `oc get clusterversion -o` command: |
| 14 | + |
| 15 | +//[source,terminal] |
| 16 | +//---- |
| 17 | +//$ oc get clusterversion -o yaml |
| 18 | +//---- |
| 19 | + |
| 20 | + |
| 21 | +* Available: |
| 22 | +An Operator with the condition type `Available` is functional and available in the cluster. If the status is `False`, at least one part of the operand is non-functional and the condition requires an administrator to intervene. |
| 23 | +
|
| 24 | +* Progressing: |
| 25 | +An Operator with the condition type `Progressing` is actively rolling out new code, propagating configuration changes, or otherwise moving from one steady state to another. |
| 26 | ++ |
| 27 | +Operators do not report the condition type `Progressing` as `True` when they are reconciling a previous known state. If the observed cluster state has changed and the Operator is reacting to it, then the status will report back as `True`, since it is moving from one steady state to another. |
| 28 | ++ |
| 29 | +* Degraded: |
| 30 | +An Operator with the condition type `Degraded` has a current state that does not match the required state over a period of time. The period of time can vary by component, but a `Degraded` state represents persistent observation of an Operator's condition. As a result, an Operator will not fluctuate in and out of the `Degraded` state. |
| 31 | ++ |
| 32 | +There might be a different condition type if the transition from one state to another does not persist over a long enough period to report `Degraded`. |
| 33 | +An Operator will not report `Degraded` during the course of a normal upgrade. An Operator may report `Degraded` in response to a persistent infrastructure failure that requires eventual administrator intervention. |
| 34 | ++ |
| 35 | +[NOTE] |
| 36 | +==== |
| 37 | +This condition type is only an indication that something may need investigation and adjustment. As long as the Operator is available, the `Degraded` condition does not cause user workload failure or application downtime. |
| 38 | +==== |
| 39 | ++ |
| 40 | +* Upgradeable: |
| 41 | +An Operator with the condition type `Upgradeable` indicates whether the Operator is safe to upgrade based on the current cluster state. The message field will contain a human-readable description of what the administrator needs to do for the cluster to successfully update. The CVO allows updates when this condition is `True`, `Unknown` or missing. |
| 42 | ++ |
| 43 | +When the `Upgradeable` status is `False`, only minor updates are impacted, and the CVO prevents the cluster from performing impacted updates unless forced. |
0 commit comments