ConfigMaps ¶

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.

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: SSLv2

Configuration options ¶

The following table shows a configuration option's name, type, and the default value:

add-headers ¶

Sets custom headers from named configmap before sending traffic to the client. See proxy-set-headers. example

allow-backend-server-header ¶

Enables the return of the header Server from the backend instead of the generic nginx string. default: is disabled

allow-cross-namespace-resources ¶

Enables users to consume cross namespace resource on annotations, when was previously enabled . default: false

Annotations that may be impacted with this change:

• auth-secret
• auth-proxy-set-header
• auth-tls-secret
• fastcgi-params-configmap
• proxy-ssl-secret

allow-snippet-annotations ¶

Enables Ingress to parse and add -snippet annotations/directives created by the user. _**default:*_ false

Warning: We recommend enabling this option only if you TRUST users with permission to create Ingress objects, as this may allow a user to add restricted configurations to the final nginx.conf file

annotations-risk-level ¶

Represents the risk accepted on an annotation. If the risk is, for instance Medium, annotations with risk High and Critical will not be accepted.

Accepted values are Critical, High, Medium and Low.

default: High

annotation-value-word-blocklist ¶

Contains a comma-separated value of chars/words that are well known of being used to abuse Ingress configuration and must be blocked. Related to CVE-2021-25742

When an annotation is detected with a value that matches one of the blocked bad words, the whole Ingress won't be configured.

default: ""

When doing this, the default blocklist is override, which means that the Ingress admin should add all the words that should be blocked, here is a suggested block list.

suggested: "load_module,lua_package,_by_lua,location,root,proxy_pass,serviceaccount,{,},',\""

hide-headers ¶

Sets additional header that will not be passed from the upstream server to the client response. default: empty

References: https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_hide_header

access-log-params ¶

Additional params for access_log. For example, buffer=16k, gzip, flush=1m

References: https://nginx.org/en/docs/http/ngx_http_log_module.html#access_log

access-log-path ¶

Access log path for both http and stream context. Goes to /var/log/nginx/access.log by default.

Note: the file /var/log/nginx/access.log is a symlink to /dev/stdout

http-access-log-path ¶

Access log path for http context globally. default: ""

Note: If not specified, the access-log-path will be used.

stream-access-log-path ¶

Access log path for stream context globally. default: ""

Note: If not specified, the access-log-path will be used.

enable-access-log-for-default-backend ¶

Enables logging access to default backend. default: is disabled.

error-log-path ¶

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: https://nginx.org/en/docs/ngx_core_module.html#error_log

enable-modsecurity ¶

Enables the modsecurity module for NGINX. default: is disabled

enable-owasp-modsecurity-crs ¶

Enables the OWASP ModSecurity Core Rule Set (CRS). default: is disabled

modsecurity-snippet ¶

Adds custom rules to modsecurity section of nginx configuration

client-header-buffer-size ¶

Allows to configure a custom buffer size for reading client request header.

References: https://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: https://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: https://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: https://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. default: false

References: https://nginx.org/en/docs/http/ngx_http_log_module.html#access_log

disable-ipv6 ¶

Disable listening on IPV6. default: false; IPv6 listening is enabled

disable-ipv6-dns ¶

Disable IPV6 for nginx DNS resolver. default: false; IPv6 resolving enabled.

enable-underscores-in-headers ¶

Enables underscores in header names. default: is disabled

enable-ocsp ¶

Enables Online Certificate Status Protocol stapling (OCSP) support. default: is disabled

ignore-invalid-headers ¶

Set if header fields with invalid names should be ignored. default: is enabled

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: https://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

http2-max-requests ¶

Sets the maximum number of requests (including push requests) that can be served through one HTTP/2 connection, after which the next client request will lead to connection closing and the need of establishing a new connection.

References: https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_requests

http2-max-concurrent-streams ¶

Sets the maximum number of concurrent HTTP/2 streams in a connection.

References: https://nginx.org/en/docs/http/ngx_http_v2_module.html#http2_max_concurrent_streams

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).

keep-alive ¶

Sets the time, in seconds, during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections.

References: https://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout

Changes with nginx 1.19.7                                        16 Feb 2021

    *) Change: connections handling in HTTP/2 has been changed to better
       match HTTP/1.x; the "http2_recv_timeout", "http2_idle_timeout", and
       "http2_max_requests" directives have been removed, the
       "keepalive_timeout" and "keepalive_requests" directives should be
       used instead.

