Consistent validation for reference types

Author: robscott

api/v1alpha2/inferencemodel_types.go

@@ -106,25 +106,18 @@ type PoolObjectReference struct {
 	//
 	// +optional
 	// +kubebuilder:default="inference.networking.x-k8s.io"
-	// +kubebuilder:validation:MaxLength=253
-	// +kubebuilder:validation:Pattern=`^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
-	Group string `json:"group,omitempty"`
+	Group Group `json:"group,omitempty"`
 
 	// Kind is kind of the referent. For example "InferencePool".
 	//
 	// +optional
 	// +kubebuilder:default="InferencePool"
-	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=63
-	// +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$`
-	Kind string `json:"kind,omitempty"`
+	Kind Kind `json:"kind,omitempty"`
 
 	// Name is the name of the referent.
 	//
-	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=253
 	// +kubebuilder:validation:Required
-	Name string `json:"name"`
+	Name ObjectName `json:"name"`
 }
 
 // Criticality defines how important it is to serve the model compared to other models.

api/v1alpha2/inferencepool_types.go

@@ -90,11 +90,11 @@ type Extension struct {
 // ExtensionReference is a reference to the extension deployment.
 type ExtensionReference struct {
 	// Group is the group of the referent.
-	// When unspecified or empty string, core API group is inferred.
+	// The default value is "", representing the Core API group.
 	//
 	// +optional
 	// +kubebuilder:default=""
-	Group *string `json:"group,omitempty"`
+	Group *Group `json:"group,omitempty"`
 
 	// Kind is the Kubernetes resource kind of the referent. For example
 	// "Service".
@@ -109,20 +109,19 @@ type ExtensionReference struct {
 	//
 	// +optional
 	// +kubebuilder:default=Service
-	Kind *string `json:"kind,omitempty"`
+	Kind *Kind `json:"kind,omitempty"`
 
 	// Name is the name of the referent.
 	//
 	// +kubebuilder:validation:Required
-	Name string `json:"name"`
+	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.
+	// The port number on the service running the extension. When unspecified,
+	// implementations SHOULD infer a default value of 9002 when the Kind is
+	// Service.
 	//
-	// +kubebuilder:validation:Minimum=1
-	// +kubebuilder:validation:Maximum=65535
 	// +optional
-	PortNumber *int32 `json:"targetPortNumber,omitempty"`
+	PortNumber *PortNumber `json:"portNumber,omitempty"`
 }
 
 // ExtensionConnection encapsulates options that configures the connection to the extension.

api/v1alpha2/shared_types.go

@@ -0,0 +1,67 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha2
+
+// Group refers to a Kubernetes Group. It must either be an empty string or a
+// RFC 1123 subdomain.
+//
+// This validation is based off of the corresponding Kubernetes validation:
+// https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L208
+//
+// Valid values include:
+//
+// * "" - empty string implies core Kubernetes API group
+// * "gateway.networking.k8s.io"
+// * "foo.example.com"
+//
+// Invalid values include:
+//
+// * "example.com/bar" - "/" is an invalid character
+//
+// +kubebuilder:validation:MaxLength=253
+// +kubebuilder:validation:Pattern=`^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
+type Group string
+
+// Kind refers to a Kubernetes Kind.
+//
+// Valid values include:
+//
+// * "Service"
+// * "HTTPRoute"
+//
+// Invalid values include:
+//
+// * "invalid/kind" - "/" is an invalid character
+//
+// +kubebuilder:validation:MinLength=1
+// +kubebuilder:validation:MaxLength=63
+// +kubebuilder:validation:Pattern=`^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$`
+type Kind string
+
+// ObjectName refers to the name of a Kubernetes object.
+// Object names can have a variety of forms, including RFC 1123 subdomains,
+// RFC 1123 labels, or RFC 1035 labels.
+//
+// +kubebuilder:validation:MinLength=1
+// +kubebuilder:validation:MaxLength=253
+type ObjectName string
+
+// PortNumber defines a network port.
+//
+// +kubebuilder:validation:Minimum=1
+// +kubebuilder:validation:Maximum=65535
+type PortNumber int32

api/v1alpha2/zz_generated.deepcopy.go

@@ -56,7 +56,9 @@ spec:
                     default: ""
                     description: |-
                       Group is the group of the referent.
-                      When unspecified or empty string, core API group is inferred.
+                      The default value is "", representing the Core API group.
+                    maxLength: 253
+                    pattern: ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
                     type: string
                   kind:
                     default: Service
@@ -71,14 +73,20 @@ spec:
                       terms of conformance. They also may not be safe to forward to (see
                       CVE-2021-25740 for more information). Implementations MUST NOT
                       support ExternalName Services.
+                    maxLength: 63
+                    minLength: 1
+                    pattern: ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$
                     type: string
                   name:
                     description: Name is the name of the referent.
+                    maxLength: 253
+                    minLength: 1
                     type: string
-                  targetPortNumber:
+                  portNumber:
                     description: |-
-                      The port number on the service running the extension. When unspecified, implementations SHOULD infer a
-                      default value of 9002 when the Kind is Service.
+                      The port number on the service running the extension. When unspecified,
+                      implementations SHOULD infer a default value of 9002 when the Kind is
+                      Service.
                     format: int32
                     maximum: 65535
                     minimum: 1