ProgressionProbes

Provides an API which allows custom probe definitions to determine readiness of the CER phases. Objects can be selected for in one of two ways: by GroupKind, or by Label (matchLabels and matchExpressions). They can then be tested via any of: Condition, FieldsEqual, and FieldValue. Condition checks that the object has a condition matching the type and status provided. FieldsEqual uses two provided field paths and checks for equality. FieldValue uses a provided field path and checks that the value is equal to the provided expected value.

Signed-off-by: Daniel Franz <dfranz@redhat.com>

Author: dtfranz

api/v1/clusterextensionrevision_types.go

@@ -106,6 +106,10 @@ type ClusterExtensionRevisionSpec struct {
 	// <opcon:experimental>
 	ProgressDeadlineMinutes int32 `json:"progressDeadlineMinutes,omitempty"`
 
+	// +optional
+	// +kubebuilder:validation:MaxItems=20
+	ProgressionProbes []ProgressionProbe `json:"progressionProbes,omitempty"`
+
 	// collisionProtection specifies the default collision protection strategy for all objects
 	// in this revision. Individual phases or objects can override this value.
 	//
@@ -120,6 +124,95 @@ type ClusterExtensionRevisionSpec struct {
 	CollisionProtection CollisionProtection `json:"collisionProtection,omitempty"`
 }
 
+type ProgressionProbe struct {
+	// +required
+	Selector ProbeSelector `json:"selector,omitempty"`
+
+	// +required
+	// +kubebuilder:validation:MaxItems=20
+	Assertions []ProbeAssertion `json:"assertions,omitempty"`
+}
+
+// +union
+// +kubebuilder:validation:XValidation:rule="self.type == 'GroupKind' ?has(self.groupKind) : !has(self.groupKind)",message="groupKind is required when type is GroupKind, and forbidden otherwise"
+// +kubebuilder:validation:XValidation:rule="self.type == 'Label' ?has(self.label) : !has(self.label)",message="label is required when type is Label, and forbidden otherwise"
+type ProbeSelector struct {
+	// +unionDiscriminator
+	// +kubebuilder:validation:Enum=GroupKind;Label
+	// +required
+	SelectorType SelectorType `json:"type,omitempty"`
+
+	// +optional
+	// +unionMember
+	GroupKind metav1.GroupKind `json:"groupKind,omitempty"`
+
+	// +optional
+	// +unionMember
+	Label metav1.LabelSelector `json:"label,omitempty"`
+}
+
+type SelectorType string
+
+const (
+	SelectorTypeGroupKind SelectorType = "GroupKind"
+	SelectorTypeLabel     SelectorType = "Label"
+)
+
+type ProbeType string
+
+const (
+	ProbeTypeFieldCondition ProbeType = "Condition"
+	ProbeTypeFieldEqual     ProbeType = "FieldsEqual"
+	ProbeTypeFieldValue     ProbeType = "FieldValue"
+)
+
+// +union
+// +kubebuilder:validation:XValidation:rule="self.type == 'Condition' ?has(self.condition) : !has(self.condition)",message="condition is required when type is Condition, and forbidden otherwise"
+// +kubebuilder:validation:XValidation:rule="self.type == 'FieldsEqual' ?has(self.fieldsEqual) : !has(self.fieldsEqual)",message="fieldsEqual is required when type is FieldsEqual, and forbidden otherwise"
+// +kubebuilder:validation:XValidation:rule="self.type == 'FieldValue' ?has(self.fieldValue) : !has(self.fieldValue)",message="fieldValue is required when type is FieldValue, and forbidden otherwise"
+type ProbeAssertion struct {
+	// +unionDiscriminator
+	// +kubebuilder:validation:Enum=Condition;FieldsEqual;FieldValue
+	// +required
+	ProbeType ProbeType `json:"type,omitempty"`
+
+	// +unionMember
+	// +optional
+	Condition ConditionProbe `json:"condition,omitempty"`
+
+	// +unionMember
+	// +optional
+	FieldsEqual FieldsEqualProbe `json:"fieldsEqual,omitempty"`
+
+	// +unionMember
+	// +optional
+	FieldValue FieldValueProbe `json:"fieldValue,omitempty"`
+}
+
+type ConditionProbe struct {
+	// +required
+	Type string `json:"type,omitempty"`
+
+	// +required
+	Status string `json:"status,omitempty"`
+}
+
+type FieldsEqualProbe struct {
+	// +required
+	FieldA string `json:"fieldA,omitempty"`
+
+	// +required
+	FieldB string `json:"fieldB,omitempty"`
+}
+
+type FieldValueProbe struct {
+	// +required
+	FieldPath string `json:"fieldPath,omitempty"`
+
+	// +required
+	Value string `json:"value,omitempty"`
+}
+
 // ClusterExtensionRevisionLifecycleState specifies the lifecycle state of the ClusterExtensionRevision.
 type ClusterExtensionRevisionLifecycleState string