References: nginx change log nginx issue tracker nginx mailing list

keep-alive-requests ¶

Sets the maximum number of requests that can be served through one keep-alive connection.

References: https://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: https://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers

log-format-escape-none ¶

Sets if the escape parameter is disabled entirely for character escaping in variables ("true") or controlled by log-format-escape-json ("false") Sets the nginx log format.

log-format-escape-json ¶

Sets if the escape parameter allows JSON ("true") or default characters escaping in variables ("false") Sets the nginx log format.

log-format-upstream ¶

Sets the nginx log format. Example for json output:

log-format-upstream: '{"time": "$time_iso8601", "remote_addr": "$proxy_protocol_addr", "x_forwarded_for": "$proxy_add_x_forwarded_for", "request_id": "$req_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 the log-format for definition of each field.

log-format-stream ¶

Sets the nginx stream format.

enable-multi-accept ¶

If disabled, a worker process will accept one new connection at a time. Otherwise, a worker process will accept all new connections at a time. default: true

References: https://nginx.org/en/docs/ngx_core_module.html#multi_accept

max-worker-connections ¶

Sets the maximum number of simultaneous connections that can be opened by each worker process. 0 will use the value of max-worker-open-files. default: 16384

max-worker-open-files ¶

Sets the maximum number of files that can be opened by each worker process. The default of 0 means "max open files (system's limit) - 1024". default: 0

map-hash-bucket-size ¶

Sets the bucket size for the map variables hash tables. The details of setting up hash tables are provided in a separate document.

proxy-real-ip-cidr ¶

If use-forwarded-headers or use-proxy-protocol is enabled, proxy-real-ip-cidr defines the default IP/network address of your external load balancer. Can be a comma-separated list of CIDR blocks. default: "0.0.0.0/0"

proxy-set-headers ¶

Sets custom headers from named configmap before sending traffic to backends. The value format is namespace/name. See example

server-name-hash-max-size ¶

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: https://nginx.org/en/docs/hash.html

server-name-hash-bucket-size ¶

Sets the size of the bucket for the server names hash tables.

References:

• https://nginx.org/en/docs/hash.html
• https://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:

• https://nginx.org/en/docs/hash.html
• https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_headers_hash_max_size

reuse-port ¶

Instructs NGINX to create an individual listening socket for each worker process (using the SO_REUSEPORT socket option), allowing a kernel to distribute incoming connections between worker processes default: true

proxy-headers-hash-bucket-size ¶

Sets the size of the bucket for the proxy headers hash tables.

References:

• https://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. default: is disabled

ssl-ciphers ¶

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-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384.

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.

DHE-based cyphers will not be available until DH parameter is configured Custom DH parameters for perfect forward secrecy

Please check the Mozilla SSL Configuration Generator.

Note: ssl_prefer_server_ciphers directive will be enabled by default for http context.

ssl-ecdh-curve ¶

Specifies a curve for ECDHE ciphers.

References: https://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://wiki.openssl.org/index.php/Diffie-Hellman_parameters
• https://wiki.mozilla.org/Security/Server_Side_TLS#DHE_handshake_and_dhparam
• https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_dhparam

ssl-protocols ¶

Sets the SSL protocols to use. The default is: TLSv1.2 TLSv1.3.

Please check the result of the configuration using https://ssllabs.com/ssltest/analyze.html or https://testssl.sh.

ssl-early-data ¶

Enables or disables TLS 1.3 early data, also known as Zero Round Trip Time Resumption (0-RTT).

This requires ssl-protocols to have TLSv1.3 enabled. Enable this with caution, because requests sent within early data are subject to replay attacks.

ssl_early_data. The default is: false.

ssl-session-cache ¶

Enables or disables the use of shared SSL cache among worker processes.

ssl-session-cache-size ¶

Sets the size of the SSL shared session cache between all worker processes.

ssl-session-tickets ¶

Enables or disables session resumption through TLS 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. To create a ticket: openssl rand 80 | openssl enc -A -base64

TLS session ticket-key, by default, a randomly generated key is used.

ssl-session-timeout ¶

Sets the time during which a client may reuse the session parameters stored in a cache.

ssl-buffer-size ¶

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: https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/

use-proxy-protocol ¶

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).

proxy-protocol-header-timeout ¶

Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinitely on a dropped connection. default: 5s

enable-aio-write ¶

Enables or disables the directive aio_write that writes files asynchronously. default: true

use-gzip ¶

