Link to nginx docs

Author: Kate Osborn

apis/v1alpha1/clientsettingspolicy_types.go

@@ -70,7 +70,7 @@ type ClientBody struct {
 	// If the size in a request exceeds the configured value,
 	// the 413 (Request Entity Too Large) error is returned to the client.
 	// Setting size to 0 disables checking of client request body size.
-	// Default: 1m.
+	// Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size.
 	//
 	// +optional
 	MaxSize *Size `json:"maxSize,omitempty"`
@@ -79,7 +79,7 @@ type ClientBody struct {
 	// two successive read operations, not for the transmission of the whole request body.
 	// If a client does not transmit anything within this time, the request is terminated with the
 	// 408 (Request Time-out) error.
-	// Default: 60s.
+	// Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout.
 	//
 	// +optional
 	Timeout *Duration `json:"timeout,omitempty"`
@@ -91,15 +91,15 @@ type ClientKeepAlive struct {
 	// After the maximum number of requests are made, the connection is closed. Closing connections periodically
 	// is necessary to free per-connection memory allocations. Therefore, using too high maximum number of requests
 	// is not recommended as it can lead to excessive memory usage.
-	// Default: 1000.
+	// Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests.
 	//
 	// +optional
 	// +kubebuilder:validation:Minimum=0
 	Requests *int32 `json:"requests,omitempty"`
 
 	// Time defines the maximum time during which requests can be processed through one keep-alive connection.
 	// After this time is reached, the connection is closed following the subsequent request processing.
-	// Default: 1h.
+	// Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_time.
 	//
 	// +optional
 	Time *Duration `json:"time,omitempty"`
@@ -111,16 +111,17 @@ type ClientKeepAlive struct {
 }
 
 // ClientKeepAliveTimeout defines the timeouts related to keep-alive client connections.
+// Default: Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout.
 type ClientKeepAliveTimeout struct {
 	// Server sets the timeout during which a keep-alive client connection will stay open on the server side.
 	// Setting this value to 0 disables keep-alive client connections.
-	// Default: 75s.
 	//
 	// +optional
 	Server *Duration `json:"server,omitempty"`
 
 	// Header sets the timeout in the "Keep-Alive: timeout=time" response header field.
 	//
+	//
 	// +optional
 	Header *Duration `json:"header,omitempty"`
 }

config/crd/bases/gateway.nginx.org_clientsettingspolicies.yaml

@@ -60,7 +60,7 @@ spec:
                       If the size in a request exceeds the configured value,
                       the 413 (Request Entity Too Large) error is returned to the client.
                       Setting size to 0 disables checking of client request body size.
-                      Default: 1m.
+                      Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size.
                     pattern: ^\d{1,4}(k|m|g)?$
                     type: string
                   timeout:
@@ -69,7 +69,7 @@ spec:
                       two successive read operations, not for the transmission of the whole request body.
                       If a client does not transmit anything within this time, the request is terminated with the
                       408 (Request Time-out) error.
-                      Default: 60s.
+                      Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout.
                     pattern: ^\d{1,4}(ms|s)?$
                     type: string
                 type: object
@@ -82,15 +82,15 @@ spec:
                       After the maximum number of requests are made, the connection is closed. Closing connections periodically
                       is necessary to free per-connection memory allocations. Therefore, using too high maximum number of requests
                       is not recommended as it can lead to excessive memory usage.
-                      Default: 1000.
+                      Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests.
                     format: int32
                     minimum: 0
                     type: integer
                   time:
                     description: |-
                       Time defines the maximum time during which requests can be processed through one keep-alive connection.
                       After this time is reached, the connection is closed following the subsequent request processing.
-                      Default: 1h.
+                      Default: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_time.
                     pattern: ^\d{1,4}(ms|s)?$
                     type: string
                   timeout:
@@ -105,7 +105,6 @@ spec:
                         description: |-
                           Server sets the timeout during which a keep-alive client connection will stay open on the server side.
                           Setting this value to 0 disables keep-alive client connections.
-                          Default: 75s.
                         pattern: ^\d{1,4}(ms|s)?$
                         type: string
                     type: object