Skip to content

Commit a9f18ce

Browse files
committed
Adding explanations for condition reasons
1 parent 050d707 commit a9f18ce

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

api/v1alpha1/inferencemodel_types.go

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,20 @@ type InferenceModelConditionType string
195195
type InferenceModelConditionReason string
196196

197197
const (
198-
// This condition indicates whether the model is ready for traffic or not, and why.
198+
// This condition indicates if the model is ready to accept traffic, and if not, why.
199+
//
200+
// Possible reasons for this condition to be True are:
201+
//
202+
// * "Ready"
203+
//
204+
// Possible reasons for this condition to be False are:
205+
//
206+
// * "ModelNameInUse"
207+
//
208+
// Possible reasons for this condition to be Unknown are:
209+
//
210+
// * "Pending"
211+
//
199212
ModelConditionReady InferenceModelConditionType = "Ready"
200213

201214
// Desired state. Model is ready for serving with no conflicts or issues.

api/v1alpha1/inferencepool_types.go

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,20 @@ type InferencePoolConditionType string
127127
type InferencePoolConditionReason string
128128

129129
const (
130-
// This condition indicates whether the pool is ready for traffic or not, and why.
130+
// This condition indicates if the pool is ready to accept traffic, and if not, why.
131+
//
132+
// Possible reasons for this condition to be True are:
133+
//
134+
// * "Ready"
135+
//
136+
// Possible reasons for this condition to be False are:
137+
//
138+
// * "EndpointPickerNotHealthy"
139+
//
140+
// Possible reasons for this condition to be Unknown are:
141+
//
142+
// * "Pending"
143+
//
131144
PoolConditionReady InferencePoolConditionType = "Ready"
132145

133146
// Desired state. The pool and its components are initialized and ready for traffic.

0 commit comments

Comments
 (0)