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

Merge pull request #1116 from tonglil/update-annotations-list

Browse source 
Update annotations list
This commit is contained in:
Manuel Alejandro de Brito Fontes 2017-08-12 09:14:51 -04:00 committed by GitHub
commit c950703726
1 changed files with 52 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

99
docs/annotations.md
View file

@ -1,74 +1,79 @@
# Ingress Annotations # Ingress Annotations
This file defines a list of annotations which are supported by various Ingress controllers (both those based on the common ingress code, and alternative implementations). The intention is to ensure the maximum amount of compatibility between different implementations. This file defines a list of annotations which are supported by various Ingress controllers (both those based on the common ingress code, and alternative implementations).
The intention is to ensure the maximum amount of compatibility between different implementations.
All annotations are assumed to be prefixed with `ingress.kubernetes.io/` except where otherwise specified. There is no attempt to record implementation-specific annotations using other prefixes. (Traefik in particular defines several of its own annotations which are not described here, and does not seem to support any of the standard annotations.) All annotations are assumed to be prefixed with `ingress.kubernetes.io/` except where otherwise specified.
There is no attempt to record implementation-specific annotations using other prefixes.
(Traefik in particular defines several of its own annotations which are not described here, and does not seem to support any of the standard annotations.)
Key: Key:
* `nginx`: the `kubernetes/ingress` nginx controller * `nginx`: the `kubernetes/ingress` nginx controller
* `gce`: the `kubernetes/ingress` GCE controller * `gce`: the `kubernetes/ingress` GCE controller
* `traefik`: Traefik's built-in Ingress controller * `traefik`: Traefik's built-in Ingress controller
* `haproxy`: Joao Morais' [HAProxy Ingress controller](https://github.com/jcmoraisjr/haproxy-ingress) * `haproxy`: Joao Morais' [HAProxy Ingress controller](https://github.com/jcmoraisjr/haproxy-ingress)
* `trafficserver`: Torchbox's [Apache Traffic Server controller plugin](https://github.com/torchbox/k8s-ts-ingress) * `trafficserver`: Torchbox's [Apache Traffic Server controller plugin](https://github.com/torchbox/k8s-ts-ingress)
## TLS-related ## TLS-related
| Name | Meaning | Name | Meaning | Default | Controller
| --- | --- | --- | --- | --- | --- |
| `ssl-passthrough` | Pass TLS connections directly to backend; do not offload. Default `false`. (nginx, haproxy) | `ssl-passthrough` | Pass TLS connections directly to backend; do not offload. | `false` | nginx, haproxy
| `ssl-redirect` | Redirect non-TLS requests to TLS when TLS is enabled. Default `true`. (nginx, haproxy, trafficserver) | `ssl-redirect` | Redirect non-TLS requests to TLS when TLS is enabled. | `true` | nginx, haproxy, trafficserver
| `force-ssl-redirect` | Redirect non-TLS requests to TLS even when TLS is not configured. Default `false`. (nginx, trafficserver). | `force-ssl-redirect` | Redirect non-TLS requests to TLS even when TLS is not configured. | `false` | nginx, trafficserver
| `secure-backends` | Use TLS to communicate with origin (pods). Default `false`. (nginx, haproxy, trafficserver) | `secure-backends` | Use TLS to communicate with origin (pods). | `false` | nginx, haproxy, trafficserver
| `kubernetes.io/ingress.allow-http` | Whether to accept non-TLS HTTP connections. (gce) | `kubernetes.io/ingress.allow-http` | Whether to accept non-TLS HTTP connections. | `true` | gce
| `hsts-max-age` | Set an HSTS header with this lifetime. (trafficserver) | `pre-shared-cert` | Name of the TLS certificate in GCP to use when provisioning the HTTPS load balancer. | empty string | gce
| `hsts-include-subdomains` | Add includeSubdomains to the HSTS header. (trafficserver) | `hsts-max-age` | Set an HSTS header with this lifetime. | | trafficserver
| `hsts-include-subdomains` | Add includeSubdomains to the HSTS header. | | trafficserver
## Authentication related ## Authentication related
| Name | Meaning | Name | Meaning | Default | Controller
| --- | --- | --- | --- | --- | --- |
| `auth-type` | Authentication type: `basic`, `digest`, ... (nginx, haproxy, trafficserver) | `auth-type` | Authentication type: `basic`, `digest`, ... | | nginx, haproxy, trafficserver
| `auth-secret` | Secret name for authentication. (nginx, haproxy, trafficserver) | `auth-secret` | Secret name for authentication. | | nginx, haproxy, trafficserver
| `auth-realm` | Authentication realm. (nginx, haproxy, trafficserver) | `auth-realm` | Authentication realm. | | nginx, haproxy, trafficserver
| `auth-tls-secret` | Name of secret for TLS client certification validation. (nginx, haproxy) | `auth-tls-secret` | Name of secret for TLS client certification validation. | | nginx, haproxy
| `auth-tls-verify-depth` | Maximum chain length of TLS client certificate. (nginx) | `auth-tls-verify-depth` | Maximum chain length of TLS client certificate. | | nginx
| `auth-satisfy` | Behaviour when more than one of `auth-type`, `auth-tls-secret` or `whitelist-source-range` are configured: `all` (default) or `any`. (trafficserver) | `trafficserver` | `auth-satisfy` | Behaviour when more than one of `auth-type`, `auth-tls-secret` or `whitelist-source-range` are configured: `all` or `any`. | `all` | trafficserver | `trafficserver`
| `whitelist-source-range` | Comma-separate list of IP addresses to enable access to. (nginx, haproxy, trafficserver) | `whitelist-source-range` | Comma-separate list of IP addresses to enable access to. | | nginx, haproxy, trafficserver
## URL related ## URL related
| Name | Meaning | Name | Meaning | Default | Controller
| --- | --- | --- | --- | --- | --- |
| `app-root` | Redirect requests without a path (i.e., for `/`) to this location. (nginx, haproxy, trafficserver) | `app-root` | Redirect requests without a path (i.e., for `/`) to this location. | | nginx, haproxy, trafficserver
| `rewrite-target` | Replace matched Ingress `path` with this value. (nginx, trafficserver) | `rewrite-target` | Replace matched Ingress `path` with this value. | | nginx, trafficserver
| `add-base-url` | Add `<base>` tag to HTML. (nginx) | `add-base-url` | Add `<base>` tag to HTML. | | nginx
| `preserve-host` | Whether to pass the client request host (`true`) or the origin hostname (`false`) in the HTTP Host field. (trafficserver) | `preserve-host` | Whether to pass the client request host (`true`) or the origin hostname (`false`) in the HTTP Host field. | | trafficserver
## Miscellaneous ## Miscellaneous
| Name | Meaning | Name | Meaning | Default | Controller
| --- | --- | --- | --- | --- | --- |
| `configuration-snippet` | Arbitrary text to put in the generated configuration file. (nginx) | `configuration-snippet` | Arbitrary text to put in the generated configuration file. | | nginx
| `enable-cors` | Enable CORS headers in response. (nginx) | `enable-cors` | Enable CORS headers in response. | | nginx
| `limit-connections` | Limit concurrent connections per IP address[1]. (nginx) | `limit-connections` | Limit concurrent connections per IP address[1]. | | nginx
| `limit-rps` | Limit requests per second per IP address[1]. (nginx) | `limit-rps` | Limit requests per second per IP address[1]. | | nginx
| `limit-rpm` | Limit requests per minute per IP address. (nginx) | `limit-rpm` | Limit requests per minute per IP address. | | nginx
| `affinity` | Specify a method to stick clients to origins across requests. Found in `nginx`, where the only supported value is `cookie`. (nginx) | `affinity` | Specify a method to stick clients to origins across requests. Found in `nginx`, where the only supported value is `cookie`. | | nginx
| `session-cookie-name` | When `affinity` is set to `cookie`, the name of the cookie to use. (nginx) | `session-cookie-name` | When `affinity` is set to `cookie`, the name of the cookie to use. | | nginx
| `session-cookie-hash` | When `affinity` is set to `cookie`, the hash algorithm used: `md5`, `sha`, `index`. (nginx) | `session-cookie-hash` | When `affinity` is set to `cookie`, the hash algorithm used: `md5`, `sha`, `index`. | | nginx
| `proxy-body-size` | Maximum request body size. (nginx, haproxy) | `proxy-body-size` | Maximum request body size. | | nginx, haproxy
| `follow-redirects` | Follow HTTP redirects in the response and deliver the redirect target to the client. (trafficserver) | `follow-redirects` | Follow HTTP redirects in the response and deliver the redirect target to the client. | | trafficserver
| `kubernetes.io/ingress.global-static-ip-name` | Name of the static global IP address in GCP to use when provisioning the HTTPS load balancer. | empty string | gce
[1] The documentation for the `nginx` controller says that only one of `limit-connections` or `limit-rps` may be specified; it's not clear why this is. [1] The documentation for the `nginx` controller says that only one of `limit-connections` or `limit-rps` may be specified; it's not clear why this is.
## Caching ## Caching
| Name | Meaning | Name | Meaning | Default | Controller
| --- | --- | --- | --- | --- | --- |
| `cache-enable` | Cache responses according to Expires or Cache-Control headers (trafficserver) | `cache-enable` | Cache responses according to Expires or Cache-Control headers. | | trafficserver
| `cache-generation` | An arbitrary numeric value included in the cache key; changing this effectively clears the cache for this ingress. (trafficserver) | `cache-generation` | An arbitrary numeric value included in the cache key; changing this effectively clears the cache for this ingress. | | trafficserver
| `cache-ignore-query-params` | Space-separate list of globs matching URL parameters to ignore when doing cache lookups. (trafficserver) | `cache-ignore-query-params` | Space-separate list of globs matching URL parameters to ignore when doing cache lookups. | | trafficserver
| `cache-whitelist-query-params` | Ignore any URL parameters not in this whitespace-separate list of globs. (trafficserver) | `cache-whitelist-query-params` | Ignore any URL parameters not in this whitespace-separate list of globs. | | trafficserver
| `cache-sort-query-params` | Lexically sort the query parameters by name before cache lookup. (trafficserver) | `cache-sort-query-params` | Lexically sort the query parameters by name before cache lookup. | | trafficserver
| `cache-ignore-cookies` | Requests containing a `Cookie:` header will not use the cache unless all the cookie names match this whitespace-separate list of globs. (trafficserver) | `cache-ignore-cookies` | Requests containing a `Cookie:` header will not use the cache unless all the cookie names match this whitespace-separate list of globs. | | trafficserver