DevFW-CICD/ingress-nginx-helm
14
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: fix booleans to all have quotes around their values

Browse source 
Signed-off-by: Yoofi Quansah <ybquansah@gmail.com>
This commit is contained in:
Yoofi Quansah 2024-06-18 11:14:12 -05:00
parent e084ad0a5e
commit 7d91e4d9ed
1 changed files with 251 additions and 251 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
docs/user-guide/nginx-configuration/configmap.md
View file

@ -26,11 +26,11 @@ data:
The following table shows a configuration option's name, type, and the default value: The following table shows a configuration option's name, type, and the default value:
| name | type | default | notes | | name | type | default | notes |
|:---|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----| | :------------------------------------------------------------------------------ | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------- |
| [add-headers](#add-headers) | string | "" | | | [add-headers](#add-headers) | string | "" | |
| [allow-backend-server-header](#allow-backend-server-header) | bool | "false" | | | [allow-backend-server-header](#allow-backend-server-header) | bool | "false" | |
| [allow-cross-namespace-resources](#allow-cross-namespace-resources) | bool | "true" | | | [allow-cross-namespace-resources](#allow-cross-namespace-resources) | bool | "true" | |
|[allow-snippet-annotations](#allow-snippet-annotations)| bool | false || | [allow-snippet-annotations](#allow-snippet-annotations) | bool | "false" | |
| [annotations-risk-level](#annotations-risk-level) | string | Critical | | | [annotations-risk-level](#annotations-risk-level) | string | Critical | |
| [annotation-value-word-blocklist](#annotation-value-word-blocklist) | string array | "" | | | [annotation-value-word-blocklist](#annotation-value-word-blocklist) | string array | "" | |
| [hide-headers](#hide-headers) | string array | empty | | | [hide-headers](#hide-headers) | string array | empty | |
@ -47,12 +47,12 @@ The following table shows a configuration option's name, type, and the default v
| [client-header-timeout](#client-header-timeout) | int | 60 | | | [client-header-timeout](#client-header-timeout) | int | 60 | |
| [client-body-buffer-size](#client-body-buffer-size) | string | "8k" | | | [client-body-buffer-size](#client-body-buffer-size) | string | "8k" | |
| [client-body-timeout](#client-body-timeout) | int | 60 | | | [client-body-timeout](#client-body-timeout) | int | 60 | |
|[disable-access-log](#disable-access-log)| bool | false || | [disable-access-log](#disable-access-log) | bool | "false" | |
|[disable-ipv6](#disable-ipv6)| bool | false || | [disable-ipv6](#disable-ipv6) | bool | "false" | |
|[disable-ipv6-dns](#disable-ipv6-dns)| bool | false || | [disable-ipv6-dns](#disable-ipv6-dns) | bool | "false" | |
|[enable-underscores-in-headers](#enable-underscores-in-headers)| bool | false || | [enable-underscores-in-headers](#enable-underscores-in-headers) | bool | "false" | |
|[enable-ocsp](#enable-ocsp)| bool | false || | [enable-ocsp](#enable-ocsp) | bool | "false" | |
|[ignore-invalid-headers](#ignore-invalid-headers)| bool | true || | [ignore-invalid-headers](#ignore-invalid-headers) | bool | "true" | |
| [retry-non-idempotent](#retry-non-idempotent) | bool | "false" | | | [retry-non-idempotent](#retry-non-idempotent) | bool | "false" | |
| [error-log-level](#error-log-level) | string | "notice" | | | [error-log-level](#error-log-level) | string | "notice" | |
| [http2-max-field-size](#http2-max-field-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) | | [http2-max-field-size](#http2-max-field-size) | string | "" | DEPRECATED in favour of [large_client_header_buffers](#large-client-header-buffers) |
@ -199,7 +199,7 @@ The following table shows a configuration option's name, type, and the default v
| [proxy-buffering](#proxy-buffering) | string | "off" | | | [proxy-buffering](#proxy-buffering) | string | "off" | |
| [limit-req-status-code](#limit-req-status-code) | int | 503 | | | [limit-req-status-code](#limit-req-status-code) | int | 503 | |
| [limit-conn-status-code](#limit-conn-status-code) | int | 503 | | | [limit-conn-status-code](#limit-conn-status-code) | int | 503 | |
|[enable-syslog](#enable-syslog)| bool | false || | [enable-syslog](#enable-syslog) | bool | "false" | |
| [syslog-host](#syslog-host) | string | "" | | | [syslog-host](#syslog-host) | string | "" | |
| [syslog-port](#syslog-port) | int | 514 | | | [syslog-port](#syslog-port) | int | 514 | |
| [no-tls-redirect-locations](#no-tls-redirect-locations) | string | "/.well-known/acme-challenge" | | | [no-tls-redirect-locations](#no-tls-redirect-locations) | string | "/.well-known/acme-challenge" | |
@ -244,18 +244,18 @@ Enables the return of the header Server from the backend instead of the generic
Enables users to consume cross namespace resource on annotations, when was previously enabled . _**default:**_ true Enables users to consume cross namespace resource on annotations, when was previously enabled . _**default:**_ true
**Annotations that may be impacted with this change**: **Annotations that may be impacted with this change**:
* `auth-secret`
* `auth-proxy-set-header`
* `auth-tls-secret`
* `fastcgi-params-configmap`
* `proxy-ssl-secret`
- `auth-secret`
- `auth-proxy-set-header`
- `auth-tls-secret`
- `fastcgi-params-configmap`
- `proxy-ssl-secret`
**This option will be defaulted to false in the next major release** **This option will be defaulted to false in the next major release**
## allow-snippet-annotations ## allow-snippet-annotations
Enables Ingress to parse and add *-snippet annotations/directives created by the user. _**default:**_ `false` Enables Ingress to parse and add \*-snippet annotations/directives created by the user. _**default:**_ `false`
Warning: We recommend enabling this option only if you TRUST users with permission to create Ingress objects, as this Warning: We recommend enabling this option only if you TRUST users with permission to create Ingress objects, as this
may allow a user to add restricted configurations to the final nginx.conf file may allow a user to add restricted configurations to the final nginx.conf file
@ -303,21 +303,21 @@ _References:_
Access log path for both http and stream context. Goes to `/var/log/nginx/access.log` by default. Access log path for both http and stream context. Goes to `/var/log/nginx/access.log` by default.
__Note:__ the file `/var/log/nginx/access.log` is a symlink to `/dev/stdout` **Note:** the file `/var/log/nginx/access.log` is a symlink to `/dev/stdout`
## http-access-log-path ## http-access-log-path
Access log path for http context globally. Access log path for http context globally.
_**default:**_ "" _**default:**_ ""
__Note:__ If not specified, the `access-log-path` will be used. **Note:** If not specified, the `access-log-path` will be used.
## stream-access-log-path ## stream-access-log-path
Access log path for stream context globally. Access log path for stream context globally.
_**default:**_ "" _**default:**_ ""
__Note:__ If not specified, the `access-log-path` will be used. **Note:** If not specified, the `access-log-path` will be used.
## enable-access-log-for-default-backend ## enable-access-log-for-default-backend
@ -327,7 +327,7 @@ Enables logging access to default backend. _**default:**_ is disabled.
Error log path. Goes to `/var/log/nginx/error.log` by default. Error log path. Goes to `/var/log/nginx/error.log` by default.
__Note:__ the file `/var/log/nginx/error.log` is a symlink to `/dev/stderr` **Note:** the file `/var/log/nginx/error.log` is a symlink to `/dev/stderr`
_References:_ _References:_
[https://nginx.org/en/docs/ngx_core_module.html#error_log](https://nginx.org/en/docs/ngx_core_module.html#error_log) [https://nginx.org/en/docs/ngx_core_module.html#error_log](https://nginx.org/en/docs/ngx_core_module.html#error_log)
@ -600,8 +600,8 @@ _References:_
## reuse-port ## reuse-port
Instructs NGINX to create an individual listening socket for each worker process (using the SO_REUSEPORT socket option), allowing a kernel to distribute incoming connections between worker processes Instructs NGINX to create an individual listening socket for each worker process (using the SO\*REUSEPORT socket option), allowing a kernel to distribute incoming connections between worker processes
_**default:**_ true **\*default:**\_ true
## proxy-headers-hash-bucket-size ## proxy-headers-hash-bucket-size
@ -633,7 +633,7 @@ DHE-based cyphers will not be available until DH parameter is configured [Custom
Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/). Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/).
__Note:__ ssl_prefer_server_ciphers directive will be enabled by default for http context. **Note:** ssl_prefer_server_ciphers directive will be enabled by default for http context.
## ssl-ecdh-curve ## ssl-ecdh-curve
@ -720,7 +720,7 @@ Enables or disables compression of HTTP responses using the ["gzip" module](http
Enables or disables ["geoip" module](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) that creates variables with values depending on the client IP address, using the precompiled MaxMind databases. Enables or disables ["geoip" module](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) that creates variables with values depending on the client IP address, using the precompiled MaxMind databases.
_**default:**_ true _**default:**_ true
> __Note:__ MaxMind legacy databases are discontinued and will not receive updates after 2019-01-02, cf. [discontinuation notice](https://support.maxmind.com/geolite-legacy-discontinuation-notice/). Consider [use-geoip2](#use-geoip2) below. > **Note:** MaxMind legacy databases are discontinued and will not receive updates after 2019-01-02, cf. [discontinuation notice](https://support.maxmind.com/geolite-legacy-discontinuation-notice/). Consider [use-geoip2](#use-geoip2) below.
## use-geoip2 ## use-geoip2
@ -746,7 +746,7 @@ Enables or disables compression of HTTP responses using the ["brotli" module](ht
The default mime type list to compress is: `application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component`. The default mime type list to compress is: `application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component`.
_**default:**_ false _**default:**_ false
> __Note:__ Brotli does not works in Safari < 11. For more information see [https://caniuse.com/#feat=brotli](https://caniuse.com/#feat=brotli) > **Note:** Brotli does not works in Safari < 11. For more information see [https://caniuse.com/#feat=brotli](https://caniuse.com/#feat=brotli)
## brotli-level ## brotli-level
@ -840,7 +840,6 @@ _**default:**_ 320
_References:_ _References:_
[https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive) [https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive)
## upstream-keepalive-time ## upstream-keepalive-time
Sets the maximum time during which requests can be processed through one keepalive connection. Sets the maximum time during which requests can be processed through one keepalive connection.
@ -857,18 +856,15 @@ Sets a timeout during which an idle keepalive connection to an upstream server w
_References:_ _References:_
[https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout) [https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout)
## upstream-keepalive-requests ## upstream-keepalive-requests
Sets the maximum number of requests that can be served through one keepalive connection. After the maximum number of Sets the maximum number of requests that can be served through one keepalive connection. After the maximum number of
requests is made, the connection is closed. requests is made, the connection is closed.
_**default:**_ 10000 _**default:**_ 10000
_References:_ _References:_
[https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests) [https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests)
## limit-conn-zone-variable ## limit-conn-zone-variable
Sets parameters for a shared memory zone that will keep states for various keys of [limit_conn_zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone). The default of "$binary_remote_addr" variable’s size is always 4 bytes for IPv4 addresses or 16 bytes for IPv6 addresses. Sets parameters for a shared memory zone that will keep states for various keys of [limit_conn_zone](https://nginx.org/en/docs/http/ngx_http_limit_conn_module.html#limit_conn_zone). The default of "$binary_remote_addr" variable’s size is always 4 bytes for IPv4 addresses or 16 bytes for IPv6 addresses.
@ -910,7 +906,7 @@ _References:_
## bind-address ## bind-address
Sets the addresses on which the server will accept requests instead of *. It should be noted that these addresses must exist in the runtime environment or the controller will crash loop. Sets the addresses on which the server will accept requests instead of \*. It should be noted that these addresses must exist in the runtime environment or the controller will crash loop.
## use-forwarded-headers ## use-forwarded-headers
@ -1048,6 +1044,7 @@ Specifies the port to use when uploading traces. _**default:**_ 4317
Specifies the service name to use for any traces created. _**default:**_ nginx Specifies the service name to use for any traces created. _**default:**_ nginx
## opentelemetry-trust-incoming-span: "true" ## opentelemetry-trust-incoming-span: "true"
Enables or disables using spans from incoming requests as parent for created ones. _**default:**_ true Enables or disables using spans from incoming requests as parent for created ones. _**default:**_ true
## otel-sampler-parent-based ## otel-sampler-parent-based
@ -1160,6 +1157,7 @@ Sets the global value of redirects (301) to HTTPS if the server has a TLS certif
_**default:**_ "true" _**default:**_ "true"
## force-ssl-redirect ## force-ssl-redirect
Sets the global value of redirects (308) to HTTPS if the server has a default TLS certificate (defined in extra-args). Sets the global value of redirects (308) to HTTPS if the server has a default TLS certificate (defined in extra-args).
_**default:**_ "false" _**default:**_ "false"
@ -1218,7 +1216,7 @@ Sets the HTTP status code to be used in redirects.
Supported codes are [301](https://developer.mozilla.org/docs/Web/HTTP/Status/301),[302](https://developer.mozilla.org/docs/Web/HTTP/Status/302),[307](https://developer.mozilla.org/docs/Web/HTTP/Status/307) and [308](https://developer.mozilla.org/docs/Web/HTTP/Status/308) Supported codes are [301](https://developer.mozilla.org/docs/Web/HTTP/Status/301),[302](https://developer.mozilla.org/docs/Web/HTTP/Status/302),[307](https://developer.mozilla.org/docs/Web/HTTP/Status/307) and [308](https://developer.mozilla.org/docs/Web/HTTP/Status/308)
_**default:**_ 308 _**default:**_ 308
> __Why the default code is 308?__ > **Why the default code is 308?**
> [RFC 7238](https://tools.ietf.org/html/rfc7238) was created to define the 308 (Permanent Redirect) status code that is similar to 301 (Moved Permanently) but it keeps the payload in the redirect. This is important if we send a redirect in methods like POST. > [RFC 7238](https://tools.ietf.org/html/rfc7238) was created to define the 308 (Permanent Redirect) status code that is similar to 301 (Moved Permanently) but it keeps the payload in the redirect. This is important if we send a redirect in methods like POST.
@ -1356,15 +1354,15 @@ _References:_
## global-rate-limit ## global-rate-limit
* `global-rate-limit-status-code`: configure HTTP status code to return when rejecting requests. Defaults to 429. - `global-rate-limit-status-code`: configure HTTP status code to return when rejecting requests. Defaults to 429.
Configure `memcached` client for [Global Rate Limiting](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#global-rate-limiting). Configure `memcached` client for [Global Rate Limiting](https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#global-rate-limiting).
* `global-rate-limit-memcached-host`: IP/FQDN of memcached server to use. Required to enable Global Rate Limiting. - `global-rate-limit-memcached-host`: IP/FQDN of memcached server to use. Required to enable Global Rate Limiting.
* `global-rate-limit-memcached-port`: port of memcached server to use. Defaults default memcached port of `11211`. - `global-rate-limit-memcached-port`: port of memcached server to use. Defaults default memcached port of `11211`.
* `global-rate-limit-memcached-connect-timeout`: configure timeout for connect, send and receive operations. Unit is millisecond. Defaults to 50ms. - `global-rate-limit-memcached-connect-timeout`: configure timeout for connect, send and receive operations. Unit is millisecond. Defaults to 50ms.
* `global-rate-limit-memcached-max-idle-timeout`: configure timeout for cleaning idle connections. Unit is millisecond. Defaults to 50ms. - `global-rate-limit-memcached-max-idle-timeout`: configure timeout for cleaning idle connections. Unit is millisecond. Defaults to 50ms.
* `global-rate-limit-memcached-pool-size`: configure number of max connections to keep alive. Make sure your `memcached` server can handle - `global-rate-limit-memcached-pool-size`: configure number of max connections to keep alive. Make sure your `memcached` server can handle
`global-rate-limit-memcached-pool-size * worker-processes * <number of ingress-nginx replicas>` simultaneous connections. `global-rate-limit-memcached-pool-size * worker-processes * <number of ingress-nginx replicas>` simultaneous connections.
These settings get used by [lua-resty-global-throttle](https://github.com/ElvinEfendi/lua-resty-global-throttle) These settings get used by [lua-resty-global-throttle](https://github.com/ElvinEfendi/lua-resty-global-throttle)
@ -1384,6 +1382,7 @@ _References:_
[https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_reject_handshake](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_reject_handshake) [https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_reject_handshake](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_reject_handshake)
## debug-connections ## debug-connections
Enables debugging log for selected client connections. Enables debugging log for selected client connections.
_**default:**_ "" _**default:**_ ""
@ -1391,10 +1390,11 @@ _References:_
[http://nginx.org/en/docs/ngx_core_module.html#debug_connection](http://nginx.org/en/docs/ngx_core_module.html#debug_connection) [http://nginx.org/en/docs/ngx_core_module.html#debug_connection](http://nginx.org/en/docs/ngx_core_module.html#debug_connection)
## strict-validate-path-type ## strict-validate-path-type
Ingress objects contains a field called pathType that defines the proxy behavior. It can be `Exact`, `Prefix` and `ImplementationSpecific`. Ingress objects contains a field called pathType that defines the proxy behavior. It can be `Exact`, `Prefix` and `ImplementationSpecific`.
When pathType is configured as `Exact` or `Prefix`, there should be a more strict validation, allowing only paths starting with "/" and When pathType is configured as `Exact` or `Prefix`, there should be a more strict validation, allowing only paths starting with "/" and
containing only alphanumeric characters and "-", "_" and additional "/". containing only alphanumeric characters and "-", "\_" and additional "/".
When this option is enabled, the validation will happen on the Admission Webhook, making any Ingress not using pathType `ImplementationSpecific` When this option is enabled, the validation will happen on the Admission Webhook, making any Ingress not using pathType `ImplementationSpecific`
and containing invalid characters to be denied. and containing invalid characters to be denied.