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

replace '‑' with actual dashes '-' (#2111)

Browse source
This commit is contained in:
Victor Trac 2018-02-16 17:02:41 -06:00 committed by Manuel Alejandro de Brito Fontes
parent b02c0f502a
commit 131fdf1e01
1 changed files with 103 additions and 103 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -25,110 +25,110 @@ The following table shows a configuration option's name, type, and the default v
|name|type|default|
|:---|:---|:------|
|[add‑headers](#add-headers)|string|""|
|[allow‑backend‑server‑header](#allow-backend-server-header)|bool|"false"|
|[hide‑headers](#hide-headers)|string array|empty|
|[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|
|[disable‑ipv6‑dns](#disable-ipv6-dns)|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"|
|[add-headers](#add-headers)|string|""|
|[allow-backend-server-header](#allow-backend-server-header)|bool|"false"|
|[hide-headers](#hide-headers)|string array|empty|
|[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|
|[disable-ipv6-dns](#disable-ipv6-dns)|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&#8209;name&#8209;hash&#8209;bucket&#8209;size](#server-name-hash-bucket-size)|int|`<size of the processor’s cache line>`
|[proxy&#8209;headers&#8209;hash&#8209;max&#8209;size](#proxy-headers-hash-max-size)|int|512|
|[proxy&#8209;headers&#8209;hash&#8209;bucket&#8209;size](#proxy-headers-hash-bucket-size)|int|64|
|[server&#8209;tokens](#server-tokens)|bool|"true"|
|[ssl&#8209;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&#8209;ecdh&#8209;curve](#ssl-ecdh-curve)|string|"auto"|
|[ssl&#8209;dh&#8209;param](#ssl-dh-param)|string|""|
|[ssl&#8209;protocols](#ssl-protocols)|string|"TLSv1.2"|
|[ssl&#8209;session&#8209;cache](#ssl-session-cache)|bool|"true"|
|[ssl&#8209;session&#8209;cache&#8209;size](#ssl-session-cache-size)|string|"10m"|
|[ssl&#8209;session&#8209;tickets](#ssl-session-tickets)|bool|"true"|
|[ssl&#8209;session&#8209;ticket&#8209;key](#ssl-session-ticket-key)|string|`<Randomly Generated>`
|[ssl&#8209;session&#8209;timeout](#ssl-session-timeout)|string|"10m"|
|[ssl&#8209;buffer&#8209;size](#ssl-buffer-size)|string|"4k"|
|[use&#8209;proxy&#8209;protocol](#use-proxy-protocol)|bool|"false"|
|[use&#8209;gzip](#use-gzip)|bool|"true"|
|[enable&#8209;brotli](#enable-brotli)|bool|"true"|
|[brotli&#8209;level](#brotli-level)|int|4|
|[brotli&#8209;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&#8209;http2](#use-http2)|bool|"true"|
|[gzip&#8209;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&#8209;processes](#worker-processes)|string|`<Number of CPUs>`|
|[worker&#8209;shutdown&#8209;timeout](#worker-shutdown-timeout)|string|"10s"|
|[load&#8209;balance](#load-balance)|string|"least_conn"|
|[variables&#8209;hash&#8209;bucket&#8209;size](#variables-hash-bucket-size)|int|128|
|[variables&#8209;hash&#8209;max&#8209;size](#variables-hash-max-size)|int|2048|
|[upstream&#8209;keepalive&#8209;connections](#upstream-keepalive-connections)|int|32|
|[limit&#8209;conn&#8209;zone&#8209;variable](#limit-conn-zone-variable)|string|"$binary_remote_addr"|
|[proxy&#8209;stream&#8209;timeout](#proxy-stream-timeout)|string|"600s"|
|[proxy&#8209;stream&#8209;responses](#proxy-stream-responses)|int|1|
|[bind&#8209;address&#8209;ipv4](#bind-address-ipv4)|[]string|""|
|[bind&#8209;address&#8209;ipv6](#bind-address-ipv6)|[]string|""|
|[forwarded&#8209;for&#8209;header](#forwarded-for-header)|string|"X-Forwarded-For"|
|[compute&#8209;full&#8209;forwarded&#8209;for](#compute-full-forwarded-for)|bool|"false"|
|[enable&#8209;opentracing](#enable-opentracing)|bool|"false"|
|[zipkin&#8209;collector&#8209;host](#zipkin-collector-host)|string|""|
|[zipkin&#8209;collector&#8209;port](#zipkin-collector-port)|int|9411|
|[zipkin&#8209;service&#8209;name](#zipkin-service-name)|string|"nginx"|
|[jaeger&#8209;collector&#8209;host](#jaeger-collector-host)|string|""|
|[jaeger&#8209;collector&#8209;port](#jaeger-collector-port)|int|6831|
|[jaeger&#8209;service&#8209;name](#jaeger-service-name)|string|"nginx"|
|[jaeger&#8209;sampler&#8209;type](#jaeger-sampler-type)|string|"const"|
|[jaeger&#8209;sampler&#8209;param](#jaeger-sampler-param)|string|"1"|
|[http&#8209;snippet](#http-snippet)|string|""|
|[server&#8209;snippet](#server-snippet)|string|""|
|[location&#8209;snippet](#location-snippet)|string|""|
|[custom&#8209;http&#8209;errors](#custom-http-errors)|[]int]|[]int{}|
|[proxy&#8209;body&#8209;size](#proxy-body-size)|string|"1m"|
|[proxy&#8209;connect&#8209;timeout](#proxy-connect-timeout)|int|5|
|[proxy&#8209;read&#8209;timeout](#proxy-read-timeout)|int|60|
|[proxy&#8209;send&#8209;timeout](#proxy-send-timeout)|int|60|
|[proxy&#8209;buffer&#8209;size](#proxy-buffer-size)|string|"4k"|
|[proxy&#8209;cookie&#8209;path](#proxy-cookie-path)|string|"off"|
|[proxy&#8209;cookie&#8209;domain](#proxy-cookie-domain)|string|"off"|
|[proxy&#8209;next&#8209;upstream](#proxy-next-upstream)|string|"error timeout invalid_header http_502 http_503 http_504"|
|[proxy&#8209;redirect&#8209;from](#proxy-redirect-from)|string|"off"|
|[proxy&#8209;request&#8209;buffering](#proxy-request-buffering)|string|"on"|
|[ssl&#8209;redirect](#ssl-redirect)|bool|"true"|
|[whitelist&#8209;source&#8209;range](#whitelist-source-range)|[]string|[]string{}|
|[skip&#8209;access&#8209;log&#8209;urls](#skip-access-log-urls)|[]string|[]string{}|
|[limit&#8209;rate](#limit-rate)|int|0|
|[limit&#8209;rate&#8209;after](#limit-rate-after)|int|0|
|[http&#8209;redirect&#8209;code](#http-redirect-code)|int|308|
|[proxy&#8209;buffering](#proxy-buffering)|string|"off"|
|[limit&#8209;request&#8209;status&#8209;code](#limit-request-status-code)|int|503|
|[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|`<size of the processor’s cache line>`
|[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|`<Randomly Generated>`
|[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|`<Number of CPUs>`|
|[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"|
|[proxy-stream-responses](#proxy-stream-responses)|int|1|
|[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"|
|[jaeger-collector-host](#jaeger-collector-host)|string|""|
|[jaeger-collector-port](#jaeger-collector-port)|int|6831|
|[jaeger-service-name](#jaeger-service-name)|string|"nginx"|
|[jaeger-sampler-type](#jaeger-sampler-type)|string|"const"|
|[jaeger-sampler-param](#jaeger-sampler-param)|string|"1"|
|[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|
|[http-redirect-code](#http-redirect-code)|int|308|
|[proxy-buffering](#proxy-buffering)|string|"off"|
|[limit-request-status-code](#limit-request-status-code)|int|503|
## add-headers