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

Add comment about bolean and number values (#1991)

Browse source
This commit is contained in:
Manuel Alejandro de Brito Fontes 2018-01-26 16:36:12 -03:00 • committed by GitHub
parent 259a7fcaf3
commit efec983ed4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 48 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/user-guide/annotations.md
View file

@ -1,10 +1,16 @@
**IMPORTANT:**
The key and values in annotations 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".
# Annotations
The following annotations are supported:
|Name | type |
|---------------------------|------|
|[nginx.ingress.kubernetes.io/add-base-url](#rewrite)|true or false|
|[nginx.ingress.kubernetes.io/add-base-url](#rewrite)|"true" or "false"|
|[nginx.ingress.kubernetes.io/app-root](#rewrite)|string|
|[nginx.ingress.kubernetes.io/affinity](#session-affinity)|cookie|
|[nginx.ingress.kubernetes.io/auth-realm](#authentication)|string|
@ -14,20 +20,20 @@ The following annotations are supported:
|[nginx.ingress.kubernetes.io/auth-tls-verify-depth](#certificate-authentication)|number|
|[nginx.ingress.kubernetes.io/auth-tls-verify-client](#certificate-authentication)|string|
|[nginx.ingress.kubernetes.io/auth-tls-error-page](#certificate-authentication)|string|
|[nginx.ingress.kubernetes.io/auth-tls-pass-certificate-to-upstream](#certificate-authentication)|true or false|
|[nginx.ingress.kubernetes.io/auth-tls-pass-certificate-to-upstream](#certificate-authentication)|"true" or "false"|
|[nginx.ingress.kubernetes.io/auth-url](#external-authentication)|string|
|[nginx.ingress.kubernetes.io/base-url-scheme](#rewrite)|string|
|[nginx.ingress.kubernetes.io/client-body-buffer-size](#client-body-buffer-size)|string|
|[nginx.ingress.kubernetes.io/configuration-snippet](#configuration-snippet)|string|
|[nginx.ingress.kubernetes.io/default-backend](#default-backend)|string|
|[nginx.ingress.kubernetes.io/enable-cors](#enable-cors)|true or false|
|[nginx.ingress.kubernetes.io/enable-cors](#enable-cors)|"true" or "false"|
|[nginx.ingress.kubernetes.io/cors-allow-origin](#enable-cors)|string|
|[nginx.ingress.kubernetes.io/cors-allow-methods](#enable-cors)|string|
|[nginx.ingress.kubernetes.io/cors-allow-headers](#enable-cors)|string|
|[nginx.ingress.kubernetes.io/cors-allow-credentials](#enable-cors)|true or false|
|[nginx.ingress.kubernetes.io/cors-allow-credentials](#enable-cors)|"true" or "false"|
|[nginx.ingress.kubernetes.io/cors-max-age](#enable-cors)|number|
|[nginx.ingress.kubernetes.io/force-ssl-redirect](#server-side-https-enforcement-through-redirect)|true or false|
|[nginx.ingress.kubernetes.io/from-to-www-redirect](#redirect-from-to-www)|true or false|
|[nginx.ingress.kubernetes.io/force-ssl-redirect](#server-side-https-enforcement-through-redirect)|"true" or "false"|
|[nginx.ingress.kubernetes.io/from-to-www-redirect](#redirect-from-to-www)|"true" or "false"|
|[nginx.ingress.kubernetes.io/limit-connections](#rate-limiting)|number|
|[nginx.ingress.kubernetes.io/limit-rps](#rate-limiting)|number|
|[nginx.ingress.kubernetes.io/proxy-body-size](#custom-max-body-size)|string|
@ -39,14 +45,14 @@ The following annotations are supported:
|[nginx.ingress.kubernetes.io/proxy-redirect-from](#proxy-redirect)|string|
|[nginx.ingress.kubernetes.io/proxy-redirect-to](#proxy-redirect)|string|
|[nginx.ingress.kubernetes.io/rewrite-target](#rewrite)|URI|
|[nginx.ingress.kubernetes.io/secure-backends](#secure-backends)|true or false|
|[nginx.ingress.kubernetes.io/secure-backends](#secure-backends)|"true" or "false"|
|[nginx.ingress.kubernetes.io/server-alias](#server-alias)|string|
|[nginx.ingress.kubernetes.io/server-snippet](#server-snippet)|string|
|[nginx.ingress.kubernetes.io/service-upstream](#service-upstream)|true or false|
|[nginx.ingress.kubernetes.io/service-upstream](#service-upstream)|"true" or "false"|
|[nginx.ingress.kubernetes.io/session-cookie-name](#cookie-affinity)|string|
|[nginx.ingress.kubernetes.io/session-cookie-hash](#cookie-affinity)|string|
|[nginx.ingress.kubernetes.io/ssl-redirect](#server-side-https-enforcement-through-redirect)|true or false|
|[nginx.ingress.kubernetes.io/ssl-passthrough](#ssl-passthrough)|true or false|
|[nginx.ingress.kubernetes.io/ssl-redirect](#server-side-https-enforcement-through-redirect)|"true" or "false"|
|[nginx.ingress.kubernetes.io/ssl-passthrough](#ssl-passthrough)|"true" or "false"|
|[nginx.ingress.kubernetes.io/upstream-max-fails](#custom-nginx-upstream-checks)|number|
|[nginx.ingress.kubernetes.io/upstream-fail-timeout](#custom-nginx-upstream-checks)|number|
|[nginx.ingress.kubernetes.io/upstream-hash-by](#custom-nginx-upstream-hashing)|string|

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

@ -13,6 +13,12 @@ data:
ssl-protocols: SSLv2
```
**IMPORTANT:**
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".
## Configuration options
The following table shows a configuration option's name, type, and the default value:
@ -20,36 +26,36 @@ 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|
|[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|
|[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|
|[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|
|[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](#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|
|[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‑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|
@ -60,23 +66,23 @@ The following table shows a configuration option's name, type, and the default v
|[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|
|[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](#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;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|
|[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|
|[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"|
@ -90,8 +96,8 @@ The following table shows a configuration option's name, type, and the default v
|[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|
|[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"|
@ -114,7 +120,7 @@ The following table shows a configuration option's name, type, and the default v
|[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|
|[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|
@ -194,7 +200,7 @@ _References:_
## disable-access-log
Disables the Access Log from the entire Ingress Controller. This is 'false' by default.
Disables the Access Log from the entire Ingress Controller. This is '"false"' by default.
_References:_
- http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log
@ -300,7 +306,7 @@ _References:_
## 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).
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