add kubebuilder annotations for upstream type and hashon validation

Author: kayx23

api/v2/apisixupstream_types.go

@@ -171,9 +171,14 @@ type LoadBalancer struct {
 	// Type specifies the load balancing algorithms.
 	// Default is `roundrobin`.
 	// Can be `roundrobin`, `chash`, `ewma`, or `least_conn`.
+	// +kubebuilder:validation:Enum=roundrobin;chash;ewma;least_conn;
+	// +kubebuilder:default=roundrobin
+	// +kubebuilder:validation:Required
 	Type string `json:"type" yaml:"type"`
 	// HashOn specified the type of field used for hashing, required when type is `chash`.
 	// Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`.
+	// +kubebuilder:validation:Enum=vars;header;cookie;consumer;vars_combinations;
+	// +kubebuilder:default=vars
 	HashOn string `json:"hashOn,omitempty" yaml:"hashOn,omitempty"`
 	// Key is used with HashOn, generally required when type is `chash`.
 	// When HashOn is `header` or `cookie`, specifies the name of the header or cookie.

config/crd/bases/apisix.apache.org_apisixupstreams.yaml

@@ -264,23 +264,36 @@ spec:
                   The default strategy is round-robin.
                 properties:
                   hashOn:
+                    default: vars
                     description: |-
                       HashOn specified the type of field used for hashing, required when type is `chash`.
                       Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`.
+                    enum:
+                    - vars
+                    - header
+                    - cookie
+                    - consumer
+                    - vars_combinations
                     type: string
                   key:
                     description: |-
-                      Key is used with HashOn, generally required when Type is `chash`.
+                      Key is used with HashOn, generally required when type is `chash`.
                       When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
                       When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
                       When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of
                       [built-in variables](/enterprise/reference/built-in-variables).
                     type: string
                   type:
+                    default: roundrobin
                     description: |-
                       Type specifies the load balancing algorithms.
                       Default is `roundrobin`.
                       Can be `roundrobin`, `chash`, `ewma`, or `least_conn`.
+                    enum:
+                    - roundrobin
+                    - chash
+                    - ewma
+                    - least_conn
                     type: string
                 required:
                 - type
@@ -498,23 +511,36 @@ spec:
                         The default strategy is round-robin.
                       properties:
                         hashOn:
+                          default: vars
                           description: |-
                             HashOn specified the type of field used for hashing, required when type is `chash`.
                             Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`.
+                          enum:
+                          - vars
+                          - header
+                          - cookie
+                          - consumer
+                          - vars_combinations
                           type: string
                         key:
                           description: |-
-                            Key is used with HashOn, generally required when Type is `chash`.
+                            Key is used with HashOn, generally required when type is `chash`.
                             When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
                             When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
                             When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of
                             [built-in variables](/enterprise/reference/built-in-variables).
                           type: string
                         type:
+                          default: roundrobin
                           description: |-
                             Type specifies the load balancing algorithms.
                             Default is `roundrobin`.
                             Can be `roundrobin`, `chash`, `ewma`, or `least_conn`.
+                          enum:
+                          - roundrobin
+                          - chash
+                          - ewma
+                          - least_conn
                           type: string
                       required:
                       - type

config/crd/bases/apisix.apache.org_backendtrafficpolicies.yaml

@@ -62,7 +62,7 @@ spec:
                     type: string
                   key:
                     description: |-
-                      Key is used with HashOn, generally required when Type is `chash`.
+                      Key is used with HashOn, generally required when type is `chash`.
                       When HashOn is `header` or `cookie`, specifies the name of the header or cookie.
                       When HashOn is `consumer`, key is not required, as the consumer name is used automatically.
                       When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of

docs/crd/api.md

@@ -366,7 +366,7 @@ LoadBalancer describes the load balancing parameters.
 | --- | --- |
 | `type` _string_ | Type specifies the load balancing algorithms. Default is `roundrobin`. Can be `roundrobin`, `chash`, `ewma`, or `least_conn`. |
 | `hashOn` _string_ | HashOn specified the type of field used for hashing, required when type is `chash`. Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
-| `key` _string_ | Key is used with HashOn, generally required when Type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
+| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
 
 
 _Appears in:_
@@ -1473,7 +1473,7 @@ LoadBalancer defines the load balancing strategy for distributing traffic across
 | --- | --- |
 | `type` _string_ | Type specifies the load balancing algorithms. Default is `roundrobin`. Can be `roundrobin`, `chash`, `ewma`, or `least_conn`. |
 | `hashOn` _string_ | HashOn specified the type of field used for hashing, required when type is `chash`. Default is `vars`. Can be `vars`, `header`, `cookie`, `consumer`, or `vars_combinations`. |
-| `key` _string_ | Key is used with HashOn, generally required when Type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
+| `key` _string_ | Key is used with HashOn, generally required when type is `chash`. When HashOn is `header` or `cookie`, specifies the name of the header or cookie. When HashOn is `consumer`, key is not required, as the consumer name is used automatically. When HashOn is `vars` or `vars_combinations`, key refers to one or a combination of [built-in variables](/enterprise/reference/built-in-variables). |
 
 
 _Appears in:_