Skip to content

Commit 17a42a2

Browse files
authored
Merge pull request #41736 from adellape/conditions_note
2 parents 21af0ef + 11d90d5 commit 17a42a2

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

modules/olm-operatorconditions-about.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,8 @@ endif::[]
1515
As part of its role in managing the lifecycle of an Operator, Operator Lifecycle Manager (OLM) infers the state of an Operator from the state of Kubernetes resources that define the Operator. While this approach provides some level of assurance that an Operator is in a given state, there are many instances where an Operator might need to communicate information to OLM that could not be inferred otherwise. This information can then be used by OLM to better manage the lifecycle of the Operator.
1616

1717
OLM provides a custom resource definition (CRD) called `OperatorCondition` that allows Operators to communicate conditions to OLM. There are a set of supported conditions that influence management of the Operator by OLM when present in the `Spec.Conditions` array of an `OperatorCondition` resource.
18+
19+
[NOTE]
20+
====
21+
By default, the `Spec.Conditions` array is not present in an `OperatorCondition` object until it is either added by a user or as a result of custom Operator logic.
22+
====

modules/olm-overriding-operatorconditions.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,20 @@
88

99
As a cluster administrator, you might want to ignore a supported Operator condition reported by an Operator. When present, Operator conditions in the `Spec.Overrides` array override the conditions in the `Spec.Conditions` array, allowing cluster administrators to deal with situations where an Operator is incorrectly reporting a state to Operator Lifecycle Manager (OLM).
1010

11-
For example, consider a known version of an Operator that always communicates that it is not upgradeable. In this instance, you might want to upgrade the Operator despite the Operator communicating that it is not upgradeable. This could be accomplished by overriding the Operator condition by adding the condition `type` and `status` to the `Spec.Overrides` array in the `OperatorCondition` resource.
11+
[NOTE]
12+
====
13+
By default, the `Spec.Overrides` array is not present in an `OperatorCondition` object until it is added by a cluster administrator. The `Spec.Conditions` array is also not present until it is either added by a user or as a result of custom Operator logic.
14+
====
15+
16+
For example, consider a known version of an Operator that always communicates that it is not upgradeable. In this instance, you might want to upgrade the Operator despite the Operator communicating that it is not upgradeable. This could be accomplished by overriding the Operator condition by adding the condition `type` and `status` to the `Spec.Overrides` array in the `OperatorCondition` object.
1217

1318
.Prerequisites
1419

15-
* An Operator with an `OperatorCondition` resource, installed using OLM.
20+
* An Operator with an `OperatorCondition` object, installed using OLM.
1621
1722
.Procedure
1823

19-
. Edit the `OperatorCondition` resource for the Operator:
24+
. Edit the `OperatorCondition` object for the Operator:
2025
+
2126
[source,terminal]
2227
----

0 commit comments

Comments
 (0)