Merge pull request #1130 from aledbf/improve-docs

[nginx-ingress-controller] Improve docs and examples

Author: bprashanth

hack/verify-flags/exceptions.txt

@@ -1,3 +1,5 @@
+ingress/controllers/nginx/configuration.md:**custom-http-errors:** Enables which HTTP codes should be passed for processing with the [error_page directive](http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page)
+ingress/controllers/nginx/configuration.md:Setting at least one code this also enables [proxy_intercept_errors](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_intercept_errors) (required to process error_page)
 ingress/controllers/nginx/nginx.tmpl:        require("error_page")
 ingress/controllers/nginx/nginx.tmpl:    error_page {{ $errCode }} = @custom_{{ $errCode }};{{ end }}
 ingress/controllers/nginx/nginx/config/config.go:	// enables which HTTP codes should be passed for processing with the error_page directive

ingress/controllers/nginx/README.md

@@ -2,19 +2,34 @@
 
 This is a nginx Ingress controller that uses [ConfigMap](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/configmap.md) to store the nginx configuration. See [Ingress controller documentation](../README.md) for details on how it works.
 
+## Contents
+* [Conventions](#conventions)
+* [Requirements](#what-it-provides)
+* [Dry running](#dry-running-the-ingress-controller)
+* [Deployment](#deployment)
+* [HTTP](#http)
+* [HTTPS](#https)
+  * [HTTPS enforcement](#server-side-https-enforcement)
+  * [HSTS](#http-strict-transport-security)
+* [TCP Services](#exposing-tcp-services)
+* [UDP Services](#exposing-udp-services)
+* [Proxy Protocol](#proxy-protocol)
+* [NGINX customization](configuration.md)
+* [NGINX status page](#nginx-status-page)
+* [Debug & Troubleshooting](#troubleshooting)
+* [Limitations](#limitations)
 
-## What it provides?
 
-- Ingress controller
-- nginx 1.9.x with
-- SSL support
-- custom ssl_dhparam (optional). Just mount a secret with a file named `dhparam.pem`.
-- support for TCP services (flag `--tcp-services-configmap`)
-- custom nginx configuration using [ConfigMap](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/configmap.md)
+## Conventions
+
+Anytime we reference a tls secret, we mean (x509, pem encoded, RSA 2048, etc). You can generate such a certificate with: 
+`openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout $(KEY) -out $(CERT) -subj "/CN=$(HOST)/O=$(HOST)"`
+and creat the secret via `kubectl create secret tls --key file --cert file`
+
 
 
 ## Requirements
-- default backend [404-server](https://github.com/kubernetes/contrib/tree/master/404-server)
+- Default backend [404-server](https://github.com/kubernetes/contrib/tree/master/404-server)
 
 
 ## Dry running the Ingress controller
@@ -27,8 +42,7 @@ $ mkdir /etc/nginx-ssl
 $ ./nginx-ingress-controller --running-in-cluster=false --default-backend-service=kube-system/default-http-backend
 ```
 
-
-## Deploy the Ingress controller
+## Deployment
 
 First create a default backend:
 ```
@@ -85,7 +99,7 @@ $ LBIP=$(kubectl get node `kubectl get po -l name=nginx-ingress-lb --template '{
 $ curl $LBIP/foo -H 'Host: foo.bar.com'
 ```
 
-## TLS
+## HTTPS
 
 You can secure an Ingress by specifying a secret that contains a TLS private key and certificate. Currently the Ingress only supports a single TLS port, 443, and assumes TLS termination. This controller supports SNI. The TLS secret must contain keys named tls.crt and tls.key that contain the certificate and private key to use for TLS, eg:
 
@@ -119,36 +133,25 @@ Please follow [test.sh](https://github.com/bprashanth/Ingress/blob/master/exampl
 
 Check the [example](examples/tls/README.md)
 
-### HTTP Strict Transport Security
-
-HTTP Strict Transport Security (HSTS) is an opt-in security enhancement specified through the use of a special response header. Once a supported browser receives this header that browser will prevent any communications from being sent over HTTP to the specified domain and will instead send all communications over HTTPS.
-
-By default the controller redirects (301) to HTTPS if there is a TLS Ingress rule. 
-
-To disable this behavior use `hsts=false` in the NGINX ConfigMap.
+### Server-side HTTPS enforcement
 
-#### Optimizing TLS Time To First Byte (TTTFB)
+By default the controller redirects (301) to HTTPS if TLS is enabled for that ingress . If you want to disable that behaviour globally, you can use `ssl-redirect: "false"` in the NGINX config map.
 
-NGINX provides the configuration option [ssl_buffer_size](http://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_buffer_size) to allow the optimization of the TLS record size. This improves the [Time To First Byte](https://www.igvita.com/2013/12/16/optimizing-nginx-tls-time-to-first-byte/) (TTTFB). The default value in the Ingress controller is `4k` (nginx default is `16k`);
-
-### Server-side HTTPS enforcement through redirect
+To configure this feature for specfic ingress resources, you can use the `ingress.kubernetes.io/ssl-redirect: "false"` annotation in theparticular resource.
 
-By default the controller redirects (301) to HTTPS if TLS is enabled for that ingress . If you want to disable that behaviour globally, you can use `ssl-redirect: "false"` in the NGINX ConfigMap.
 
-To configure this feature for specfic ingress resources, you can use the `ingress.kubernetes.io/ssl-redirect: "false"` annotation in theparticular resource.
+### HTTP Strict Transport Security
 
-## Proxy Protocol
+HTTP Strict Transport Security (HSTS) is an opt-in security enhancement specified through the use of a special response header. Once a supported browser receives this header that browser will prevent any communications from being sent over HTTP to the specified domain and will instead send all communications over HTTPS.
 
-If you are using a L4 proxy to forward the traffic to the NGINX pods and terminate HTTP/HTTPS there, you will lose the remote endpoint's IP addresses. To prevent this you could use the [Proxy Protocol](http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt) for forwarding traffic, this will send the connection details before forwarding the acutal TCP connection itself.
+By default the controller redirects (301) to HTTPS if there is a TLS Ingress rule. 
 
-Amongst others [ELBs in AWS](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-proxy-protocol.html) and [HAProxy](http://www.haproxy.org/) support Proxy Protocol.
+To disable this behavior use `hsts=false` in the NGINX config map.
 
-Please check the [proxy-protocol](examples/proxy-protocol/) example
 
 ## Exposing TCP services
 
-Ingress does not support TCP services (yet). For this reason this Ingress controller uses a ConfigMap where the key is the external port to use and the value is
-`<namespace/service name>:<service port>`
+Ingress does not support TCP services (yet). For this reason this Ingress controller uses the flag `--tcp-services-configmap` to point to an existing config map where the key is the external port to use and the value is `<namespace/service name>:<service port>`
 It is possible to use a number or the name of the port.
 
 The next example shows how to expose the service `example-go` running in the namespace `default` in the port `8080` using the port `9000`
@@ -168,8 +171,7 @@ Please check the [tcp services](examples/tcp/README.md) example
 
 Since 1.9.13 NGINX provides [UDP Load Balancing](https://www.nginx.com/blog/announcing-udp-load-balancing/).
 
-Ingress does not support UDP services (yet). For this reason this Ingress controller uses a ConfigMap where the key is the external port to use and the value is
-`<namespace/service name>:<service port>`
+Ingress does not support UDP services (yet). For this reason this Ingress controller uses the flag `--udp-services-configmap` to point to an existing config map where the key is the external port to use and the value is `<namespace/service name>:<service port>`
 It is possible to use a number or the name of the port.
 
 The next example shows how to expose the service `kube-dns` running in the namespace `kube-system` in the port `53` using the port `53`
@@ -185,91 +187,36 @@ data:
 
 Please check the [udp services](examples/udp/README.md) example
 
+## Proxy Protocol
 
-## Custom NGINX configuration
-
-Using a ConfigMap it is possible to customize the defaults in nginx.
-
-Please check the [tcp services](examples/custom-configuration/README.md) example
-
-
-## Custom NGINX template
-
-The NGINX template is located in the file `/etc/nginx/template/nginx.tmpl`. Mounting a volume is possible to use a custom version.
-Use the [custom-template](examples/custom-template/README.md) example as a guide
-
-**Please note the template is tied to the go code. Be sure to no change names in the variable `$cfg`**
-
-
-### Custom NGINX upstream checks
-
-NGINX exposes some flags in the [upstream configuration](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream) that enabled configuration of each server in the upstream. The ingress controller allows custom `max_fails` and `fail_timeout` parameters in a global context using `upstream-max-fails` or `upstream-fail-timeout` in the NGINX Configmap or in a particular Ingress rule. By default this values are 0. This means NGINX will respect the `livenessProbe`, if is defined. If there is no probe, NGINX will not mark a server inside an upstream down.
-
-To use custom values in an Ingress rule define this annotations:
-
-`ingress-nginx.kubernetes.io/upstream-max-fails`: number of unsuccessful attempts to communicate with the server that should happen in the duration set by the fail_timeout parameter to consider the server unavailable
+If you are using a L4 proxy to forward the traffic to the NGINX pods and terminate HTTP/HTTPS there, you will lose the remote endpoint's IP addresses. To prevent this you could use the [Proxy Protocol](http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt) for forwarding traffic, this will send the connection details before forwarding the acutal TCP connection itself.
 
-`ingress-nginx.kubernetes.io/upstream-fail-timeout`: time in seconds during which the specified number of unsuccessful attempts to communicate with the server should happen to consider the server unavailable. Also the period of time the server will be considered unavailable.
+Amongst others [ELBs in AWS](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-proxy-protocol.html) and [HAProxy](http://www.haproxy.org/) support Proxy Protocol.
 
-**Important:** 
-The upstreams are shared. i.e. Ingress rule using the same service will use the same upstream. 
-This means only one of the rules should define annotations to configure the upstream servers
+Please check the [proxy-protocol](examples/proxy-protocol/) example
 
 
-Please check the [auth](examples/custom-upstream-check/README.md) example
+### Custom errors
 
- ### Authentication
- 
- Is possible to add authentication adding additional annotations in the Ingress rule. The source of the authentication is a secret that contains usernames and passwords inside the the key `auth`
- 
- The annotations are:
- 
- ```
- ingress-nginx.kubernetes.io/auth-type:[basic|digest]
- ```
- 
- Indicates the [HTTP Authentication Type: Basic or Digest Access Authentication](https://tools.ietf.org/html/rfc2617).
- 
- ```
- ingress-nginx.kubernetes.io/auth-secret:secretName
- ```
- 
- Name of the secret that contains the usernames and passwords with access to the `path/s` defined in the Ingress Rule.
- The secret must be created in the same namespace than the Ingress rule
- 
- ```
- ingress-nginx.kubernetes.io/auth-realm:"realm string"
- ```
+In case of an error in a request the body of the response is obtained from the `default backend`. Each request to the default backend includes two headers: 
+- `X-Code` indicates the HTTP code
+- `X-Format` the value of the `Accept` header
 
+Using this two headers is possible to use a custom backend service like [this one](https://github.com/aledbf/contrib/tree/nginx-debug-server/Ingress/images/nginx-error-server) that inspect each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](examples/custom-errors/README.md)
 
 ### NGINX status page
 
 The ngx_http_stub_status_module module provides access to basic status information. This is the default module active in the url `/nginx_status`.
 This controller provides an alternitive to this module using [nginx-module-vts](https://github.com/vozlt/nginx-module-vts) third party module.
-To use this module just provide a ConfigMap with the key `enable-vts-status=true`. The URL is exposed in the port 8080.
+To use this module just provide a config map with the key `enable-vts-status=true`. The URL is exposed in the port 8080.
 Please check the example `example/rc-default.yaml`
 
 ![nginx-module-vts screenshot](https://cloud.githubusercontent.com/assets/3648408/10876811/77a67b70-8183-11e5-9924-6a6d0c5dc73a.png "screenshot with filter")
 
 To extract the information in JSON format the module provides a custom URL: `/nginx_status/format/json`
 
 
-### Custom errors
-
-In case of an error in a request the body of the response is obtained from the `default backend`. Each request to the default backend includes two headers: 
-- `X-Code` indicates the HTTP code
-- `X-Format` the value of the `Accept` header
-
-Using this two headers is possible to use a custom backend service like [this one](https://github.com/aledbf/contrib/tree/nginx-debug-server/Ingress/images/nginx-error-server) that inspect each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](examples/custom-errors/README.md)
-
-
-## Troubleshooting
-
-Problems encountered during [1.2.0-alpha7 deployment](https://github.com/kubernetes/kubernetes/blob/master/docs/getting-started-guides/docker.md):
-* make setup-files.sh file in hypercube does not provide 10.0.0.1 IP to make-ca-certs, resulting in CA certs that are issued to the external cluster IP address rather then 10.0.0.1 -> this results in nginx-third-party-lb appearing to get stuck at "Utils.go:177 - Waiting for default/default-http-backend" in the docker logs.  Kubernetes will eventually kill the container before nginx-third-party-lb times out with a message indicating that the CA certificate issuer is invalid (wrong ip), to verify this add zeros to the end of initialDelaySeconds and timeoutSeconds and reload the RC, and docker will log this error before kubernetes kills the container.
-  * To fix the above, setup-files.sh must be patched before the cluster is inited (refer to https://github.com/kubernetes/kubernetes/pull/21504)
-
-### Debug
+### Debug & Troubleshooting
 
 Using the flag `--v=XX` it is possible to increase the level of logging.
 In particular:
@@ -295,13 +242,14 @@ I0316 12:24:37.610073       1 command.go:69] change in configuration detected. R
 
 
 
-### Retries in no idempotent methods
+*These issues were encountered in past versions of Kubernetes:*
 
-Since 1.9.13 NGINX will not retry non-idempotent requests (POST, LOCK, PATCH) in case of an error.
-The previous behavior can be restored using `retry-non-idempotent=true` in the configuration ConfigMap
+[1.2.0-alpha7 deployment](https://github.com/kubernetes/kubernetes/blob/master/docs/getting-started-guides/docker.md):
+
+* make setup-files.sh file in hypercube does not provide 10.0.0.1 IP to make-ca-certs, resulting in CA certs that are issued to the external cluster IP address rather then 10.0.0.1 -> this results in nginx-third-party-lb appearing to get stuck at "Utils.go:177 - Waiting for default/default-http-backend" in the docker logs.  Kubernetes will eventually kill the container before nginx-third-party-lb times out with a message indicating that the CA certificate issuer is invalid (wrong ip), to verify this add zeros to the end of initialDelaySeconds and timeoutSeconds and reload the RC, and docker will log this error before kubernetes kills the container.
+  * To fix the above, setup-files.sh must be patched before the cluster is inited (refer to https://github.com/kubernetes/kubernetes/pull/21504)
 
 
 ## Limitations
 
 - Ingress rules for TLS require the definition of the field `host`
-- The IP address in the status of loadBalancer could contain old values