From bb6ae76c25472258a48009381aebe6e955eb820f Mon Sep 17 00:00:00 2001 From: Fernando Diaz Date: Sat, 25 Nov 2017 16:47:08 -0600 Subject: [PATCH] Complete Config-Map Documentation Overhaul Changes the Config-Map documentation to be easier to search and follow a format similar to that in the annotations section. Also adds some missing configuration options. Fixes #1532 --- docs/user-guide/configmap.md | 911 ++++++++++++++++++++--------------- 1 file changed, 516 insertions(+), 395 deletions(-) diff --git a/docs/user-guide/configmap.md b/docs/user-guide/configmap.md index 079d42c39..0013c4ae6 100644 --- a/docs/user-guide/configmap.md +++ b/docs/user-guide/configmap.md @@ -13,41 +13,279 @@ data: ssl-protocols: SSLv2 ``` -## Logs +## Configuration options -### disable-access-log +The following table shows a configuration option's name, type, and the default value: -Disables the Access Log from the entire Ingress Controller. This is 'false' by default. +|name|type|default| +|:---|:---|:------| +|[add-headers](#add-headers)|string|""| +|[allow-backend-server-header](#allow-backend-server-header)|bool|false| +|[access-log-path](#access-log-path)|string|"/var/log/nginx/access.log"| +|[error-log-path](#error-log-path)|string|"/var/log/nginx/error.log"| +|[enable-dynamic-tls-records](#enable-dynamic-tls-records)|bool|true| +|[enable-modsecurity](#enable-modsecurity)|bool|false| +|[enable-owasp-modsecurity-crs](#enable-owasp-modsecurity-crs)|bool|false| +|[client-header-buffer-size](#client-header-buffer-size)|string|"1k"| +|[client-header-timeout](#client-header-timeout)|int|60| +|[client-body-buffer-size](#client-body-buffer-size)|string|"8k"| +|[client-body-timeout](#client-body-timeout)|int|60| +|[disable-access-log](#disable-access-log)|bool|false| +|[disable-ipv6](#disable-ipv6)|bool|false| +|[enable-underscores-in-headers](#enable-underscores-in-headers)|bool|false| +|[ignore-invalid-headers](#ignore-invalid-headers)|bool|true| +|[enable-vts-status](#enable-vts-status)|bool|false| +|[vts-status-zone-size](#vts-status-zone-size)|string|"10m"| +|[vts-default-filter-key](#vts-default-filter-key)|string|"$geoip_country_code country::*"| +|[retry-non-idempotent](#retry-non-idempotent)|bool|false| +|[error-log-level](#error-log-level)|string|"notice"| +|[http2-max-field-size](#http2-max-field-size)|string|"4k"| +|[http2-max-header-size](#http2-max-header-size)|string|"16k"| +|[hsts](#hsts)|bool|true| +|[hsts-include-subdomains](#hsts-include-subdomains)|bool|true| +|[hsts-max-age](#hsts-max-age)|string|"15724800"| +|[hsts-preload](#hsts-preload)|bool|false| +|[keep-alive](#keep-alive)|int|75| +|[keep-alive-requests](#keep-alive-requests)|int|100| +|[large-client-header-buffers](#large-client-header-buffers)|string|"4 8k"| +|[log-format-escape-json](#log-format-escape-json)|bool|false| +|[log-format-upstream](#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`| +|[log-format-stream](#log-format-stream)|string|`[$time_local] $protocol $status $bytes_sent $bytes_received $session_time`| +|[max-worker-connections](#max-worker-connections)|int|16384| +|[map-hash-bucket-size](#max-worker-connections)|int|64| +|[proxy-real-ip-cidr](#proxy-real-ip-cidr)|[]string|"0.0.0.0/0"| +|[proxy-set-headers](#proxy-set-headers)|string|""| +|[server-name-hash-max-size](#server-name-hash-max-size)|int|1024| +|[server-name-hash-bucket-size](#server-name-hash-bucket-size)|int|`` +|[proxy-headers-hash-max-size](#proxy-headers-hash-max-size)|int|512| +|[proxy-headers-hash-bucket-size](#proxy-headers-hash-bucket-size)|int|64| +|[server-tokens](#server-tokens)|bool|true| +|[ssl-ciphers](#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"| +|[ssl-ecdh-curve](#ssl-ecdh-curve)|string|"auto"| +|[ssl-dh-param](#ssl-dh-param)|string|""| +|[ssl-protocols](#ssl-protocols)|string|"TLSv1.2"| +|[ssl-session-cache](#ssl-session-cache)|bool|true| +|[ssl-session-cache-size](#ssl-session-cache-size)|string|"10m"| +|[ssl-session-tickets](#ssl-session-tickets)|bool|true| +|[ssl-session-ticket-key](#ssl-session-ticket-key)|string|`` +|[ssl-session-timeout](#ssl-session-timeout)|string|"10m"| +|[ssl-buffer-size](#ssl-buffer-size)|string|"4k"| +|[use-proxy-protocol](#use-proxy-protocol)|bool|false| +|[use-gzip](#use-gzip)|bool|true| +|[enable-brotli](#enable-brotli)|bool|true| +|[brotli-level](#brotli-level)|int|4| +|[brotli-types](#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](#use-http2)|bool|true| +|[gzip-types](#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](#worker-processes)|string|``| +|[worker-shutdown-timeout](#worker-shutdown-timeout)|string|"10s"| +|[load-balance](#load-balance)|string|"least_conn"| +|[variables-hash-bucket-size](#variables-hash-bucket-size)|int|128| +|[variables-hash-max-size](#variables-hash-max-size)|int|2048| +|[upstream-keepalive-connections](#upstream-keepalive-connections)|int|32| +|[limit-conn-zone-variable](#limit-conn-zone-variable)|string|"$binary_remote_addr"| +|[proxy-stream-timeout](#proxy-stream-timeout)|string|"600s"| +|[bind-address-ipv4](#bind-address-ipv4)|[]string|""| +|[bind-address-ipv6](#bind-address-ipv6)|[]string|""| +|[forwarded-for-header](#forwarded-for-header)|string|"X-Forwarded-For"| +|[compute-full-forwarded-for](#compute-full-forwarded-for)|bool|false| +|[enable-opentracing](#enable-opentracing)|bool|false| +|[zipkin-collector-host](#zipkin-collector-host)|string|""| +|[zipkin-collector-port](#zipkin-collector-port)|int|9411| +|[zipkin-service-name](#zipkin-service-name)|string|"nginx"| +|[http-snippet](#http-snippet)|string|""| +|[server-snippet](#server-snippet)|string|""| +|[location-snippet](#location-snippet)|string|""| +|[custom-http-errors](#custom-http-errors)|[]int]|[]int{}| +|[proxy-body-size](#proxy-body-size)|string|"1m"| +|[proxy-connect-timeout](#proxy-connect-timeout)|int|5| +|[proxy-read-timeout](#proxy-read-timeout)|int|60| +|[proxy-send-timeout](#proxy-send-timeout)|int|60| +|[proxy-buffer-size](#proxy-buffer-size)|string|"4k"| +|[proxy-cookie-path](#proxy-cookie-path)|string|"off"| +|[proxy-cookie-domain](#proxy-cookie-domain)|string|"off"| +|[proxy-next-upstream](#proxy-next-upstream)|string|"error timeout invalid_header http_502 http_503 http_504"| +|[proxy-redirect-from](#proxy-redirect-from)|string|"off"| +|[proxy-request-buffering](#proxy-request-buffering)|string|"on"| +|[ssl-redirect](#ssl-redirect)|bool|true| +|[whitelist-source-range](#whitelist-source-range)|[]string|[]string{}| +|[skip-access-log-urls](#skip-access-log-urls)|[]string|[]string{}| +|[limit-rate](#limit-rate)|int|0| +|[limit-rate-after](#limit-rate-after)|int|0| -### access-log-path +## add-headers + +Sets custom headers from a configmap before sending traffic to the client. See [proxy-set-headers](#proxy-set-headers). [example](https://github.com/kubernetes/ingress-nginx/tree/master/docs/examples/customization/custom-headers) + +## allow-backend-server-header + +AllowBackendServerHeader enables the return of the header Server from the backend instead of the generic nginx string. By default this is disabled. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header + +## access-log-path Access log path. Goes to '/var/log/nginx/access.log' by default. -_References:_ - -- http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log - -### error-log-level - -Configures the logging level of errors. Log levels above are listed in the order of increasing severity. - -_References:_ - -- 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. _References:_ - - http://nginx.org/en/docs/ngx_core_module.html#error_log -### log-format-stream +## enable-dynamic-tls-records -Sets the nginx [stream format](https://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format). +Enables dynamically sized TLS records to improve time-to-first-byte. By default this is enabled. See [CloudFlare's blog](https://blog.cloudflare.com/optimizing-tls-over-tcp-to-reduce-latency) for more information. -### log-format-upstream +## enable-modsecurity + +Enables the modsecurity module for NGINX. By default this is disabled. + +## enable-owasp-modsecurity-crs + +Enables the OWASP ModSecurity Core Rule Set (CRS). By default this is disabled. + +## client-header-buffer-size + +Allows to configure a custom buffer size for reading client request header. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_buffer_size + +## client-header-timeout + +Defines a timeout for reading client request header, in seconds. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#client_header_timeout + +## client-body-buffer-size + +Sets buffer size for reading client request body. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_buffer_size + +## client-body-timeout + +Defines a timeout for reading client request body, in seconds. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#client_body_timeout + +## disable-access-log + +Disables the Access Log from the entire Ingress Controller. This is 'false' by default. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log + +## disable-ipv6 + +Disable listening on IPV6. By default this is disabled. + +## enable-underscores-in-headers + +Enables underscores in header names. By default this is disabled. + +## ignore-invalid-headers + +Set if header fields with invalid names should be ignored. +By default this is enabled. + +## 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). +By default this is disabled. + +## vts-status-zone-size + +Vts config on http level sets parameters for a shared memory zone that will keep states for various keys. The cache is shared between all worker processes. Default value is 10m + +_References:_ +- https://github.com/vozlt/nginx-module-vts#vhost_traffic_status_zone + +## vts-default-filter-key + +Vts config on http level enables the keys by user defined variable. The key is a key string to calculate traffic. The name is a group string to calculate traffic. The key and name can contain variables such as $host, $server_name. The name's group belongs to filterZones if specified. The key's group belongs to serverZones if not specified second argument name. Default value is $geoip_country_code country::* + +_References:_ +- https://github.com/vozlt/nginx-module-vts#vhost_traffic_status_filter_by_set_key + +## 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. The previous behavior can be restored using the value "true". + +## error-log-level + +Configures the logging level of errors. Log levels above are listed in the order of increasing severity. + +_References:_ +- http://nginx.org/en/docs/ngx_core_module.html#error_log + +## http2-max-field-size + +Limits the maximum size of an HPACK-compressed request header field. + +_References:_ +- https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_field_size + +## http2-max-header-size + +Limits the maximum size of the entire request header list after HPACK decompression. + +_References:_ +- https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_header_size + +## hsts + +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. + +_References:_ +- 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 + +## hsts-include-subdomains + +Enables or disables the use of HSTS in all the subdomains of the server-name. + +## hsts-max-age + +Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS. + +## hsts-preload + +Enables or disables the preload attribute in the HSTS feature (when it is enabled) dd + +## keep-alive + +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. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout + +## keep-alive-requests + +Sets the maximum number of requests that can be served through one keep-alive connection. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_requests + +## large-client-header-buffers + +Sets the maximum number and size of buffers used for reading large client request header. Default: 4 8k. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers + +## log-format-escape-json + +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). + +## log-format-upstream Sets the nginx [log format](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format). Example for json output: @@ -64,14 +302,164 @@ log-format-upstream: '{ "time": "$time_iso8601", "remote_addr": "$proxy_protocol Please check [log-format](log-format.md) for definition of each field. -### log-format-escape-json +## log-format-stream -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 [stream format](https://nginx.org/en/docs/stream/ngx_stream_log_module.html#log_format). -## Proxy configuration +## max-worker-connections -### load-balance +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) + +## 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). + +## proxy-real-ip-cidr + +If use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default the IP/network address of your external load balancer. + +## 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) + +## 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. + +_References:_ +- http://nginx.org/en/docs/hash.html + +## server-name-hash-bucket-size + +Sets the size of the bucket for the server names hash tables. + +_References:_ +- http://nginx.org/en/docs/hash.html +- http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_size + +## proxy-headers-hash-max-size + +Sets the maximum size of the proxy headers hash tables. + +_References:_ +- http://nginx.org/en/docs/hash.html +- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size + +## proxy-headers-hash-bucket-size + +Sets the size of the bucket for the proxy headers hash tables. + +_References:_ +- http://nginx.org/en/docs/hash.html +- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size + +## server-tokens + +Send NGINX Server header in responses and display NGINX version in error pages. By default this is enabled. + +## ssl-ciphers + +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 default cipher list is: + `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`. + +The ordering of a ciphersuite is very important because it decides which algorithms are going to be selected in priority. The recommendation above prioritizes algorithms that provide perfect [forward secrecy](https://wiki.mozilla.org/Security/Server_Side_TLS#Forward_Secrecy). + +Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/). + +## ssl-ecdh-curve + +Specifies a curve for ECDHE ciphers. + +_References:_ +- http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_ecdh_curve + +## ssl-dh-param + +Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy". + +_References:_ +- https://www.openssl.org/docs/manmaster/apps/dhparam.html +- 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 + +## ssl-protocols + +Sets the [SSL protocols](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols) to use. The default is: `TLSv1.2`. + +Please check the result of the configuration using `https://ssllabs.com/ssltest/analyze.html` or `https://testssl.sh`. + +## 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. + +## 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. + +## 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 + +Sets the secret key used to encrypt and decrypt TLS session tickets. The value must be a valid base64 string. + +[TLS session ticket-key](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_session_tickets), by default, a randomly generated key is used. To create a ticket: `openssl rand 80 | base64 -w0` + +## 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. + +## 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. The default of 4k helps NGINX to improve TLS Time To First Byte (TTTFB). + +_References:_ +- https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/ + +## 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). + +## use-gzip + +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`. + +## enable-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`. This is *enabled* by default. + +## brotli-level + +Sets the Brotli Compression Level that will be used. *Defaults to* 4. + +## brotli-types + +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`. + +## use-http2 + +Enables or disables [HTTP/2](http://nginx.org/en/docs/http/ngx_http_v2_module.html) support in secure connections. + +## gzip-types + +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. + +## 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. + +## 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". + +## load-balance Sets the algorithm to use for load balancing. The value can either be: @@ -83,434 +471,167 @@ The value can either be: The default is least_conn. _References:_ - - http://nginx.org/en/docs/http/load_balancing.html. -### proxy-body-size +## variables-hash-bucket-size -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). +Sets the bucket size for the variables hash table. -### proxy-buffer-size +_References:_ +- http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_bucket_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. +## variables-hash-max-size -### proxy-connect-timeout +Sets the maximum size of the variables hash table. -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. +_References:_ +- http://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_max_size -### proxy-cookie-domain +## upstream-keepalive-connections -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. +Activates the cache for connections to upstream servers. The connections parameter sets the maximum number of idle keepalive connections to upstream servers that are preserved in the cache of each worker process. When this +number is exceeded, the least recently used connections are closed. Default: 32 -### proxy-cookie-path +_References:_ +- http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive -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. +## limit-conn-zone-variable -### proxy-next-upstream +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. -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-stream-timeout -### proxy-read-timeout +Sets the timeout between two successive read or write operations on client or proxied server connections. If no data is transmitted within this time, the connection is closed. -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. +_References:_ +- http://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_timeout -### proxy-send-timeout +## bind-address-ipv4 -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 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. -### proxy-request-buffering +## bind-address-ipv6 -Enables or disables [buffering of a client request body](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering). +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. -### custom-http-errors +## forwarded-for-header + +Sets the header field for identifying the originating IP address of a client. Default is X-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. + +## enable-opentracing + +Enables the nginx Opentracing extension. By default this is disabled. + +_References:_ +- https://github.com/opentracing-contrib/nginx-opentracing + +## zipkin-collector-host + +Specifies the host to use when uploading traces. It must be a valid URL. + +## zipkin-collector-port + +Specifies the port to use when uploading traces. Default: 9411 + +## zipkin-service-name + +Specifies the service name to use for any traces created. Default: nginx + +## http-snippet + +Adds custom configuration to the http section of the nginx configuration. +Default: "" + +## server-snippet + +Adds custom configuration to all the servers in the nginx configuration. +Default: "" + +## location-snippet + +Adds custom configuration to all the locations in the nginx configuration. +Default: "" + +## 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. Example usage: `custom-http-errors: 404,415` -## Other Directives +## proxy-body-size -### brotli-level +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). -Sets the Brotli Compression Level that will be used. -*Defaults to* 4 +## proxy-connect-timeout -### brotli-types +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 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` +## proxy-read-timeout -### enable-brotli +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. -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`. +## proxy-send-timeout -This is *enabled* by default +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. -### enable-modsecurity +## proxy-buffer-size -Enables the modsecurity module for NGINX -By default this is disabled. +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. -### enable-owasp-modsecurity-crs +## proxy-cookie-path -Enables the OWASP ModSecurity Core Rule Set (CRS). By default this is disabled. +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. -### disable-ipv6 +## proxy-cookie-domain -Disable listening on IPV6. By default this is disabled. +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. -### enable-dynamic-tls-records +## proxy-next-upstream -Enables dynamically sized TLS records to improve time-to-first-byte. By default this is enabled. -See [CloudFlare's blog](https://blog.cloudflare.com/optimizing-tls-over-tcp-to-reduce-latency) for more information. +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. -### enable-underscores-in-headers +## proxy-redirect-from -Enables underscores in header names. -By default this is disabled. - -### 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). -By default this is disabled. - -### gzip-types - -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. - -### hsts - -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. +Sets the original text that should be changed in the "Location" and "Refresh" header fields of a proxied server response. Default: off. _References:_ +- http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_redirect -- 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 +## proxy-request-buffering -### hsts-include-subdomains +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 the use of HSTS in all the subdomains of the server-name. - -### hsts-max-age - -Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS. - -### hsts-preload - -Enables or disables the preload attribute in the HSTS feature (when it is enabled) - -### ignore-invalid-headers - -Set if header fields with invalid names should be ignored. -By default this is enabled. - -### keep-alive - -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. - -_References:_ - -- http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout - -### 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) - -### 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. -The previous behavior can be restored using the value "true". - -### server-name-hash-bucket-size - -Sets the size of the bucket for the server names hash tables. - -_References:_ - -- http://nginx.org/en/docs/hash.html -- http://nginx.org/en/docs/http/ngx_http_core_module.html#server_names_hash_bucket_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. - -_References:_ - -- http://nginx.org/en/docs/hash.html - -### proxy-headers-hash-bucket-size - -Sets the size of the bucket for the proxy headers hash tables. - -_References:_ - -- http://nginx.org/en/docs/hash.html -- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_bucket_size - -### proxy-headers-hash-max-size - -Sets the maximum size of the proxy headers hash tables. - -_References:_ - -- http://nginx.org/en/docs/hash.html -- https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size - -### server-tokens - -Send NGINX Server header in responses and display NGINX version in error pages. -By default this is enabled. - -### 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). - -### 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. -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/ - -### ssl-ciphers - -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 default cipher list is: - `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`. - -The ordering of a ciphersuite is very important because it decides which algorithms are going to be selected in priority. -The recommendation above prioritizes algorithms that provide perfect [forward secrecy](https://wiki.mozilla.org/Security/Server_Side_TLS#Forward_Secrecy). - -Please check the [Mozilla SSL Configuration Generator](https://mozilla.github.io/server-side-tls/ssl-config-generator/). - -### ssl-dh-param - -Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy". - -_References:_ - -- https://www.openssl.org/docs/manmaster/apps/dhparam.html -- 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 - -### ssl-protocols - -Sets the [SSL protocols](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_protocols) to use. -The default is: `TLSv1.2`. - -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). Default is "true". -### 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. - -### 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. - -### 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 - -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 -By default, a randomly generated key is used. - -To create a ticket: `openssl rand 80 | base64 -w0` - -### 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. - -### 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. - -### 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. - -### use-gzip - -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`. - -### use-http2 - -Enables or disables [HTTP/2](http://nginx.org/en/docs/http/ngx_http_v2_module.html) support in secure connections. - -### 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). - -### whitelist-source-range +## whitelist-source-range Sets the default whitelisted IPs for each `server` block. 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). -### worker-processes +## skip-access-log-urls -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. +Sets a list of URLs that should not appear in the NGINX access log. This is useful with urls like `/health` or `health-check` that make "complex" reading the logs. By default this list is empty -### worker-shutdown-timeout +## limit-rate -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". +Limits the rate of response transmission to a client. The rate is specified in bytes per second. The zero value disables rate limiting. The limit is set per a request, and so if a client simultaneously opens two connections, the overall rate will be twice as much as the specified limit. -### limit-conn-zone-variable +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate -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. +## limit-rate-after -### proxy-set-headers +Sets the initial amount after which the further transmission of a response to a client will be rate limited. -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 - -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 - -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. - -### http-snippet - -Adds custom configuration to the http section of the nginx configuration -Default: "" - -### server-snippet - -Adds custom configuration to all the servers in the nginx configuration -Default: "" - -### location-snippet - -Adds custom configuration to all the locations in the nginx configuration -Default: "" - -### 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. - -## Opentracing - -### enable-opentracing - -Enables the nginx Opentracing extension https://github.com/opentracing-contrib/nginx-opentracing -By default this is disabled. - -### zipkin-collector-host - -Specifies the host to use when uploading traces. It must be a valid URL. - -### zipkin-collector-port - -Specifies the port to use when uploading traces -Default: 9411 - -### zipkin-service-name - -Specifies the service name to use for any traces created -Default: nginx - -## Default configuration options - -The following table shows a configuration option's name, type, and the default value: - -|name|type|default| -|:---|:---|:------| -|add-headers|string|""| -|allow-backend-server-header|bool|false| -|access-log-path|string|"/var/log/nginx/access.log"| -|error-log-path|string|"/var/log/nginx/error.log"| -|enable-dynamic-tls-records|bool|true| -|enable-modsecurity|bool|false| -|enable-owasp-modsecurity-crs|bool|false| -|client-header-buffer-size|string|"1k"| -|client-header-timeout|int|60| -|client-body-buffer-size|string|"8k"| -|client-body-timeout|int|60| -|disable-access-log|bool|false| -|disable-ipv6|bool|false| -|enable-underscores-in-headers|bool|false| -|ignore-invalid-headers|bool|true| -|enable-vts-status|bool|false| -|vts-status-zone-size|string|"10m"| -|vts-default-filter-key|string|"$geoip_country_code country::*"| -|retry-non-idempotent|bool|false| -|error-log-level|string|"notice"| -|http2-max-field-size|string|"4k"| -|http2-max-header-size|string|"16k"| -|hsts|bool|true| -|hsts-include-subdomains|bool|true| -|hsts-max-age|string|"15724800"| -|hsts-preload|bool|false| -|keep-alive|int|75| -|keep-alive-requests|int|100| -|large-client-header-buffers|string|"4 8k"| -|log-format-escape-json|bool|false| -|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`| -|log-format-stream|string|`[$time_local] $protocol $status $bytes_sent $bytes_received $session_time`| -|max-worker-connections|int|16384| -|map-hash-bucket-size|int|64| -|proxy-real-ip-cidr|[]string|"0.0.0.0/0"| -|proxy-set-headers|string|""| -|server-name-hash-max-size|int|1024| -|server-name-hash-bucket-size|int|`` -|proxy-headers-hash-max-size|int|512| -|proxy-headers-hash-bucket-size|int|64| -|server-tokens|bool|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"| -|ssl-ecdh-curve|string|"auto"| -|ssl-dh-param|string|""| -|ssl-protocols|string|"TLSv1.2"| -|ssl-session-cache|bool|true| -|ssl-session-cache-size|string|"10m"| -|ssl-session-tickets|bool|true| -|ssl-session-ticket-key|string|`` -|ssl-session-timeout|string|"10m"| -|ssl-buffer-size|string|"4k"| -|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|``| -|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|""| +_References:_ +- http://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate_after