apis: add ServiceExport condition type/reasons

Signed-off-by: Arthur Outhenin-Chalandre <[email protected]>

Author: MrFreezeex

pkg/apis/v1alpha1/serviceexport.go

@@ -66,13 +66,17 @@ const (
 	// service export has been recognized as valid by an mcs-controller.
 	// This will be false if the service is found to be unexportable
 	// (ExternalName, not found).
+	//
+	// Deprecated: use ServiceExportConditionValid instead
 	ServiceExportValid = "Valid"
 	// ServiceExportConflict means that there is a conflict between two
 	// exports for the same Service. When "True", the condition message
 	// should contain enough information to diagnose the conflict:
 	// field(s) under contention, which cluster won, and why.
 	// Users should not expect detailed per-cluster information in the
 	// conflict message.
+	//
+	// Deprecated: use ServiceExportConditionConflict instead
 	ServiceExportConflict = "Conflict"
 )
 
@@ -88,3 +92,133 @@ type ServiceExportList struct {
 	// +listType=set
 	Items []ServiceExport `json:"items"`
 }
+
+// ServiceExportConditionType is a type of condition associated with ServiceExport.
+// This type should be used with the ServiceExportStatus.Conditions
+// field.
+type ServiceExportConditionType string
+
+// ServiceExportConditionReason defines the set of reasons that explain
+// why a particular conflict condition type has been raised.
+type ServiceExportConditionReason string
+
+const (
+	// ServiceExportConditionValid is true when the Service Export is valid. This does
+	// not indicate whether or not the configuration has been exported to
+	// a control plane / data plane.
+	//
+	//
+	// Possible reasons for this condition to be true are:
+	//
+	// * "Valid"
+	//
+	// Possible reasons for this condition to be False are:
+	//
+	// * "NoService"
+	// * "InvalidServiceType"
+	//
+	// Controllers may raise this condition with other reasons,
+	// but should prefer to use the reasons listed above to improve
+	// interoperability.
+	ServiceExportConditionValid ServiceExportConditionType = "Valid"
+
+	// ServiceExportReasonValid is used with the "Valid" condition when the
+	// condition is True.
+	ServiceExportReasonValid ServiceExportConditionReason = "Valid"
+
+	// ServiceExportReasonNoService is used with the "Valid" condition when
+	// the associated Service does not exist.
+	ServiceExportReasonNoService ServiceExportConditionReason = "NoService"
+
+	// ServiceExportReasonInvalidServiceType is used with the "Valid"
+	// condition when the associated Service has an invalid type
+	// (per the KEP at least the ExternalName type).
+	ServiceExportReasonInvalidServiceType ServiceExportConditionReason = "InvalidServiceType"
+)
+
+const (
+	// ServiceExportConditionExported is true when the service is exported to some
+	// control plane or data plane.
+	//
+	//
+	// Possible reasons for this condition to be true are:
+	//
+	// * "Exported"
+	//
+	// Possible reasons for this condition to be False are:
+	//
+	// * "Invalid"
+	// * "Pending"
+	//
+	// Possible reasons for this condition to be Unknown are:
+	//
+	// * "Pending"
+	//
+	// Controllers may raise this condition with other reasons,
+	// but should prefer to use the reasons listed above to improve
+	// interoperability.
+	ServiceExportConditionExported ServiceExportConditionType = "Exported"
+
+	// ServiceExportReasonExported is used with the "Exported" condition
+	// when the condition is True.
+	ServiceExportReasonExported ServiceExportConditionReason = "Exported"
+
+	// ServiceExportReasonInvalid is used with the "Exported" condition
+	// when the exported service is invalid and will not be exported.
+	ServiceExportReasonInvalid ServiceExportConditionReason = "Invalid"
+
+	// ServiceExportReasonPending is used with the "Exported" condition
+	// when the service is going to be exported.
+	ServiceExportReasonPending ServiceExportConditionReason = "Pending"
+)
+
+const (
+	// ConflictConditionConflict indicates that the controller was unable
+	// to resolve conflict for a ServiceExport. This condition must be at
+	// least raised on the conflicting ServiceExport and is recommended to
+	// be raised on all on all the constituent `ServiceExport`s if feasible.
+	//
+	//
+	// Possible reasons for this condition to be true are:
+	//
+	// * "PortsConflict"
+	// * "TypeConflict"
+	// * "SessionAffinityConflict"
+	// * "SessionAffinityConfigConflict"
+	// * "MultipleConflicts"
+	//
+	// Possible reasons for this condition to be False are:
+	//
+	// * "NoConflicts"
+	//
+	// Controllers may raise this condition with other reasons,
+	// but should prefer to use the reasons listed above to improve
+	// interoperability.
+	ServiceExportConditionConflict ServiceExportConditionType = "Conflict"
+
+	// ServiceExportReasonPortsConflict is used with the "Conflict" condition
+	// when the exported service have a conflict related to ports.
+	ServiceExportReasonPortsConflict ServiceExportConditionReason = "PortsConflict"
+
+	// ServiceExportReasonTypeConflict is used with the "Conflict" condition
+	// when the exported service have a conflict related to type.
+	ServiceExportReasonTypeConflict ServiceExportConditionReason = "TypeConflict"
+
+	// ServiceExportReasonSessionAffinityConflict is used with the "Conflict"
+	// condition when the exported service have a conflict related to session affinity.
+	ServiceExportReasonSessionAffinityConflict ServiceExportConditionReason = "SessionAffinityConflict"
+
+	// ServiceExportReasonSessionAffinityConfigConflict is used with the
+	// "Conflict" condition when the exported service have a conflict related
+	// to session affinity config.
+	ServiceExportReasonSessionAffinityConfigConflict ServiceExportConditionReason = "SessionAffinityConfigConflict"
+
+	// ServiceexportReasonMultipleConflicts is used with the "Conflict"
+	// condition when the exported service have multiple conflicts if the
+	// implementation coalesce those.
+	ServiceExportReasonMultipleConflicts ServiceExportConditionReason = "MultipleConflicts"
+
+	// ServiceExportReasonNoConflicts is used with the "Conflict" condition
+	// when the condition is False.
+	ServiceExportReasonNoConflicts ServiceExportConditionReason = "NoConflicts"
+)