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.
In order to overwrite nginx-controller configuration values as seen in config.go, you can add key-value pairs to the data section of the config-map. For Example:
data:
map-hash-bucket-size: "128"
ssl-protocols: SSLv2IMPORTANT:
The key and values in a ConfigMap can only be strings. This means that we want a value with boolean values we need to quote the values, like "true" or "false". Same for numbers, like "100".
"Slice" types (defined below as []string or []int can be provided as a comma-delimited string.
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" |
| hide-headers | string array | empty |
| 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 |
| disable-ipv6-dns | 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 | <size of the processor’s cache line> |
| 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 | <Randomly Generated> |
| 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 | <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" |
| proxy-stream-responses | int | 1 |
| 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" |
| jaeger-collector-host | string | "" |
| jaeger-collector-port | int | 6831 |
| jaeger-service-name | string | "nginx" |
| jaeger-sampler-type | string | "const" |
| jaeger-sampler-param | string | "1" |
| http-snippet | string | "" |
| server-snippet | string | "" |
| location-snippet | string | "" |
| custom-http-errors | []int] | []int{} |
| proxy-body-size | string | "1m" |
| proxy-connect-timeout | int | 5 |
| proxy-read-timeout | int | 60 |
| proxy-send-timeout | int | 60 |
| proxy-buffer-size | string | "4k" |
| proxy-cookie-path | string | "off" |
| proxy-cookie-domain | string | "off" |
| proxy-next-upstream | string | "error timeout invalid_header http_502 http_503 http_504" |
| proxy-redirect-from | string | "off" |
| proxy-request-buffering | string | "on" |
| ssl-redirect | bool | "true" |
| whitelist-source-range | []string | []string{} |
| skip-access-log-urls | []string | []string{} |
| limit-rate | int | 0 |
| limit-rate-after | int | 0 |
| http-redirect-code | int | 308 |
| proxy-buffering | string | "off" |
| limit-req-status-code | int | 503 |
Sets custom headers from named configmap before sending traffic to the client. See proxy-set-headers. example
Enables the return of the header Server from the backend instead of the generic nginx string. By default this is disabled.
Sets additional header that will not be passed from the upstream server to the client response. Default: empty
References:
Access log path. Goes to /var/log/nginx/access.log by default.
Note: the file /var/log/nginx/access.log is a symlink to /dev/stdout
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
References:
Enables dynamically sized TLS records to improve time-to-first-byte. By default this is enabled. See CloudFlare's blog for more information.
Enables the modsecurity module for NGINX. By default this is disabled.
Enables the OWASP ModSecurity Core Rule Set (CRS). By default this is disabled.
Allows to configure a custom buffer size for reading client request header.
References:
Defines a timeout for reading client request header, in seconds.
References:
Sets buffer size for reading client request body.
References:
Defines a timeout for reading client request body, in seconds.
References:
Disables the Access Log from the entire Ingress Controller. This is '"false"' by default.
References:
Disable listening on IPV6. By default this is disabled.
Disable IPV6 for nginx DNS resolver. By default this is disabled.
Enables underscores in header names. By default this is disabled.
Set if header fields with invalid names should be ignored. By default this is enabled.
Allows the replacement of the default status page with a third party module named nginx-module-vts. By default this is disabled.
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:
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:
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".
Configures the logging level of errors. Log levels above are listed in the order of increasing severity.
References:
Limits the maximum size of an HPACK-compressed request header field.
References:
Limits the maximum size of the entire request header list after HPACK decompression.
References:
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
Enables or disables the use of HSTS in all the subdomains of the server-name.
Sets the time, in seconds, that the browser should remember that this site is only to be accessed using HTTPS.
Enables or disables the preload attribute in the HSTS feature (when it is enabled) dd
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:
Sets the maximum number of requests that can be served through one keep-alive connection.
References:
Sets the maximum number and size of buffers used for reading large client request header. Default: 4 8k.
References:
Sets if the escape parameter allows JSON ("true") or default characters escaping in variables ("false") Sets the nginx log format.
Sets the nginx log format. Example for json output:
log-format-upstream: '{ "time": "$time_iso8601", "remote_addr": "$proxy_protocol_addr",
"x-forward-for": "$proxy_add_x_forwarded_for", "request_id": "$request_id", "remote_user":
"$remote_user", "bytes_sent": $bytes_sent, "request_time": $request_time, "status":
$status, "vhost": "$host", "request_proto": "$server_protocol", "path": "$uri",
"request_query": "$args", "request_length": $request_length, "duration": $request_time,
"method": "$request_method", "http_referrer": "$http_referer", "http_user_agent":
"$http_user_agent" }'Please check log-format for definition of each field.
Sets the nginx stream format.
Sets the maximum number of simultaneous connections that can be opened by each worker process
Sets the bucket size for the map variables hash tables. The details of setting up hash tables are provided in a separate document.
If use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default the IP/network address of your external load balancer.
Sets custom headers from named configmap before sending traffic to backends. The value format is namespace/name. See example
Sets the maximum size of the server names hash tables used in server names,map directive’s values, MIME types, names of request header strings, etc.
References:
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
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
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
Send NGINX Server header in responses and display NGINX version in error pages. By default this is enabled.
Sets the 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.
Please check the Mozilla SSL Configuration Generator.
Specifies a curve for ECDHE ciphers.
References:
Sets the name of the secret that contains Diffie-Hellman key to help with "Perfect Forward Secrecy".
References:
- https://wiki.openssl.org/index.php/Manual:Dhparam(1)
- 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
Sets the 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.
Enables or disables the use of shared SSL cache among worker processes.
Sets the size of the SSL shared session cache between all worker processes.
Enables or disables session resumption through TLS session tickets.
Sets the secret key used to encrypt and decrypt TLS session tickets. The value must be a valid base64 string.
TLS session ticket-key, by default, a randomly generated key is used. To create a ticket: openssl rand 80 | base64 -w0
Sets the time during which a client may reuse the session parameters stored in a cache.
Sets the size of the SSL buffer used for sending data. The default of 4k helps NGINX to improve TLS Time To First Byte (TTTFB).
References:
Enables or disables the 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 compression of HTTP responses using the "gzip" module.
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.
Enables or disables compression of HTTP responses using the "brotli" module.
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 disabled by default.
Note: Brotli does not works in Safari < 11 https://caniuse.com/#feat=brotli
Sets the Brotli Compression Level that will be used. Defaults to 4.
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.
Enables or disables HTTP/2 support in secure connections.
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.
Sets the number of worker processes. The default of "auto" means number of available CPU cores.
Sets a timeout for Nginx to wait for worker to gracefully shutdown. The default is "10s".
Sets the algorithm to use for load balancing. The value can either be:
- round_robin: to use the default round robin loadbalancer
- least_conn: to use the least connected method
- ip_hash: to use a hash of the server for routing.
The default is least_conn.
References:
Sets the bucket size for the variables hash table.
References:
Sets the maximum size of the variables hash table.
References:
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
References:
Sets parameters for a shared memory zone that will keep states for various keys of 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 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.
References:
Sets the number of datagrams expected from the proxied server in response to the client request if the UDP protocol is used.
References:
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.
Sets the header field for identifying the originating IP address of a client. Default is X-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.
Enables the nginx Opentracing extension. By default this is disabled.
References:
Specifies the host to use when uploading traces. It must be a valid URL.
Specifies the port to use when uploading traces. Default: 9411
Specifies the service name to use for any traces created. Default: nginx
Specifies the host to use when uploading traces. It must be a valid URL.
Specifies the port to use when uploading traces. Default: 6831
Specifies the service name to use for any traces created. Default: nginx
Specifies the sampler to be used when sampling traces. The available samplers are: const, probabilistic, ratelimiting, remote. Default const.
Specifies the argument to be passed to the sampler constructor. Must be a number. For const this should be 0 to never sample and 1 to always sample. Default: 1
Adds custom configuration to the http section of the nginx configuration. Default: ""
Adds custom configuration to all the servers in the nginx configuration. Default: ""
Adds custom configuration to all the locations in the nginx configuration. Default: ""
Enables which HTTP codes should be passed for processing with the error_page directive
Setting at least one code also enables proxy_intercept_errors which are required to process error_page.
Example usage: custom-http-errors: 404,415
Sets the maximum allowed size of the client request body. See NGINX client_max_body_size.
Sets the timeout for establishing a connection with a proxied server. It should be noted that this timeout cannot usually exceed 75 seconds.
Sets the timeout in seconds for reading a response from the proxied server. The timeout is set only between two successive read operations, not for the transmission of the whole response.
Sets the timeout in seconds for transmitting a request to the proxied server. The timeout is set only between two successive write operations, not for the transmission of the whole request.
Sets the size of the buffer used for reading the first part of the response received from the proxied server. This part usually contains a small response header.
Sets a text that should be changed in the path attribute of the “Set-Cookie” header fields of a proxied server response.
Sets a text that should be changed in the domain attribute of the “Set-Cookie” header fields of a proxied server response.
Specifies in which cases a request should be passed to the next server.
Sets the original text that should be changed in the "Location" and "Refresh" header fields of a proxied server response. Default: off.
References:
Enables or disables buffering of a client request body.
Sets the global value of redirects (301) to HTTPS if the server has a TLS certificate (defined in an Ingress rule). Default is "true".
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.
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
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.
References:
Sets the initial amount after which the further transmission of a response to a client will be rate limited.
References:
Sets the HTTP status code to be used in redirects. Supported codes are 301,302,307 and 308 Default code is 308.
Why the default code is 308?
RFC 7238 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 the we send a redirect in methods like POST.
Enables or disables buffering of responses from the proxied server.
Sets the status code to return in response to rejected requests.Default: 503