Enables or disables compression of HTTP responses using the "gzip" module. MIME types to compress are controlled by gzip-types. default: false

use-geoip ¶

Enables or disables "geoip" module that creates variables with values depending on the client IP address, using the precompiled MaxMind databases. default: true

Note: MaxMind legacy databases are discontinued and will not receive updates after 2019-01-02, cf. discontinuation notice. Consider use-geoip2 below.

use-geoip2 ¶

Enables the geoip2 module for NGINX. Since 0.27.0 and due to a change in the MaxMind databases a license is required to have access to the databases. For this reason, it is required to define a new flag --maxmind-license-key in the ingress controller deployment to download the databases needed during the initialization of the ingress controller. Alternatively, it is possible to use a volume to mount the files /etc/ingress-controller/geoip/GeoLite2-City.mmdb and /etc/ingress-controller/geoip/GeoLite2-ASN.mmdb, avoiding the overhead of the download.

default: false

geoip2-autoreload-in-minutes ¶

Enables the geoip2 module autoreload in MaxMind databases setting the interval in minutes.

default: 0

enable-brotli ¶

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. default: false

Note: Brotli does not works in Safari < 11. For more information see https://caniuse.com/#feat=brotli

brotli-level ¶

Sets the Brotli Compression Level that will be used. default: 4

brotli-min-length ¶

Minimum length of responses, in bytes, that will be eligible for brotli compression. default: 20

brotli-types ¶

Sets the MIME Types that will be compressed on-the-fly by brotli. default: 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 support in secure connections.

gzip-disable ¶

Disables gzipping of responses for requests with "User-Agent" header fields matching any of the specified regular expressions.

gzip-level ¶

Sets the gzip Compression Level that will be used. default: 1

gzip-min-length ¶

Minimum length of responses to be returned to the client before it is eligible for gzip compression, in bytes. default: 256

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. default: 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 ¶

Sets the number of worker processes. The default of "auto" means number of available CPU cores.

worker-cpu-affinity ¶

Binds worker processes to the sets of CPUs. worker_cpu_affinity. By default worker processes are not bound to any specific CPUs. The value can be:

• "": empty string indicate no affinity is applied.
• cpumask: e.g. 0001 0010 0100 1000 to bind processes to specific cpus.
• auto: binding worker processes automatically to available CPUs.

worker-shutdown-timeout ¶

Sets a timeout for Nginx to wait for worker to gracefully shutdown. default: "240s"

load-balance ¶

Sets the algorithm to use for load balancing. The value can either be:

• round_robin: to use the default round robin loadbalancer
• ewma: to use the Peak EWMA method for routing (implementation)

The default is round_robin.

• To load balance using consistent hashing of IP or other variables, consider the nginx.ingress.kubernetes.io/upstream-hash-by annotation.
• To load balance using session cookies, consider the nginx.ingress.kubernetes.io/affinity annotation.

References: https://nginx.org/en/docs/http/load_balancing.html

variables-hash-bucket-size ¶

Sets the bucket size for the variables hash table.

References: https://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_bucket_size

variables-hash-max-size ¶

Sets the maximum size of the variables hash table.

References: https://nginx.org/en/docs/http/ngx_http_map_module.html#variables_hash_max_size

upstream-keepalive-connections ¶

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: 320

References: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive

upstream-keepalive-time ¶

Sets the maximum time during which requests can be processed through one keepalive connection. default: "1h"

References: http://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_time

upstream-keepalive-timeout ¶

Sets a timeout during which an idle keepalive connection to an upstream server will stay open. default: 60

References: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_timeout

upstream-keepalive-requests ¶

Sets the maximum number of requests that can be served through one keepalive connection. After the maximum number of requests is made, the connection is closed. default: 10000

References: https://nginx.org/en/docs/http/ngx_http_upstream_module.html#keepalive_requests

limit-conn-zone-variable ¶

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.

proxy-stream-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.

References: https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_timeout

proxy-stream-next-upstream ¶

When a connection to the proxied server cannot be established, determines whether a client connection will be passed to the next server.

References: https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream

proxy-stream-next-upstream-timeout ¶

Limits the time allowed to pass a connection to the next server. The 0 value turns off this limitation.

References: https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_timeout

proxy-stream-next-upstream-tries ¶

Limits the number of possible tries a request should be passed to the next server. The 0 value turns off this limitation.

References: https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_next_upstream_tries

proxy-stream-responses ¶

Sets the number of datagrams expected from the proxied server in response to the client request if the UDP protocol is used.

