feat: TargetPortNumber int32 to become TargetPorts []Port (#1354)

* TargetPortNumber int32 to become TargetPorts []Port

# Conflicts:
#	api/v1/inferencepool_types.go
#	api/v1/zz_generated.deepcopy.go
#	client-go/applyconfiguration/api/v1/inferencepoolspec.go

# Conflicts:
#	api/v1/zz_generated.deepcopy.go
#	client-go/applyconfiguration/api/v1/inferencepoolspec.go

* partially fix ut

# Conflicts:
#	pkg/epp/controller/inferencepool_reconciler_test.go

* change inferencepool ut temporarily

* change comments

* changed yaml

* added temporary fix

* Update api/v1/inferencepool_types.go

Co-authored-by: Rob Scott <[email protected]>

* fixed ut and e2e to adopt naming change

* added listtype tag

* revert back:

* updated to include list map

* Update site-src/guides/inferencepool-rollout.md

Co-authored-by: Aslak Knutsen <[email protected]>

* rebase

* partially fix conflicts

* rebase with conversion change

* updated generate

* added ut

* rebase main

* fixed merge error

* updated helm chart

* updated message

* updated to use alias

* fixed ut

* merge conflicts

* fixed kubectl cli linter

* make it back to pointer

* fixed kal linter

* fixed conversion

* revert v1a2 to use pointer

* change extension to be non-nil pointer

* make v1a2 the extension

* added godocs

* updated comments

* updated comments

* updated conversion

* added nil check

* added nil check

* fixed linter

---------

Co-authored-by: Rob Scott <[email protected]>
Co-authored-by: Aslak Knutsen <[email protected]>

Author: 3 people

api/v1/inferencepool_types.go

@@ -66,19 +66,29 @@ type InferencePoolSpec struct {
 	// +required
 	Selector LabelSelector `json:"selector,omitempty,omitzero"`
 
-	// TargetPortNumber defines the port number to access the selected model server Pods.
-	// The number must be in the range 1 to 65535.
-	//
-	// +kubebuilder:validation:Minimum=1
-	// +kubebuilder:validation:Maximum=65535
+	// 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=map
+	// +listMapKey=number
 	// +required
-	TargetPortNumber int32 `json:"targetPortNumber,omitempty"`
+	TargetPorts []Port `json:"targetPorts,omitempty"`
 
 	// Extension configures an endpoint picker as an extension service.
-	// +optional
+	// +required
 	ExtensionRef Extension `json:"extensionRef,omitempty,omitzero"`
 }
 
+// Port defines the network port that will be exposed by this InferencePool.
+type Port struct {
+	// Number defines the port number to access the selected model server Pods.
+	// The number must be in the range 1 to 65535.
+	//
+	// +required
+	Number PortNumber `json:"number,omitempty"`
+}
+
 // Extension specifies how to configure an extension that runs the endpoint picker.
 type Extension struct {
 	// Group is the group of the referent.

api/v1/zz_generated.deepcopy.go

@@ -31,7 +31,7 @@ func (src *InferencePool) ConvertTo(dst *v1.InferencePool) error {
 	if dst == nil {
 		return errors.New("dst cannot be nil")
 	}
-	v1Extension, err := convertExtensionRefToV1(src.Spec.ExtensionRef)
+	v1Extension, err := convertExtensionRefToV1(&src.Spec.ExtensionRef)
 	if err != nil {
 		return err
 	}
@@ -41,7 +41,7 @@ func (src *InferencePool) ConvertTo(dst *v1.InferencePool) error {
 	}
 	dst.TypeMeta = src.TypeMeta
 	dst.ObjectMeta = src.ObjectMeta
-	dst.Spec.TargetPortNumber = src.Spec.TargetPortNumber
+	dst.Spec.TargetPorts = []v1.Port{{Number: v1.PortNumber(src.Spec.TargetPortNumber)}}
 	dst.Spec.ExtensionRef = v1Extension
 	dst.Status = *v1Status
 	if src.Spec.Selector != nil {
@@ -68,7 +68,7 @@ func (dst *InferencePool) ConvertFrom(src *v1.InferencePool) error {
 	}
 	dst.TypeMeta = src.TypeMeta
 	dst.ObjectMeta = src.ObjectMeta
-	dst.Spec.TargetPortNumber = src.Spec.TargetPortNumber
+	dst.Spec.TargetPortNumber = int32(src.Spec.TargetPorts[0].Number)
 	dst.Spec.ExtensionRef = extensionRef
 	dst.Status = *status
 	if src.Spec.Selector.MatchLabels != nil {
@@ -82,7 +82,7 @@ func (dst *InferencePool) ConvertFrom(src *v1.InferencePool) error {
 
 func convertStatusToV1(src *InferencePoolStatus) (*v1.InferencePoolStatus, error) {
 	if src == nil {
-		return nil, nil
+		return nil, errors.New("src cannot be nil")
 	}
 	u, err := toUnstructured(src)
 	if err != nil {
@@ -93,7 +93,7 @@ func convertStatusToV1(src *InferencePoolStatus) (*v1.InferencePoolStatus, error
 
 func convertStatusFromV1(src *v1.InferencePoolStatus) (*InferencePoolStatus, error) {
 	if src == nil {
-		return nil, nil
+		return nil, errors.New("src cannot be nil")
 	}
 	u, err := toUnstructured(src)
 	if err != nil {
@@ -104,7 +104,7 @@ func convertStatusFromV1(src *v1.InferencePoolStatus) (*InferencePoolStatus, err
 
 func convertExtensionRefToV1(src *Extension) (v1.Extension, error) {
 	if src == nil {
-		return v1.Extension{}, nil
+		return v1.Extension{}, errors.New("src cannot be nil")
 	}
 	u, err := toUnstructured(src)
 	if err != nil {
@@ -117,19 +117,19 @@ func convertExtensionRefToV1(src *Extension) (v1.Extension, error) {
 	return *out, nil
 }
 
-func convertExtensionRefFromV1(src *v1.Extension) (*Extension, error) {
+func convertExtensionRefFromV1(src *v1.Extension) (Extension, error) {
 	if src == nil {
-		return nil, nil
+		return Extension{}, errors.New("src cannot be nil")
 	}
-	u, err := toUnstructured(src)
+	u, err := toUnstructured(&src)
 	if err != nil {
-		return nil, err
+		return Extension{}, err
 	}
 	extension, err := convert[Extension](u)
 	if err != nil {
-		return nil, err
+		return Extension{}, err
 	}
-	return extension, nil
+	return *extension, nil
 }
 
 func toUnstructured(obj any) (*unstructured.Unstructured, error) {

apix/v1alpha2/inferencepool_conversion.go

@@ -60,7 +60,7 @@ func TestInferencePoolConvertTo(t *testing.T) {
 						"app": "my-model-server",
 					},
 					TargetPortNumber: 8080,
-					ExtensionRef: &Extension{
+					ExtensionRef: Extension{
 						Group:       &group,
 						Kind:        &kind,
 						Name:        "my-epp-service",
@@ -99,7 +99,7 @@ func TestInferencePoolConvertTo(t *testing.T) {
 							"app": "my-model-server",
 						},
 					},
-					TargetPortNumber: 8080,
+					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 					ExtensionRef: v1.Extension{
 						Group:       &v1Group,
 						Kind:        v1Kind,
@@ -127,7 +127,7 @@ func TestInferencePoolConvertTo(t *testing.T) {
 			wantErr: false,
 		},
 		{
-			name: "conversion from v1alpha2 to v1 with nil extensionRef",
+			name: "conversion from v1alpha2 to v1 with empty extensionRef",
 			src: &InferencePool{
 				TypeMeta: metav1.TypeMeta{
 					Kind:       "InferencePool",
@@ -174,7 +174,7 @@ func TestInferencePoolConvertTo(t *testing.T) {
 							"app": "my-model-server",
 						},
 					},
-					TargetPortNumber: 8080,
+					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 				},
 				Status: v1.InferencePoolStatus{
 					Parents: []v1.PoolStatus{
@@ -234,7 +234,7 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 							"app": "my-model-server",
 						},
 					},
-					TargetPortNumber: 8080,
+					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 					ExtensionRef: v1.Extension{
 						Group:       &v1Group,
 						Kind:        v1Kind,
@@ -273,7 +273,7 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 						"app": "my-model-server",
 					},
 					TargetPortNumber: 8080,
-					ExtensionRef: &Extension{
+					ExtensionRef: Extension{
 						Group:       &group,
 						Kind:        &kind,
 						Name:        "my-epp-service",
@@ -300,7 +300,7 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 			wantErr: false,
 		},
 		{
-			name: "conversion from v1 to v1alpha2 with nil extensionRef",
+			name: "conversion from v1 to v1alpha2 with empty extensionRef",
 			src: &v1.InferencePool{
 				TypeMeta: metav1.TypeMeta{
 					Kind:       "InferencePool",
@@ -316,7 +316,7 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 							"app": "my-model-server",
 						},
 					},
-					TargetPortNumber: 8080,
+					TargetPorts: []v1.Port{{Number: v1.PortNumber(int32(8080))}},
 				},
 				Status: v1.InferencePoolStatus{
 					Parents: []v1.PoolStatus{
@@ -348,7 +348,6 @@ func TestInferencePoolConvertFrom(t *testing.T) {
 						"app": "my-model-server",
 					},
 					TargetPortNumber: 8080,
-					ExtensionRef:     &Extension{},
 				},
 				Status: InferencePoolStatus{
 					Parents: []PoolStatus{

apix/v1alpha2/inferencepool_conversion_test.go

@@ -70,7 +70,8 @@ type InferencePoolSpec struct {
 	TargetPortNumber int32 `json:"targetPortNumber"`
 
 	// Extension configures an endpoint picker as an extension service.
-	ExtensionRef *Extension `json:"extensionRef,omitempty"`
+	// +required
+	ExtensionRef Extension `json:"extensionRef,omitempty"`
 }
 
 // Extension specifies how to configure an extension that runs the endpoint picker.

apix/v1alpha2/inferencepool_types.go

@@ -148,7 +148,7 @@ var (
 		"The configuration specified as text, in lieu of a file")
 
 	modelServerMetricsPort = flag.Int("model-server-metrics-port", 0, "Port to scrape metrics from pods. "+
-		"Default value will be set to InferencePool.Spec.TargetPortNumber if not set.")
+		"Default value will be set to the InferencePool.Spec.TargetPorts[0].Number if not set.")
 	modelServerMetricsPath                    = flag.String("model-server-metrics-path", "/metrics", "Path to scrape metrics from pods")
 	modelServerMetricsScheme                  = flag.String("model-server-metrics-scheme", "http", "Scheme to scrape metrics from pods")
 	modelServerMetricsHttpsInsecureSkipVerify = flag.Bool("model-server-metrics-https-insecure-skip-verify", true, "When using 'https' scheme for 'model-server-metrics-scheme', configure 'InsecureSkipVerify' (default to true)")