Move validation to crd level

Author: AlexFenlon

config/crd/bases/k8s.nginx.org_virtualserverroutes.yaml

@@ -879,8 +879,11 @@ spec:
                         ConfigMap key.'
                       type: string
                     client-body-buffer-size:
-                      description: Sets the size of the buffer used for reading the
-                        client request body.
+                      description: |-
+                        ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by:
+                        'k' for kilobytes or 'm' for megabytes.
+                        Examples: "10m" or "512k".
+                      pattern: ^[0-9]+[kmg]$
                       type: string
                     client-max-body-size:
                       description: Sets the maximum allowed size of the client request

config/crd/bases/k8s.nginx.org_virtualservers.yaml

@@ -1068,8 +1068,11 @@ spec:
                         ConfigMap key.'
                       type: string
                     client-body-buffer-size:
-                      description: Sets the size of the buffer used for reading the
-                        client request body.
+                      description: |-
+                        ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by:
+                        'k' for kilobytes or 'm' for megabytes.
+                        Examples: "10m" or "512k".
+                      pattern: ^[0-9]+[kmg]$
                       type: string
                     client-max-body-size:
                       description: Sets the maximum allowed size of the client request

deploy/crds.yaml

@@ -1917,8 +1917,11 @@ spec:
                         ConfigMap key.'
                       type: string
                     client-body-buffer-size:
-                      description: Sets the size of the buffer used for reading the
-                        client request body.
+                      description: |-
+                        ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by:
+                        'k' for kilobytes or 'm' for megabytes.
+                        Examples: "10m" or "512k".
+                      pattern: ^[0-9]+[kmg]$
                       type: string
                     client-max-body-size:
                       description: Sets the maximum allowed size of the client request
@@ -3340,8 +3343,11 @@ spec:
                         ConfigMap key.'
                       type: string
                     client-body-buffer-size:
-                      description: Sets the size of the buffer used for reading the
-                        client request body.
+                      description: |-
+                        ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by:
+                        'k' for kilobytes or 'm' for megabytes.
+                        Examples: "10m" or "512k".
+                      pattern: ^[0-9]+[kmg]$
                       type: string
                     client-max-body-size:
                       description: Sets the maximum allowed size of the client request

docs/crd/k8s.nginx.org_virtualserverroutes.md

@@ -169,7 +169,7 @@ The `.spec` object supports the following fields:
 | `upstreams[].buffers.number` | `integer` | Configures the number of buffers. The default is set in the proxy-buffers ConfigMap key. |
 | `upstreams[].buffers.size` | `string` | Configures the size of a buffer. The default is set in the proxy-buffers ConfigMap key. |
 | `upstreams[].busy-buffers-size` | `string` | Sets the size of the buffers used for reading a response from the upstream server when the proxy_buffering is enabled. The default is set in the proxy-busy-buffers-size ConfigMap key.' |
-| `upstreams[].client-body-buffer-size` | `string` | Sets the size of the buffer used for reading the client request body. |
+| `upstreams[].client-body-buffer-size` | `string` | ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by: 'k' for kilobytes or 'm' for megabytes. Examples: "10m" or "512k". |
 | `upstreams[].client-max-body-size` | `string` | Sets the maximum allowed size of the client request body. The default is set in the client-max-body-size ConfigMap key. |
 | `upstreams[].connect-timeout` | `string` | The timeout for establishing a connection with an upstream server. The default is specified in the proxy-connect-timeout ConfigMap key. |
 | `upstreams[].fail-timeout` | `string` | The time during which the specified number of unsuccessful attempts to communicate with an upstream server should happen to consider the server unavailable. The default is set in the fail-timeout ConfigMap key. |

docs/crd/k8s.nginx.org_virtualservers.md

@@ -204,7 +204,7 @@ The `.spec` object supports the following fields:
 | `upstreams[].buffers.number` | `integer` | Configures the number of buffers. The default is set in the proxy-buffers ConfigMap key. |
 | `upstreams[].buffers.size` | `string` | Configures the size of a buffer. The default is set in the proxy-buffers ConfigMap key. |
 | `upstreams[].busy-buffers-size` | `string` | Sets the size of the buffers used for reading a response from the upstream server when the proxy_buffering is enabled. The default is set in the proxy-busy-buffers-size ConfigMap key.' |
-| `upstreams[].client-body-buffer-size` | `string` | Sets the size of the buffer used for reading the client request body. |
+| `upstreams[].client-body-buffer-size` | `string` | ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by: 'k' for kilobytes or 'm' for megabytes. Examples: "10m" or "512k". |
 | `upstreams[].client-max-body-size` | `string` | Sets the maximum allowed size of the client request body. The default is set in the client-max-body-size ConfigMap key. |
 | `upstreams[].connect-timeout` | `string` | The timeout for establishing a connection with an upstream server. The default is specified in the proxy-connect-timeout ConfigMap key. |
 | `upstreams[].fail-timeout` | `string` | The time during which the specified number of unsuccessful attempts to communicate with an upstream server should happen to consider the server unavailable. The default is set in the fail-timeout ConfigMap key. |

internal/configs/version2/__snapshots__/templates_test.snap

@@ -3102,7 +3102,6 @@ server {
         proxy_read_timeout 31s;
         proxy_send_timeout 32s;
         client_max_body_size 1m;
-        client_body_buffer_size 8k;
         proxy_max_temp_file_size 1024m;
 
         proxy_buffering on;

internal/configs/version2/templates_test.go

@@ -1609,7 +1609,6 @@ var (
 					ProxyReadTimeout:         "31s",
 					ProxySendTimeout:         "32s",
 					ClientMaxBodySize:        "1m",
-					ClientBodyBufferSize:     "8k",
 					ProxyBuffering:           true,
 					ProxyBuffers:             "8 4k",
 					ProxyBufferSize:          "4k",

pkg/apis/configuration/v1/types.go

@@ -157,7 +157,11 @@ type Upstream struct {
 	ProxyBusyBuffersSize string `json:"busy-buffers-size"`
 	// Sets the maximum allowed size of the client request body. The default is set in the client-max-body-size ConfigMap key.
 	ClientMaxBodySize string `json:"client-max-body-size"`
-	// Sets the size of the buffer used for reading the client request body.
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:validation:Pattern=`^[0-9]+[kmg]$`
+	// ClientBodyBufferSize sets the size of the buffer used for reading the client request body. Must be specified as a number followed by:
+	// 'k' for kilobytes or 'm' for megabytes.
+	// Examples: "10m" or "512k".
 	ClientBodyBufferSize string `json:"client-body-buffer-size"`
 	// The TLS configuration for the Upstream.
 	TLS UpstreamTLS `json:"tls"`