Makes ControllerName optional

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

Author: danehans

api/v1/inferencepool_types.go

@@ -213,13 +213,12 @@ type ParentStatus struct {
 	//
 	//  https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 	//
-	// Controllers MUST populate this field when writing status. Controllers should ensure that
-	// entries to status populated with their ControllerName are cleaned up when they are no
-	// longer necessary.
+	// Controllers MAY populate this field when writing status. When populating this field, controllers
+	// should ensure that entries to status populated with their ControllerName are cleaned up when they
+	// are no longer necessary.
 	//
-	// +required
-	//nolint:kubeapilinter // should not have omitempty since the field is required
-	ControllerName ControllerName `json:"controllerName"`
+	// +optional
+	ControllerName ControllerName `json:"controllerName,omitempty"`
 }
 
 // ControllerName is the name of a controller that manages ParentStatus. It must be a domain prefixed

config/crd/bases/inference.networking.k8s.io_inferencepools.yaml

@@ -283,9 +283,9 @@ spec:
 
                          https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 
-                        Controllers MUST populate this field when writing status. Controllers should ensure that
-                        entries to status populated with their ControllerName are cleaned up when they are no
-                        longer necessary.
+                        Controllers MAY populate this field when writing status. When populating this field, controllers
+                        should ensure that entries to status populated with their ControllerName are cleaned up when they
+                        are no longer necessary.
                       maxLength: 253
                       minLength: 1
                       pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
@@ -336,7 +336,6 @@ spec:
                       - name
                       type: object
                   required:
-                  - controllerName
                   - parentRef
                   type: object
                 maxItems: 32

config/crd/bases/inference.networking.x-k8s.io_inferencepoolimports.yaml

@@ -248,9 +248,9 @@ spec:
 
                                https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 
-                              Controllers MUST populate this field when writing status. Controllers should ensure that
-                              entries to status populated with their ControllerName are cleaned up when they are no
-                              longer necessary.
+                              Controllers MAY populate this field when writing status. When populating this field, controllers
+                              should ensure that entries to status populated with their ControllerName are cleaned up when they
+                              are no longer necessary.
                             maxLength: 253
                             minLength: 1
                             pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$
@@ -302,7 +302,6 @@ spec:
                             - name
                             type: object
                         required:
-                        - controllerName
                         - parentRef
                         type: object
                       type: array

site-src/reference/spec.md

@@ -355,7 +355,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | Conditions is a list of status conditions that provide information about the observed<br />state of the InferencePool. This field is required to be set by the controller that<br />manages the InferencePool.<br />Supported condition types are:<br />* "Accepted"<br />* "ResolvedRefs" |  | MaxItems: 8 <br /> |
 | `parentRef` _[ParentReference](#parentreference)_ | ParentRef is used to identify the parent resource that this status<br />is associated with. It is used to match the InferencePool with the parent<br />resource, such as a Gateway. |  |  |
-| `controllerName` _[ControllerName](#controllername)_ | ControllerName is a domain/path string that indicates the name of the controller that<br />wrote this status. This corresponds with the GatewayClass controllerName field when the<br />parentRef references a Gateway kind.<br />Example: "example.net/gateway-controller".<br />The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names:<br /> https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names<br />Controllers MUST populate this field when writing status. Controllers should ensure that<br />entries to status populated with their ControllerName are cleaned up when they are no<br />longer necessary. |  | MaxLength: 253 <br />MinLength: 1 <br />Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` <br /> |
+| `controllerName` _[ControllerName](#controllername)_ | ControllerName is a domain/path string that indicates the name of the controller that<br />wrote this status. This corresponds with the GatewayClass controllerName field when the<br />parentRef references a Gateway kind.<br />Example: "example.net/gateway-controller".<br />The format of this field is DOMAIN "/" PATH, where DOMAIN and PATH are valid Kubernetes names:<br /> https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names<br />Controllers MAY populate this field when writing status. When populating this field, controllers<br />should ensure that entries to status populated with their ControllerName are cleaned up when they<br />are no longer necessary. |  | MaxLength: 253 <br />MinLength: 1 <br />Pattern: `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\/[A-Za-z0-9\/\-._~%!$&'()*+,;=:]+$` <br /> |
 
 
 #### Port

site-src/reference/x-v1a1-spec.md

@@ -38,12 +38,12 @@ ControllerName is the name of a controller that manages a resource. It must be a
 
 Valid values include:
 
- * "example.com/bar"
+  - "example.com/bar"
 
 Invalid values include:
 
- * "example.com" - must include path
- * "foo.example.com" - must include path
+  - "example.com" - must include path
+  - "foo.example.com" - must include path
 
 _Validation:_
 - MaxLength: 253