Renames Pool v1 FailMode Types

Signed-off-by: Daneyon Hansen <[email protected]>

Author: danehans

api/v1/inferencepool_types.go

@@ -35,8 +35,10 @@ type InferencePool struct {
 	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
+	// Spec defines the desired state of the InferencePool.
+	//
 	// +required
-	Spec InferencePoolSpec `json:"spec,omitzero"`
+	Spec InferencePoolSpec `json:"spec"`
 
 	// Status defines the observed state of the InferencePool.
 	//
@@ -45,7 +47,7 @@ type InferencePool struct {
 	Status InferencePoolStatus `json:"status,omitempty"`
 }
 
-// InferencePoolList contains a list of InferencePool.
+// InferencePoolList contains a list InferencePools.
 //
 // +kubebuilder:object:root=true
 type InferencePoolList struct {
@@ -54,7 +56,7 @@ type InferencePoolList struct {
 	Items           []InferencePool `json:"items"`
 }
 
-// InferencePoolSpec defines the desired state of InferencePool
+// InferencePoolSpec defines the desired state of the InferencePool.
 type InferencePoolSpec struct {
 	// Selector determines which Pods are members of this inference pool.
 	// It matches Pods by their labels only within the same namespace; cross-namespace
@@ -65,19 +67,22 @@ type InferencePoolSpec struct {
 	// this configuration into a Service resource.
 	//
 	// +required
-	Selector LabelSelector `json:"selector,omitempty,omitzero"`
+	Selector LabelSelector `json:"selector"`
 
 	// TargetPorts defines a list of ports that are exposed by this InferencePool.
 	// Currently, the list may only include a single port definition.
+	//
 	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:MaxItems=1
 	// +listType=atomic
 	// +required
-	TargetPorts []Port `json:"targetPorts,omitempty"`
+	TargetPorts []Port `json:"targetPorts"`
 
-	// EndpointPickerRef configures an endpoint picker as an extension service.
+	// EndpointPickerRef is a reference to the Endpoint Picker extension and its
+	// associated configuration.
+	//
 	// +required
-	EndpointPickerRef EndpointPickerRef `json:"endpointPickerRef,omitempty,omitzero"`
+	EndpointPickerRef EndpointPickerRef `json:"endpointPickerRef"`
 }
 
 // Port defines the network port that will be exposed by this InferencePool.
@@ -86,21 +91,22 @@ type Port struct {
 	// The number must be in the range 1 to 65535.
 	//
 	// +required
-	Number PortNumber `json:"number,omitempty"`
+	Number PortNumber `json:"number"`
 }
 
-// Extension specifies how to configure an extension that runs the endpoint picker.
+// EndpointPickerRef specifies a reference to an Endpoint Picker extension and its
+// associated configuration.
 type EndpointPickerRef struct {
-	// Group is the group of the referent.
-	// The default value is "", representing the Core API group.
+	// Group is the group of the referent API object. When unspecified, the default value
+	// is "", representing the Core API group.
 	//
 	// +optional
 	// +kubebuilder:default=""
 	Group *Group `json:"group,omitempty"`
 
 	// Kind is the Kubernetes resource kind of the referent.
 	//
-	// Required if the referent is ambiguous(e.g. service with one port is unambiguous).
+	// Required if the referent is ambiguous, e.g. service with multiple ports.
 	//
 	// Defaults to "Service" when not specified.
 	//
@@ -112,40 +118,42 @@ type EndpointPickerRef struct {
 	//
 	// +optional
 	// +kubebuilder:default=Service
-	Kind Kind `json:"kind,omitempty"`
+	Kind *Kind `json:"kind,omitempty"`
 
-	// Name is the name of the referent.
+	// Name is the name of the referent API object.
 	//
 	// +required
-	Name ObjectName `json:"name,omitempty"`
+	Name ObjectName `json:"name"`
 
-	// The port number on the service running the extension. When unspecified,
-	// implementations SHOULD infer a default value of 9002 when the Kind is
-	// Service.
+	// PortNumber is the port number of the Endpoint Picker extension service. When unspecified,
+	// implementations SHOULD infer a default value of 9002 when the kind field is "Service" or
+	// unspecified (defaults to "Service").
 	//
 	// +optional
 	//nolint:kubeapilinter // ignore kubeapilinter here as we want to use pointer here as 0 usually means all ports.
 	PortNumber *PortNumber `json:"portNumber,omitempty"`
 
-	// Configures how the parent handles the case when the extension is not responsive.
-	// Defaults to failClose.
+	// FailureMode configures how the parent handles the case when the Endpoint Picker extension
+	// is non-responsive. When unspecified, defaults to "FailClose".
 	//
 	// +optional
 	// +kubebuilder:default="FailClose"
-	FailureMode ExtensionFailureMode `json:"failureMode,omitempty"`
+	FailureMode *EndpointPickerFailureMode `json:"failureMode,omitempty"`
 }
 
-// ExtensionFailureMode defines the options for how the parent handles the case when the extension is not
-// responsive.
+// EndpointPickerFailureMode defines the options for how the parent handles the case when the
+// Endpoint Picker extension is non-responsive.
+//
 // +kubebuilder:validation:Enum=FailOpen;FailClose
-type ExtensionFailureMode string
+type EndpointPickerFailureMode string
 
 const (
-	// FailOpen specifies that the proxy should forward the request to an endpoint of its picking when
-	// the Endpoint Picker fails.
-	FailOpen ExtensionFailureMode = "FailOpen"
-	// FailClose specifies that the proxy should drop the request when the Endpoint Picker fails.
-	FailClose ExtensionFailureMode = "FailClose"
+	// EndpointPickerFailOpen specifies that the parent should forward the request to an endpoint
+	// of its picking when the Endpoint Picker extension fails.
+	EndpointPickerFailOpen EndpointPickerFailureMode = "FailOpen"
+	// EndpointPickerFailClose specifies that the parent should drop the request when the Endpoint
+	// Picker extension fails.
+	EndpointPickerFailClose EndpointPickerFailureMode = "FailClose"
 )
 
 // InferencePoolStatus defines the observed state of the InferencePool.
@@ -190,7 +198,7 @@ type ParentStatus struct {
 	// resource, such as a Gateway.
 	//
 	// +required
-	ParentRef ParentReference `json:"parentRef,omitzero"`
+	ParentRef ParentReference `json:"parentRef"`
 }
 
 // InferencePoolConditionType is a type of status condition for the InferencePool.
@@ -205,7 +213,7 @@ const (
 	//
 	// Possible reasons for this condition to be True are:
 	//
-	// * "Accepted"
+	// * "SupportedByParent"
 	//
 	// Possible reasons for this condition to be False are:
 	//
@@ -221,8 +229,9 @@ const (
 	InferencePoolConditionAccepted InferencePoolConditionType = "Accepted"
 
 	// InferencePoolReasonAccepted is a reason used with the "Accepted" condition
-	// when the InferencePool has been accepted by the Parent.
-	InferencePoolReasonAccepted InferencePoolReason = "Accepted"
+	// when the InferencePool is accepted by a Parent because the Parent supports
+	// InferencePool as a backend.
+	InferencePoolReasonAccepted InferencePoolReason = "SupportedByParent"
 
 	// InferencePoolReasonNotSupportedByParent is a reason used with the "Accepted"
 	// condition when the InferencePool has not been accepted by a Parent because

api/v1/shared_types.go

@@ -132,11 +132,12 @@ type LabelValue string
 // LabelSelector defines a query for resources based on their labels.
 // This simplified version uses only the matchLabels field.
 type LabelSelector struct {
-	// matchLabels contains a set of required {key,value} pairs.
+	// MatchLabels contains a set of required {key,value} pairs.
 	// An object must match every label in this map to be selected.
 	// The matching logic is an AND operation on all entries.
 	//
 	// +required
+	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:MaxItems=64
-	MatchLabels map[LabelKey]LabelValue `json:"matchLabels,omitempty" protobuf:"bytes,1,rep,name=matchLabels"`
+	MatchLabels map[LabelKey]LabelValue `json:"matchLabels"`
 }

api/v1/zz_generated.deepcopy.go

@@ -24,6 +24,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	runtime "k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/utils/ptr"
 
 	v1 "sigs.k8s.io/gateway-api-inference-extension/api/v1"
 )
@@ -106,7 +107,7 @@ func convertStatusToV1(src *InferencePoolStatus) (*v1.InferencePoolStatus, error
 		return nil, err
 	}
 
-	// v1alpha2 uses json:"parent" (singular), v1 uses json:"parents"
+	// v1alpha2 used json:"parent" (singular) v1 uses json:"parents"
 	if v, ok := u.Object["parent"]; ok {
 		u.Object["parents"] = v
 		delete(u.Object, "parent")
@@ -116,6 +117,17 @@ func convertStatusToV1(src *InferencePoolStatus) (*v1.InferencePoolStatus, error
 	if err != nil {
 		return nil, err
 	}
+
+	// Map condition reason string: "Accepted" (v1alpha2) -> "SupportedByParent" (v1)
+	for i := range out.Parents {
+		for j := range out.Parents[i].Conditions {
+			c := &out.Parents[i].Conditions[j]
+			if c.Type == string(v1.InferencePoolConditionAccepted) &&
+				c.Reason == string(InferencePoolReasonAccepted) {
+				c.Reason = string(v1.InferencePoolReasonAccepted)
+			}
+		}
+	}
 	return out, nil
 }
 
@@ -128,7 +140,7 @@ func convertStatusFromV1(src *v1.InferencePoolStatus) (*InferencePoolStatus, err
 		return nil, err
 	}
 
-	// v1 uses json:"parents", v1alpha2 uses json:"parent" (singular)
+	// v1 uses json:"parents"; v1alpha2 used json:"parent" (singular)
 	if v, ok := u.Object["parents"]; ok {
 		u.Object["parent"] = v
 		delete(u.Object, "parents")
@@ -138,6 +150,17 @@ func convertStatusFromV1(src *v1.InferencePoolStatus) (*InferencePoolStatus, err
 	if err != nil {
 		return nil, err
 	}
+
+	// Map condition reason string: "SupportedByParent" (v1) -> "Accepted" (v1alpha2)
+	for i := range out.Parents {
+		for j := range out.Parents[i].Conditions {
+			c := &out.Parents[i].Conditions[j]
+			if c.Type == string(v1.InferencePoolConditionAccepted) &&
+				c.Reason == string(v1.InferencePoolReasonAccepted) {
+				c.Reason = string(InferencePoolReasonAccepted)
+			}
+		}
+	}
 	return out, nil
 }
 
@@ -147,19 +170,17 @@ func convertExtensionRefToV1(src *Extension) (v1.EndpointPickerRef, error) {
 		return endpointPickerRef, errors.New("src cannot be nil")
 	}
 	if src.Group != nil {
-		v1Group := v1.Group(*src.Group)
-		endpointPickerRef.Group = &v1Group
+		endpointPickerRef.Group = ptr.To(v1.Group(*src.Group))
 	}
 	if src.Kind != nil {
-		endpointPickerRef.Kind = v1.Kind(*src.Kind)
+		endpointPickerRef.Kind = ptr.To(v1.Kind(*src.Kind))
 	}
 	endpointPickerRef.Name = v1.ObjectName(src.Name)
 	if src.PortNumber != nil {
-		v1PortNumber := v1.PortNumber(*src.PortNumber)
-		endpointPickerRef.PortNumber = &v1PortNumber
+		endpointPickerRef.PortNumber = ptr.To(v1.PortNumber(*src.PortNumber))
 	}
 	if src.FailureMode != nil {
-		endpointPickerRef.FailureMode = v1.ExtensionFailureMode(*src.FailureMode)
+		endpointPickerRef.FailureMode = ptr.To(v1.EndpointPickerFailureMode(*src.FailureMode))
 	}
 
 	return endpointPickerRef, nil
@@ -171,21 +192,17 @@ func convertEndpointPickerRefFromV1(src *v1.EndpointPickerRef) (Extension, error
 		return extension, errors.New("src cannot be nil")
 	}
 	if src.Group != nil {
-		group := Group(*src.Group)
-		extension.Group = &group
+		extension.Group = ptr.To(Group(*src.Group))
 	}
-	if src.Kind != "" {
-		kind := Kind(src.Kind)
-		extension.Kind = &kind
+	if src.Kind != nil {
+		extension.Kind = ptr.To(Kind(*src.Kind))
 	}
 	extension.Name = ObjectName(src.Name)
 	if src.PortNumber != nil {
-		portNumber := PortNumber(*src.PortNumber)
-		extension.PortNumber = &portNumber
+		extension.PortNumber = ptr.To(PortNumber(*src.PortNumber))
 	}
-	if src.FailureMode != "" {
-		extensionFailureMode := ExtensionFailureMode(src.FailureMode)
-		extension.FailureMode = &extensionFailureMode
+	if src.FailureMode != nil {
+		extension.FailureMode = ptr.To(ExtensionFailureMode(*src.FailureMode))
 	}
 	return extension, nil
 }

apix/v1alpha2/inferencepool_conversion.go

@@ -33,7 +33,7 @@ var (
 
 	v1Group       = v1.Group("my-group")
 	v1Kind        = v1.Kind("MyKind")
-	v1FailureMode = v1.ExtensionFailureMode("Deny")
+	v1FailureMode = v1.EndpointPickerFailureMode("Deny")
 	v1PortNumber  = v1.PortNumber(9000)
 )
 
@@ -102,10 +102,10 @@ func TestInferencePoolConvertTo(t *testing.T) {
 					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 					EndpointPickerRef: v1.EndpointPickerRef{
 						Group:       &v1Group,
-						Kind:        v1Kind,
+						Kind:        &v1Kind,
 						Name:        "my-epp-service",
 						PortNumber:  &v1PortNumber,
-						FailureMode: v1FailureMode,
+						FailureMode: &v1FailureMode,
 					},
 				},
 				Status: v1.InferencePoolStatus{
@@ -311,10 +311,10 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 					EndpointPickerRef: v1.EndpointPickerRef{
 						Group:       &v1Group,
-						Kind:        v1Kind,
+						Kind:        &v1Kind,
 						Name:        "my-epp-service",
 						PortNumber:  &v1PortNumber,
-						FailureMode: v1FailureMode,
+						FailureMode: &v1FailureMode,
 					},
 				},
 				Status: v1.InferencePoolStatus{