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

Merge pull request #1747 from diazjf/ssl-cipher

Browse source 
Add config-map usage and options to Documentation
This commit is contained in:
Manuel Alejandro de Brito Fontes 2017-11-23 17:37:37 -03:00 committed by GitHub
commit 4027da3b1a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 198 additions and 153 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
deploy/README.md
View file

@ -14,6 +14,7 @@
- [Using Helm](#using-helm) - [Using Helm](#using-helm)
- [Verify installation](#verify-installation) - [Verify installation](#verify-installation)
- [Detect installed version](#detect-installed-version) - [Detect installed version](#detect-installed-version)
- [Deploying the config-map](#deploying-the-config-map)
## Generic Deployment ## Generic Deployment
@ -235,7 +236,6 @@ kubectl get pods --all-namespaces -l app=ingress-nginx --watch
``` ```
Once the operator pods are running, you can cancel the above command by typing `Ctrl+C`. Once the operator pods are running, you can cancel the above command by typing `Ctrl+C`.
Now, you are ready to create your first ingress. Now, you are ready to create your first ingress.
## Detect installed version ## Detect installed version
@ -247,3 +247,21 @@ POD_NAMESPACE=ingress-nginx
POD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app=ingress-nginx -o jsonpath={.items[0].metadata.name}) POD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app=ingress-nginx -o jsonpath={.items[0].metadata.name})
kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version
``` ```
## Deploying the config-map
A config map can be used to configure system components for the nginx-controller. In order to begin using a config-map
make sure it has been created and is being used in the deployment.
It is created as seen in the [Mandatory Commands](#mandatory-commands) section above.
```console
curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/configmap.yaml \
| kubectl apply -f -
```
and is setup to be used in the deployment [without-rbac](without-rbac.yaml) or [with-rbac](with-rbac.yaml) with the following line:
```yaml
- --configmap=$(POD_NAMESPACE)/nginx-configuration
```
For information on using the config-map, see its [user-guide](../docs/user-guide/configmap.md).

331
docs/user-guide/configmap.md
View file

@ -1,14 +1,25 @@
# NGINX Ingress controller configuration ConfigMap # NGINX Ingress controller configuration ConfigMap
--- ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable.
The ConfigMap API resource stores configuration data as key-value pairs. The data provides the configurations for system
components for the nginx-controller. Before you can begin using a config-map it must be [deployed](../../deploy/README.md/#deploying-the-config-map).
### Logs In order to overwrite nginx-controller configuration values as seen in [config.go](https://github.com/kubernetes/ingress-nginx/blob/master/internal/ingress/controller/config/config.go),
you can add key-value pairs to the data section of the config-map. For Example:
#### disable-access-log ```yaml
data:
map-hash-bucket-size: "128"
ssl-protocols: SSLv2
```
## Logs
### disable-access-log
Disables the Access Log from the entire Ingress Controller. This is 'false' by default. Disables the Access Log from the entire Ingress Controller. This is 'false' by default.
#### access-log-path ### access-log-path
Access log path. Goes to '/var/log/nginx/access.log' by default. Access log path. Goes to '/var/log/nginx/access.log' by default.
@ -16,7 +27,7 @@ _References:_
- http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log - http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log
#### error-log-level ### error-log-level
Configures the logging level of errors. Log levels above are listed in the order of increasing severity. Configures the logging level of errors. Log levels above are listed in the order of increasing severity.
@ -24,7 +35,7 @@ _References:_
- http://nginx.org/en/docs/ngx_core_module.html#error_log - http://nginx.org/en/docs/ngx_core_module.html#error_log
#### error-log-path ### error-log-path
Error log path. Goes to '/var/log/nginx/error.log' by default. Error log path. Goes to '/var/log/nginx/error.log' by default.
@ -32,11 +43,11 @@ _References:_
- http://nginx.org/en/docs/ngx_core_module.html#error_log - http://nginx.org/en/docs/ngx_core_module.html#error_log
#### log-format-stream ### log-format-stream
Sets the nginx [stream format](https://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format). Sets the nginx [stream format](https://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format).
#### log-format-upstream ### log-format-upstream
Sets the nginx [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format). Sets the nginx [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format).
Example for json output: Example for json output:
@ -53,15 +64,14 @@ log-format-upstream: '{ "time": "$time_iso8601", "remote_addr": "$proxy_protocol
Please check [log-format](log-format.md) for definition of each field. Please check [log-format](log-format.md) for definition of each field.
#### log-format-escape-json ### log-format-escape-json
Sets if the escape parameter allows JSON (true) or default characters escaping in variables (false) Sets if the escape parameter allows JSON (true) or default characters escaping in variables (false)
Sets the nginx [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format). Sets the nginx [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format).
### Proxy configuration ## Proxy configuration
#### load-balance ### load-balance
Sets the algorithm to use for load balancing. Sets the algorithm to use for load balancing.
The value can either be: The value can either be:
@ -76,108 +86,103 @@ _References:_
- http://nginx.org/en/docs/http/load_balancing.html. - http://nginx.org/en/docs/http/load_balancing.html.
#### proxy-body-size ### proxy-body-size
Sets the maximum allowed size of the client request body. Sets the maximum allowed size of the client request body.
See NGINX [client_max_body_size](http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size). See NGINX [client_max_body_size](http://nginx.org/en/docs/http/ngx_http_core_module.html#client_max_body_size).
#### proxy-buffer-size ### proxy-buffer-size
Sets the size of the buffer used for [reading the first part of the response](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) received from the proxied server. This part usually contains a small response header. Sets the size of the buffer used for [reading the first part of the response](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffer_size) received from the proxied server. This part usually contains a small response header.
#### proxy-connect-timeout ### proxy-connect-timeout
Sets the timeout for [establishing a connection with a proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout). It should be noted that this timeout cannot usually exceed 75 seconds. Sets the timeout for [establishing a connection with a proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_connect_timeout). It should be noted that this timeout cannot usually exceed 75 seconds.
#### proxy-cookie-domain ### proxy-cookie-domain
Sets a text that [should be changed in the domain attribute](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_domain) of the “Set-Cookie” header fields of a proxied server response. Sets a text that [should be changed in the domain attribute](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_domain) of the “Set-Cookie” header fields of a proxied server response.
#### proxy-cookie-path ### proxy-cookie-path
Sets a text that [should be changed in the path attribute](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_path) of the “Set-Cookie” header fields of a proxied server response. Sets a text that [should be changed in the path attribute](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_path) of the “Set-Cookie” header fields of a proxied server response.
#### proxy-next-upstream ### proxy-next-upstream
Specifies in [which cases](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream) a request should be passed to the next server. Specifies in [which cases](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream) a request should be passed to the next server.
#### proxy-read-timeout ### proxy-read-timeout
Sets the timeout in seconds for [reading a response from the proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout). The timeout is set only between two successive read operations, not for the transmission of the whole response. Sets the timeout in seconds for [reading a response from the proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout). The timeout is set only between two successive read operations, not for the transmission of the whole response.
#### proxy-send-timeout ### proxy-send-timeout
Sets the timeout in seconds for [transmitting a request to the proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout). The timeout is set only between two successive write operations, not for the transmission of the whole request. Sets the timeout in seconds for [transmitting a request to the proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_send_timeout). The timeout is set only between two successive write operations, not for the transmission of the whole request.
#### proxy-request-buffering ### proxy-request-buffering
Enables or disables [buffering of a client request body](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering). Enables or disables [buffering of a client request body](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering).
#### custom-http-errors ### custom-http-errors
Enables which HTTP codes should be passed for processing with the [error_page directive](http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page). Enables which HTTP codes should be passed for processing with the [error_page directive](http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
Setting at least one code also enables [proxy_intercept_errors](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_intercept_errors) which are required to process error_page. Setting at least one code also enables [proxy_intercept_errors](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_intercept_errors) which are required to process error_page.
Example usage: `custom-http-errors: 404,415` Example usage: `custom-http-errors: 404,415`
### Other Directives ## Other Directives
#### brotli-level ### brotli-level
Sets the Brotli Compression Level that will be used. Sets the Brotli Compression Level that will be used.
*Defaults to* 4 *Defaults to* 4
### brotli-types
#### brotli-types
Sets the MIME Types that will be compressed on-the-fly by brotli. Sets the MIME Types that will be compressed on-the-fly by brotli.
*Defaults to* `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` *Defaults to* `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`
#### enable-brotli ### enable-brotli
Enables or disables compression of HTTP responses using the ["brotli" module](https://github.com/google/ngx_brotli). Enables or disables compression of HTTP responses using the ["brotli" module](https://github.com/google/ngx_brotli).
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`.
This is *enabled* by default This is *enabled* by default
#### enable-modsecurity ### enable-modsecurity
Enables the modsecurity module for NGINX Enables the modsecurity module for NGINX
By default this is disabled. By default this is disabled.
#### enable-owasp-modsecurity-crs ### enable-owasp-modsecurity-crs
Enables the OWASP ModSecurity Core Rule Set (CRS) Enables the OWASP ModSecurity Core Rule Set (CRS). By default this is disabled.
By default this is disabled.
#### disable-ipv6 ### disable-ipv6
Disable listening on IPV6. Disable listening on IPV6. By default this is disabled.
By default this is disabled.
#### enable-dynamic-tls-records ### enable-dynamic-tls-records
Enables dynamically sized TLS records to improve time-to-first-byte. Enables dynamically sized TLS records to improve time-to-first-byte. By default this is enabled.
By default this is enabled.
See [CloudFlare's blog](https://blog.cloudflare.com/optimizing-tls-over-tcp-to-reduce-latency) for more information. See [CloudFlare's blog](https://blog.cloudflare.com/optimizing-tls-over-tcp-to-reduce-latency) for more information.
#### enable-underscores-in-headers ### enable-underscores-in-headers
Enables underscores in header names. Enables underscores in header names.
By default this is disabled. By default this is disabled.
#### enable-vts-status ### enable-vts-status
Allows the replacement of the default status page with a third party module named [nginx-module-vts](https://github.com/vozlt/nginx-module-vts). Allows the replacement of the default status page with a third party module named [nginx-module-vts](https://github.com/vozlt/nginx-module-vts).
By default this is disabled. By default this is disabled.
#### gzip-types ### gzip-types
Sets the MIME types in addition to "text/html" to compress. The special value "\*" matches any MIME type. Sets the MIME types in addition to "text/html" to compress. The special value "\*" matches any MIME type.
Responses with the "text/html" type are always compressed if `use-gzip` is enabled. Responses with the "text/html" type are always compressed if `use-gzip` is enabled.
#### hsts ### hsts
Enables or disables the header HSTS in servers running SSL. Enables or disables the header HSTS in servers running SSL.
HTTP Strict Transport Security (often abbreviated as HSTS) is a security feature (HTTP header) that tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. It provides protection against protocol downgrade attacks and cookie theft. HTTP Strict Transport Security (often abbreviated as HSTS) is a security feature (HTTP header) that tell browsers that it should only be communicated with using HTTPS, instead of using HTTP. It provides protection against protocol downgrade attacks and cookie theft.
@ -187,24 +192,24 @@ _References:_
- https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security - https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security
- https://blog.qualys.com/securitylabs/2016/03/28/the-importance-of-a-proper-http-strict-transport-security-implementation-on-your-web-server - https://blog.qualys.com/securitylabs/2016/03/28/the-importance-of-a-proper-http-strict-transport-security-implementation-on-your-web-server
#### hsts-include-subdomains ### hsts-include-subdomains
Enables or disables the use of HSTS in all the subdomains of the server-name. Enables or disables the use of HSTS in all the subdomains of the server-name.
#### hsts-max-age ### hsts-max-age
Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS. Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS.
#### hsts-preload ### hsts-preload
Enables or disables the preload attribute in the HSTS feature (when it is enabled) Enables or disables the preload attribute in the HSTS feature (when it is enabled)
#### ignore-invalid-headers ### ignore-invalid-headers
Set if header fields with invalid names should be ignored. Set if header fields with invalid names should be ignored.
By default this is enabled. By default this is enabled.
#### keep-alive ### keep-alive
Sets the time during which a keep-alive client connection will stay open on the server side. Sets the time during which a keep-alive client connection will stay open on the server side.
The zero value disables keep-alive client connections. The zero value disables keep-alive client connections.
@ -213,16 +218,16 @@ _References:_
- http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout - http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout
#### max-worker-connections ### max-worker-connections
Sets the maximum number of simultaneous connections that can be opened by each [worker process](http://nginx.org/en/docs/ngx_core_module.html#worker_connections) Sets the maximum number of simultaneous connections that can be opened by each [worker process](http://nginx.org/en/docs/ngx_core_module.html#worker_connections)
#### retry-non-idempotent ### retry-non-idempotent
Since 1.9.13 NGINX will not retry non-idempotent requests (POST, LOCK, PATCH) in case of an error in the upstream server. Since 1.9.13 NGINX will not retry non-idempotent requests (POST, LOCK, PATCH) in case of an error in the upstream server.
The previous behavior can be restored using the value "true". The previous behavior can be restored using the value "true".
#### server-name-hash-bucket-size ### server-name-hash-bucket-size
Sets the size of the bucket for the server names hash tables. Sets the size of the bucket for the server names hash tables.
@ -231,7 +236,7 @@ _References:_
- http://nginx.org/en/docs/hash.html - http://nginx.org/en/docs/hash.html
- http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_size - http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_size
#### server-name-hash-max-size ### server-name-hash-max-size
Sets the maximum size of the [server names hash tables](http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_max_size) used in server names,map directive’s values, MIME types, names of request header strings, etc. Sets the maximum size of the [server names hash tables](http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_max_size) used in server names,map directive’s values, MIME types, names of request header strings, etc.
@ -239,7 +244,7 @@ _References:_
- http://nginx.org/en/docs/hash.html - http://nginx.org/en/docs/hash.html
#### proxy-headers-hash-bucket-size ### proxy-headers-hash-bucket-size
Sets the size of the bucket for the proxy headers hash tables. Sets the size of the bucket for the proxy headers hash tables.
@ -248,7 +253,7 @@ _References:_
- http://nginx.org/en/docs/hash.html - http://nginx.org/en/docs/hash.html
- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size - https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size
#### proxy-headers-hash-max-size ### proxy-headers-hash-max-size
Sets the maximum size of the proxy headers hash tables. Sets the maximum size of the proxy headers hash tables.
@ -257,23 +262,23 @@ _References:_
- http://nginx.org/en/docs/hash.html - http://nginx.org/en/docs/hash.html
- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size - https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size
#### server-tokens ### server-tokens
Send NGINX Server header in responses and display NGINX version in error pages. Send NGINX Server header in responses and display NGINX version in error pages.
By default this is enabled. By default this is enabled.
#### map-hash-bucket-size ### map-hash-bucket-size
Sets the bucket size for the [map variables hash tables](http://nginx.org/en/docs/http/ngx_http_map_module.html#map_hash_bucket_size). Sets the bucket size for the [map variables hash tables](http://nginx.org/en/docs/http/ngx_http_map_module.html#map_hash_bucket_size).
The details of setting up hash tables are provided in a separate [document](http://nginx.org/en/docs/hash.html). The details of setting up hash tables are provided in a separate [document](http://nginx.org/en/docs/hash.html).
#### ssl-buffer-size ### ssl-buffer-size
Sets the size of the [SSL buffer](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_buffer_size) used for sending data. Sets the size of the [SSL buffer](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_buffer_size) used for sending data.
The default of 4k helps NGINX to improve TLS Time To First Byte (TTTFB). The default of 4k helps NGINX to improve TLS Time To First Byte (TTTFB).
https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/ https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/
#### ssl-ciphers ### ssl-ciphers
Sets the [ciphers](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ciphers) list to enable. Sets the [ciphers](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ciphers) list to enable.
The ciphers are specified in the format understood by the OpenSSL library. The ciphers are specified in the format understood by the OpenSSL library.
@ -286,7 +291,7 @@ The recommendation above prioritizes algorithms that provide perfect [forward se
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/).
#### ssl-dh-param ### ssl-dh-param
Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy". Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy".
@ -296,32 +301,31 @@ _References:_
- https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam - https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam
- http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam - http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam
#### ssl-protocols ### ssl-protocols
Sets the [SSL protocols](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols) to use. Sets the [SSL protocols](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols) to use.
The default is: `TLSv1.2`. The default is: `TLSv1.2`.
Please check the result of the configuration using `https://ssllabs.com/ssltest/analyze.html` or `https://testssl.sh`. Please check the result of the configuration using `https://ssllabs.com/ssltest/analyze.html` or `https://testssl.sh`.
#### ssl-redirect ### ssl-redirect
Sets the global value of redirects (301) to HTTPS if the server has a TLS certificate (defined in an Ingress rule). Sets the global value of redirects (301) to HTTPS if the server has a TLS certificate (defined in an Ingress rule).
Default is "true". Default is "true".
#### ssl-session-cache ### ssl-session-cache
Enables or disables the use of shared [SSL cache](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache) among worker processes. Enables or disables the use of shared [SSL cache](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache) among worker processes.
#### ssl-session-cache-size ### ssl-session-cache-size
Sets the size of the [SSL shared session cache](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache) between all worker processes. Sets the size of the [SSL shared session cache](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_cache) between all worker processes.
#### ssl-session-tickets ### ssl-session-tickets
Enables or disables session resumption through [TLS session tickets](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets). Enables or disables session resumption through [TLS session tickets](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets).
#### ssl-session-ticket-key ### ssl-session-ticket-key
Sets the secret key used to encrypt and decrypt TLS session tickets. The value must be a valid base64 string. Sets the secret key used to encrypt and decrypt TLS session tickets. The value must be a valid base64 string.
http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets
@ -329,161 +333,184 @@ By default, a randomly generated key is used.
To create a ticket: `openssl rand 80 | base64 -w0` To create a ticket: `openssl rand 80 | base64 -w0`
#### ssl-session-timeout ### ssl-session-timeout
Sets the time during which a client may [reuse the session](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_timeout) parameters stored in a cache. Sets the time during which a client may [reuse the session](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_timeout) parameters stored in a cache.
#### upstream-max-fails ### upstream-max-fails
Sets the number of unsuccessful attempts to communicate with the [server](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) that should happen in the duration set by the `fail_timeout` parameter to consider the server unavailable. Sets the number of unsuccessful attempts to communicate with the [server](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) that should happen in the duration set by the `fail_timeout` parameter to consider the server unavailable.
#### upstream-fail-timeout ### upstream-fail-timeout
Sets the time during which the specified number of unsuccessful attempts to communicate with the [server](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) should happen to consider the server unavailable. Sets the time during which the specified number of unsuccessful attempts to communicate with the [server](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) should happen to consider the server unavailable.
### use-gzip
#### use-gzip
Enables or disables compression of HTTP responses using the ["gzip" module](http://nginx.org/en/docs/http/ngx_http_gzip_module.html). Enables or disables compression of HTTP responses using the ["gzip" module](http://nginx.org/en/docs/http/ngx_http_gzip_module.html).
The default mime type list to compress is: `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/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`.
#### use-http2 ### use-http2
Enables or disables [HTTP/2](http://nginx.org/en/docs/http/ngx_http_v2_module.html) support in secure connections. Enables or disables [HTTP/2](http://nginx.org/en/docs/http/ngx_http_v2_module.html) support in secure connections.
#### use-proxy-protocol ### use-proxy-protocol
Enables or disables the [PROXY protocol](https://www.nginx.com/resources/admin-guide/proxy-protocol/) to receive client connection (real IP address) information passed through proxy servers and load balancers such as HAProxy and Amazon Elastic Load Balancer (ELB). Enables or disables the [PROXY protocol](https://www.nginx.com/resources/admin-guide/proxy-protocol/) to receive client connection (real IP address) information passed through proxy servers and load balancers such as HAProxy and Amazon Elastic Load Balancer (ELB).
#### whitelist-source-range ### whitelist-source-range
Sets the default whitelisted IPs for each `server` block. Sets the default whitelisted IPs for each `server` block. This can be overwritten by an annotation on an Ingress rule.
This can be overwritten by an annotation on an Ingress rule.
See [ngx_http_access_module](http://nginx.org/en/docs/http/ngx_http_access_module.html). See [ngx_http_access_module](http://nginx.org/en/docs/http/ngx_http_access_module.html).
#### worker-processes ### worker-processes
Sets the number of [worker processes](http://nginx.org/en/docs/ngx_core_module.html#worker_processes). Sets the number of [worker processes](http://nginx.org/en/docs/ngx_core_module.html#worker_processes).
The default of "auto" means number of available CPU cores. The default of "auto" means number of available CPU cores.
#### worker-shutdown-timeout ### worker-shutdown-timeout
Sets a timeout for Nginx to [wait for worker to gracefully shutdown](http://nginx.org/en/docs/ngx_core_module.html#worker_shutdown_timeout). Sets a timeout for Nginx to [wait for worker to gracefully shutdown](http://nginx.org/en/docs/ngx_core_module.html#worker_shutdown_timeout).
The default is "10s". The default is "10s".
#### 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](http://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](http://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.
#### proxy-set-headers ### proxy-set-headers
Sets custom headers from a configmap before sending traffic to backends. See [example](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers) Sets custom headers from a configmap before sending traffic to backends. See [example](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers)
#### add-headers ### add-headers
Sets custom headers from a configmap before sending traffic to the client. See `proxy-set-headers` [example](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers) Sets custom headers from a configmap before sending traffic to the client. See `proxy-set-headers` [example](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers)
#### bind-address ### bind-address
Sets the addresses on which the server will accept requests instead of *. Sets the addresses on which the server will accept requests instead of *. It should be noted that these addresses must
It should be noted that these addresses must exist in the runtime environment or the controller will crash loop. exist in the runtime environment or the controller will crash loop.
#### http-snippet ### http-snippet
Adds custom configuration to the http section of the nginx configuration Adds custom configuration to the http section of the nginx configuration
Default: "" Default: ""
#### server-snippet ### server-snippet
Adds custom configuration to all the servers in the nginx configuration Adds custom configuration to all the servers in the nginx configuration
Default: "" Default: ""
#### location-snippet ### location-snippet
Adds custom configuration to all the locations in the nginx configuration Adds custom configuration to all the locations in the nginx configuration
Default: "" Default: ""
#### compute-full-forwarded-for ### compute-full-forwarded-for
Append the remote address to the X-Forwarded-For header instead of replacing it. When this option is enabled, the upstream application is responsible for extracting the client IP based on its own list of trusted proxies. Append the remote address to the X-Forwarded-For header instead of replacing it. When this option is enabled, the
upstream application is responsible for extracting the client IP based on its own list of trusted proxies.
### Opentracing ## Opentracing
#### enable-opentracing ### enable-opentracing
Enables the nginx Opentracing extension https://github.com/opentracing-contrib/nginx-opentracing Enables the nginx Opentracing extension https://github.com/opentracing-contrib/nginx-opentracing
By default this is disabled By default this is disabled.
#### zipkin-collector-host ### zipkin-collector-host
Specifies the host to use when uploading traces. It must be a valid URL Specifies the host to use when uploading traces. It must be a valid URL.
#### zipkin-collector-port ### zipkin-collector-port
Specifies the port to use when uploading traces Specifies the port to use when uploading traces
Default: 9411 Default: 9411
#### zipkin-service-name ### zipkin-service-name
Specifies the service name to use for any traces created Specifies the service name to use for any traces created
Default: nginx Default: nginx
### Default configuration options ## Default configuration options
The following table shows the options, the default value and a description. The following table shows a configuration option's name, type, and the default value:
|name | default | |name|type|default|
|:--- |:-------| |:---|:---|:------|
|body-size|1m| |add-headers|string|""|
|custom-http-errors|" "| |allow-backend-server-header|bool|false|
|enable-dynamic-tls-records|"true"| |access-log-path|string|"/var/log/nginx/access.log"|
|enable-sticky-sessions|"false"| |error-log-path|string|"/var/log/nginx/error.log"|
|enable-underscores-in-headers|"false"| |enable-dynamic-tls-records|bool|true|
|enable-vts-status|"false"| |enable-modsecurity|bool|false|
|error-log-level|notice| |enable-owasp-modsecurity-crs|bool|false|
|forwarded-for-header|X-Forwarded-For| |client-header-buffer-size|string|"1k"|
|gzip-types|see use-gzip description above| |client-header-timeout|int|60|
|hsts|"true"| |client-body-buffer-size|string|"8k"|
|hsts-include-subdomains|"true"| |client-body-timeout|int|60|
|hsts-max-age|"15724800"| |disable-access-log|bool|false|
|hsts-preload|"false"| |disable-ipv6|bool|false|
|ignore-invalid-headers|"true"| |enable-underscores-in-headers|bool|false|
|keep-alive|"75"| |ignore-invalid-headers|bool|true|
|log-format-stream|[$time_local] $protocol $status $bytes_sent $bytes_received $session_time| |enable-vts-status|bool|false|
|log-format-upstream|[$the_real_ip] - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_length $request_time [$proxy_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status| |vts-status-zone-size|string|"10m"|
|map-hash-bucket-size|"64"| |vts-default-filter-key|string|"$geoip_country_code country::*"|
|max-worker-connections|"16384"| |retry-non-idempotent|bool|false|
|proxy-body-size|same as body-size| |error-log-level|string|"notice"|
|proxy-buffer-size|"4k"| |http2-max-field-size|string|"4k"|
|proxy-request-buffering|"on"| |http2-max-header-size|string|"16k"|
|proxy-connect-timeout|"5"| |hsts|bool|true|
|proxy-cookie-domain|"off"| |hsts-include-subdomains|bool|true|
|proxy-cookie-path|"off"| |hsts-max-age|string|"15724800"|
|proxy-read-timeout|"60"| |hsts-preload|bool|false|
|proxy-real-ip-cidr|0.0.0.0/0| |keep-alive|int|75|
|proxy-send-timeout|"60"| |keep-alive-requests|int|100|
|proxy-stream-timeout|"600s"| |large-client-header-buffers|string|"4 8k"|
|retry-non-idempotent|"false"| |log-format-escape-json|bool|false|
|server-name-hash-bucket-size|"64"| |log-format-upstream|string|`%v - [$the_real_ip] - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" $request_length $request_time [$proxy_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status`|
|server-name-hash-max-size|"512"| |log-format-stream|string|`[$time_local] $protocol $status $bytes_sent $bytes_received $session_time`|
|server-tokens|"true"| |max-worker-connections|int|16384|
|ssl-buffer-size|4k| |map-hash-bucket-size|int|64|
|ssl-ciphers|ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256| |proxy-real-ip-cidr|[]string|"0.0.0.0/0"|
|ssl-dh-param|value from openssl| |proxy-set-headers|string|""|
|ssl-protocols|TLSv1.2| |server-name-hash-max-size|int|1024|
|ssl-session-cache|"true"| |server-name-hash-bucket-size|int|`<size of the processor’s cache line>`
|ssl-session-cache-size|10m| |proxy-headers-hash-max-size|int|512|
|ssl-session-tickets|"true"| |proxy-headers-hash-bucket-size|int|64|
|ssl-session-timeout|10m| |server-tokens|bool|true|
|use-gzip|"true"| |ssl-ciphers|string|"ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256"|
|use-http2|"true"| |ssl-ecdh-curve|string|"auto"|
|upstream-keepalive-connections|"0" (disabled)| |ssl-dh-param|string|""|
|variables-hash-bucket-size|64| |ssl-protocols|string|"TLSv1.2"|
|variables-hash-max-size|2048| |ssl-session-cache|bool|true|
|vts-status-zone-size|10m| |ssl-session-cache-size|string|"10m"|
|vts-default-filter-key|$geoip_country_code country::*| |ssl-session-tickets|bool|true|
|whitelist-source-range|permit all| |ssl-session-ticket-key|string|`<Randomly Generated>`
|worker-processes|number of CPUs| |ssl-session-timeout|string|"10m"|
|limit-conn-zone-variable|$binary_remote_addr| |ssl-buffer-size|string|"4k"|
|bind-address|| |use-proxy-protocol|bool|false|
|use-gzip|bool|true|
|enable-brotli|bool|true|
|brotli-level|int|4|
|brotli-types|string|"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"|
|use-http2|bool|true|
|gzip-types|string|"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"|
|worker-processes|string|`<Number of CPUs>`|
|worker-shutdown-timeout|string|"10s"|
|load-balance|string|"least_conn"|
|variables-hash-bucket-size|int|128|
|variables-hash-max-size|int|2048|
|upstream-keepalive-connections|int|32|
|limit-conn-zone-variable|string|"$binary_remote_addr"|
|proxy-stream-timeout|string|"600s"|
|bind-address-ipv4|[]string|""|
|bind-address-ipv6|[]string|""|
|forwarded-for-header|string|"X-Forwarded-For"|
|compute-full-forwarded-for|bool|false|
|enable-opentracing|bool|false|
|zipkin-collector-host|string|""|
|zipkin-collector-port|int|9411|
|zipkin-service-name|string|"nginx"|
|http-snippet|string|""|
|server-snippet|string|""|
|location-snippet|string|""|