References: https://nginx.org/en/docs/stream/ngx_stream_proxy_module.html#proxy_responses

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.

use-forwarded-headers ¶

If true, NGINX passes the incoming X-Forwarded-* headers to upstreams. Use this option when NGINX is behind another L7 proxy / load balancer that is setting these headers.

If false, NGINX ignores incoming X-Forwarded-* headers, filling them with the request information it sees. Use this option if NGINX is exposed directly to the internet, or it's behind a L3/packet-based load balancer that doesn't alter the source IP in the packets.

enable-real-ip ¶

enable-real-ip enables the configuration of https://nginx.org/en/docs/http/ngx_http_realip_module.html. Specific attributes of the module can be configured further by using forwarded-for-header and proxy-real-ip-cidr settings.

forwarded-for-header ¶

Sets the header field for identifying the originating IP address of a client. default: 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.

proxy-add-original-uri-header ¶

Adds an X-Original-Uri header with the original request URI to the backend request

generate-request-id ¶

Ensures that X-Request-ID is defaulted to a random value, if no X-Request-ID is present in the request

jaeger-collector-host ¶

Specifies the host to use when uploading traces. It must be a valid URL.

jaeger-collector-port ¶

Specifies the port to use when uploading traces. default: 6831

jaeger-endpoint ¶

Specifies the endpoint to use when uploading traces to a collector. This takes priority over jaeger-collector-host if both are specified.

jaeger-service-name ¶

Specifies the service name to use for any traces created. default: nginx

jaeger-propagation-format ¶

Specifies the traceparent/tracestate propagation format. default: jaeger

jaeger-sampler-type ¶

Specifies the sampler to be used when sampling traces. The available samplers are: const, probabilistic, ratelimiting, remote. default: const

jaeger-sampler-param ¶

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

jaeger-sampler-host ¶

Specifies the custom remote sampler host to be passed to the sampler constructor. Must be a valid URL. Leave blank to use default value (localhost). default: http://127.0.0.1

jaeger-sampler-port ¶

Specifies the custom remote sampler port to be passed to the sampler constructor. Must be a number. default: 5778

jaeger-trace-context-header-name ¶

Specifies the header name used for passing trace context. default: uber-trace-id

jaeger-debug-header ¶

Specifies the header name used for force sampling. default: jaeger-debug-id

jaeger-baggage-header ¶

Specifies the header name used to submit baggage if there is no root span. default: jaeger-baggage

jaeger-tracer-baggage-header-prefix ¶

Specifies the header prefix used to propagate baggage. default: uberctx-

datadog-collector-host ¶

Specifies the datadog agent host to use when uploading traces. It must be a valid URL.

datadog-collector-port ¶

Specifies the port to use when uploading traces. default: 8126

datadog-service-name ¶

Specifies the service name to use for any traces created. default: nginx

datadog-environment ¶

Specifies the environment this trace belongs to. default: prod

datadog-operation-name-override ¶

Overrides the operation name to use for any traces crated. default: nginx.handle

datadog-priority-sampling ¶

Specifies to use client-side sampling. If true disables client-side sampling (thus ignoring sample_rate) and enables distributed priority sampling, where traces are sampled based on a combination of user-assigned priorities and configuration from the agent. default: true

datadog-sample-rate ¶

Specifies sample rate for any traces created. This is effective only when datadog-priority-sampling is false default: 1.0

enable-opentelemetry ¶

Enables the nginx OpenTelemetry extension. default: is disabled

References: https://github.com/open-telemetry/opentelemetry-cpp-contrib

opentelemetry-operation-name ¶

Specifies a custom name for the server span. default: is empty

For example, set to "HTTP $request_method $uri".

otlp-collector-host ¶

Specifies the host to use when uploading traces. It must be a valid URL.

otlp-collector-port ¶

Specifies the port to use when uploading traces. default: 4317

otel-service-name ¶

Specifies the service name to use for any traces created. default: nginx

opentelemetry-trust-incoming-span: "true" ¶

Enables or disables using spans from incoming requests as parent for created ones. default: true

otel-sampler-parent-based ¶

Uses sampler implementation which by default will take a sample if parent Activity is sampled. default: false

otel-sampler-ratio ¶

Specifies sample rate for any traces created. default: 0.01

otel-sampler ¶

Specifies the sampler to be used when sampling traces. The available samplers are: AlwaysOff, AlwaysOn, TraceIdRatioBased, remote. default: AlwaysOff

