Skip to content

Commit 4a47724

Browse files
Merge pull request openshift#1004 from alanconway/condition-doc
LOG-1012 Clarify meaning of Ready and Degraded conditions.
2 parents 065ba23 + 7f570a5 commit 4a47724

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

pkg/apis/logging/v1/conditions.go

+22-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,29 @@ func NewCondition(t status.ConditionType, s corev1.ConditionStatus, r status.Con
2020
}
2121

2222
const (
23-
// Ready object is providing service. All objects support this condition type.
23+
// Ready indicates the service is ready.
24+
//
25+
// Ready=True means the operands are running and providing some service.
26+
// See the Degraded condition to distinguish full service from partial service.
27+
//
28+
// Ready=False means the operands cannot provide any service, and
29+
// the operator cannot recover without some external change. Either
30+
// the spec is invalid, or there is some environmental problem that is
31+
// outside of the the operator's control.
32+
//
33+
// Ready=Unknown means the operator is in transition.
34+
//
2435
ConditionReady status.ConditionType = "Ready"
25-
// Degraded object can provide some service, but not everything requested in the spec.
36+
37+
// Degraded indicates partial service is available.
38+
//
39+
// Degraded=True means the operands can fulfill some of the `spec`, but not all,
40+
// even when Ready=True.
41+
//
42+
// Degraded=False with Ready=True means the operands are providing full service.
43+
//
44+
// Degraded=Unknown means the operator is in transition.
45+
//
2646
ConditionDegraded status.ConditionType = "Degraded"
2747
)
2848

0 commit comments

Comments
 (0)