main-snippet ¶

Adds custom configuration to the main section of the nginx configuration.

http-snippet ¶

Adds custom configuration to the http section of the nginx configuration.

server-snippet ¶

Adds custom configuration to all the servers in the nginx configuration.

stream-snippet ¶

Adds custom configuration to the stream section of the nginx configuration.

location-snippet ¶

Adds custom configuration to all the locations in the nginx configuration.

You can not use this to add new locations that proxy to the Kubernetes pods, as the snippet does not have access to the Go template functions. If you want to add custom locations you will have to provide your own nginx.tmpl.

custom-http-errors ¶

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

proxy-body-size ¶

Sets the maximum allowed size of the client request body. See NGINX client_max_body_size.

proxy-connect-timeout ¶

Sets the timeout for establishing a connection with a proxied server. It should be noted that this timeout cannot usually exceed 75 seconds.

It will also set the grpc_connect_timeout for gRPC connections.

proxy-read-timeout ¶

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.

It will also set the grpc_read_timeout for gRPC connections.

proxy-send-timeout ¶

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.

It will also set the grpc_send_timeout for gRPC connections.

proxy-buffers-number ¶

Sets the number 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.

proxy-buffer-size ¶

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.

proxy-cookie-path ¶

Sets a text that should be changed in the path attribute of the “Set-Cookie” header fields of a proxied server response.

proxy-cookie-domain ¶

Sets a text that should be changed in the domain attribute of the “Set-Cookie” header fields of a proxied server response.

proxy-next-upstream ¶

Specifies in which cases a request should be passed to the next server.

proxy-next-upstream-timeout ¶

Limits the time in seconds during which a request can be passed to the next server.

proxy-next-upstream-tries ¶

Limit the number of possible tries a request should be passed to the next server.

proxy-redirect-from ¶

Sets the original text that should be changed in the "Location" and "Refresh" header fields of a proxied server response. default: off

References: https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_redirect

proxy-request-buffering ¶

Enables or disables buffering of a client request body.

ssl-redirect ¶

Sets the global value of redirects (301) to HTTPS if the server has a TLS certificate (defined in an Ingress rule). default: "true"

force-ssl-redirect ¶

Sets the global value of redirects (308) to HTTPS if the server has a default TLS certificate (defined in extra-args). default: "false"

denylist-source-range ¶

Sets the default denylisted IPs for each server block. This can be overwritten by an annotation on an Ingress rule. See ngx_http_access_module.

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.

skip-access-log-urls ¶

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. default: is empty

limit-rate ¶

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: https://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate

limit-rate-after ¶

Sets the initial amount after which the further transmission of a response to a client will be rate limited.

References: https://nginx.org/en/docs/http/ngx_http_core_module.html#limit_rate_after

lua-shared-dicts ¶

Customize default Lua shared dictionaries or define more. You can use the following syntax to do so:

lua-shared-dicts: "<my dict name>: <my dict size>, [<my dict name>: <my dict size>], ..."

For example following will set default certificate_data dictionary to 100M and will introduce a new dictionary called my_custom_plugin:

lua-shared-dicts: "certificate_data: 100, my_custom_plugin: 5"

You can optionally set a size unit to allow for kilobyte-granularity. Allowed units are 'm' or 'k' (case-insensitive), and it defaults to MB if no unit is provided. Here is a similar example, but the my_custom_plugin dict is only 512KB.

lua-shared-dicts: "certificate_data: 100, my_custom_plugin: 512k"

http-redirect-code ¶

Sets the HTTP status code to be used in redirects. Supported codes are 301,302,307 and 308 default: 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 we send a redirect in methods like POST.

proxy-buffering ¶

Enables or disables buffering of responses from the proxied server.

limit-req-status-code ¶

Sets the status code to return in response to rejected requests. default: 503

limit-conn-status-code ¶

Sets the status code to return in response to rejected connections. default: 503

enable-syslog ¶

Enable syslog feature for access log and error log. default: false

syslog-host ¶

Sets the address of syslog server. The address can be specified as a domain name or IP address.

syslog-port ¶

Sets the port of syslog server. default: 514

no-tls-redirect-locations ¶

A comma-separated list of locations on which http requests will never get redirected to their https counterpart. default: "/.well-known/acme-challenge"

global-allowed-response-headers ¶

A comma-separated list of allowed response headers inside the custom headers annotations

global-auth-url ¶

A url to an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-url. Locations that should not get authenticated can be listed using no-auth-locations See no-auth-locations. In addition, each service can be excluded from authentication via annotation enable-global-auth set to "false". default: ""

References: https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md#external-authentication

global-auth-method ¶

A HTTP method to use for an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-method. default: ""

global-auth-signin ¶

Sets the location of the error page for an existing service that provides authentication for all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-signin. default: ""

global-auth-signin-redirect-param ¶

Sets the query parameter in the error page signin URL which contains the original URL of the request that failed authentication. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-signin-redirect-param. default: "rd"

global-auth-response-headers ¶

Sets the headers to pass to backend once authentication request completes. Applied to all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-response-headers. default: ""

global-auth-request-redirect ¶

Sets the X-Auth-Request-Redirect header value. Applied to all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-request-redirect. default: ""

global-auth-snippet ¶

Sets a custom snippet to use with external authentication. Applied to all the locations. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/auth-snippet. default: ""

global-auth-cache-key ¶

Enables caching for global auth requests. Specify a lookup key for auth responses, e.g. $remote_user$http_authorization.

global-auth-cache-duration ¶

Set a caching time for auth responses based on their response codes, e.g. 200 202 30m. See proxy_cache_valid for details. You may specify multiple, comma-separated values: 200 202 10m, 401 5m. defaults to 200 202 401 5m.

global-auth-always-set-cookie ¶

Always set a cookie returned by auth request. By default, the cookie will be set only if an upstream reports with the code 200, 201, 204, 206, 301, 302, 303, 304, 307, or 308. default: false

no-auth-locations ¶

A comma-separated list of locations that should not get authenticated. default: "/.well-known/acme-challenge"

block-cidrs ¶

A comma-separated list of IP addresses (or subnets), request from which have to be blocked globally.

References: https://nginx.org/en/docs/http/ngx_http_access_module.html#deny

block-user-agents ¶

A comma-separated list of User-Agent, request from which have to be blocked globally. It's possible to use here full strings and regular expressions. More details about valid patterns can be found at map Nginx directive documentation.

References: https://nginx.org/en/docs/http/ngx_http_map_module.html#map

block-referers ¶

A comma-separated list of Referers, request from which have to be blocked globally. It's possible to use here full strings and regular expressions. More details about valid patterns can be found at map Nginx directive documentation.

References: https://nginx.org/en/docs/http/ngx_http_map_module.html#map

proxy-ssl-location-only ¶

Set if proxy-ssl parameters should be applied only on locations and not on servers. default: is disabled

default-type ¶

Sets the default MIME type of a response. default: text/html

References: https://nginx.org/en/docs/http/ngx_http_core_module.html#default_type

service-upstream ¶

Set if the service's Cluster IP and port should be used instead of a list of all endpoints. This can be overwritten by an annotation on an Ingress rule. default: "false"

ssl-reject-handshake ¶

Set to reject SSL handshake to an unknown virtualhost. This parameter helps to mitigate the fingerprinting using default certificate of ingress. default: "false"

References: https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_reject_handshake

debug-connections ¶

Enables debugging log for selected client connections. default: ""

References: http://nginx.org/en/docs/ngx_core_module.html#debug_connection

strict-validate-path-type ¶

Ingress objects contains a field called pathType that defines the proxy behavior. It can be Exact, Prefix and ImplementationSpecific.

When pathType is configured as Exact or Prefix, there should be a more strict validation, allowing only paths starting with "/" and containing only alphanumeric characters and "-", "_" and additional "/".

When this option is enabled, the validation will happen on the Admission Webhook, making any Ingress not using pathType ImplementationSpecific and containing invalid characters to be denied.

This means that Ingress objects that rely on paths containing regex characters should use ImplementationSpecific pathType.

The cluster admin should establish validation rules using mechanisms like Open Policy Agent to validate that only authorized users can use ImplementationSpecific pathType and that only the authorized characters can be used.

default: "true"

grpc-buffer-size-kb ¶

Sets the configuration for the GRPC Buffer Size parameter. If not set it will use the default from NGINX.

References: https://nginx.org/en/docs/http/ngx_http_grpc_module.html#grpc_buffer_size

relative-redirects ¶

Use relative redirects instead of absolute redirects. Absolute redirects are the default in nginx. RFC7231 allows relative redirects since 2014. Similar to the Ingress rule annotation nginx.ingress.kubernetes.io/relative-redirects.

default: "false"

References: - https://nginx.org/en/docs/http/ngx_http_core_module.html#absolute_redirect - https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.2