diff --git a/docs/examples/affinity/cookie/README.md b/docs/examples/affinity/cookie/README.md index 25a0a79c8..2a6c2a7b9 100644 --- a/docs/examples/affinity/cookie/README.md +++ b/docs/examples/affinity/cookie/README.md @@ -55,7 +55,7 @@ Last-Modified: Tue, 24 Jan 2017 14:02:19 GMT ETag: "58875e6b-264" Accept-Ranges: bytes ``` -In the example above, you can see a line containing the 'Set-Cookie: route' setting the right defined stickness cookie. +In the example above, you can see a line containing the 'Set-Cookie: route' setting the right defined stickyness cookie. This cookie is created by NGINX containing the hash of the used upstream in that request. If the user changes this cookie, NGINX creates a new one and redirect the user to another upstream. diff --git a/docs/examples/customization/custom-vts-metrics-prometheus/README.md b/docs/examples/customization/custom-vts-metrics-prometheus/README.md index 16b28bb8e..25e93b888 100644 --- a/docs/examples/customization/custom-vts-metrics-prometheus/README.md +++ b/docs/examples/customization/custom-vts-metrics-prometheus/README.md @@ -72,7 +72,7 @@ nginx_bytes_total{direction="out",ingress_class="nginx",namespace="",server_zone ### Customize metrics -The default [vts vhost key](https://github.com/vozlt/nginx-module-vts#vhost_traffic_status_filter_by_set_key) is `$geoip_country_code country::*` that expose metrics groupped by server and country code. The example below show how to have metrics grouped by server and server path. +The default [vts vhost key](https://github.com/vozlt/nginx-module-vts#vhost_traffic_status_filter_by_set_key) is `$geoip_country_code country::*` that expose metrics grouped by server and country code. The example below show how to have metrics grouped by server and server path. ![vts dashboard](imgs/vts-dashboard-filter-key-path.png) diff --git a/docs/examples/docker-registry/README.md b/docs/examples/docker-registry/README.md index 2cb2dc8e2..517b18298 100644 --- a/docs/examples/docker-registry/README.md +++ b/docs/examples/docker-registry/README.md @@ -39,7 +39,7 @@ Deploy [kube lego](https://github.com/jetstack/kube-lego) use [Let's Encrypt](ht ### Testing -To test the regstry is working correctly we download a known image from [docker hub](https://hub.docker.com), create a tag pointing to the new registry and upload the image: +To test the registry is working correctly we download a known image from [docker hub](https://hub.docker.com), create a tag pointing to the new registry and upload the image: ```console docker pull ubuntu:16.04 diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index d04c99a7a..1b40a7621 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -61,7 +61,7 @@ The Ingress controller needs information from apiserver. Therefore, authenticati 2. _Kubeconfig file:_ In some Kubernetes environments service accounts are not available. In this case a manual configuration is required. The Ingress controller binary can be started with the `--kubeconfig` flag. The value of the flag is a path to a file specifying how to connect to the API server. Using the `--kubeconfig` does not requires the flag `--apiserver-host`. The format of the file is identical to `~/.kube/config` which is used by kubectl to connect to the API server. See 'kubeconfig' section for details. -3. _Using the flag `--apiserver-host`:_ Using this flag `--apiserver-host=http://localhost:8080` it is possible to specify an unsecure api server or reach a remote kubernetes cluster using [kubectl proxy](https://kubernetes.io/docs/user-guide/kubectl/kubectl_proxy/). +3. _Using the flag `--apiserver-host`:_ Using this flag `--apiserver-host=http://localhost:8080` it is possible to specify an unsecured api server or reach a remote kubernetes cluster using [kubectl proxy](https://kubernetes.io/docs/user-guide/kubectl/kubectl_proxy/). Please do not use this approach in production. In the diagram below you can see the full authentication flow with all options, starting with the browser diff --git a/docs/user-guide/configmap.md b/docs/user-guide/configmap.md index e62bfe0bd..b4668cfeb 100644 --- a/docs/user-guide/configmap.md +++ b/docs/user-guide/configmap.md @@ -148,7 +148,7 @@ By default this is disabled. #### enable-owasp-modsecurity-crs -Eenables the OWASP ModSecurity Core Rule Set (CRS) +Enables the OWASP ModSecurity Core Rule Set (CRS) By default this is disabled. #### disable-ipv6 @@ -346,7 +346,7 @@ Sets the time during which the specified number of unsuccessful attempts to comm Enables or disables compression of HTTP responses using the ["gzip" module](http://nginx.org/en/docs/http/ngx_http_gzip_module.html). -The default mime type list to compress is: `application/atom+xml application/javascript aplication/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`. +The default mime type list to compress is: `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 diff --git a/docs/user-guide/custom-errors.md b/docs/user-guide/custom-errors.md index 745d4f3bf..197ff33ad 100644 --- a/docs/user-guide/custom-errors.md +++ b/docs/user-guide/custom-errors.md @@ -6,11 +6,11 @@ Each request to the default backend includes two headers: - `X-Code` indicates the HTTP code to be returned to the client. - `X-Format` the value of the `Accept` header. -**Important:** the custom backend must return the correct HTTP status code to be returned. NGINX do not changes the reponse from the custom default backend. +**Important:** the custom backend must return the correct HTTP status code to be returned. NGINX do not changes the response from the custom default backend. Using this two headers is possible to use a custom backend service like [this one](https://github.com/kubernetes/ingress-nginx/tree/master/examples/customization/custom-errors/nginx) that inspect each request and returns a custom error page with the format expected by the client. Please check the example [custom-errors](examples/customization/custom-errors/README.md) -NGINX sends aditional headers that can be used to build custom response: +NGINX sends additional headers that can be used to build custom response: - X-Original-URI - X-Namespace diff --git a/docs/user-guide/default-ssl-certificate.md b/docs/user-guide/default-ssl-certificate.md index 5d8c06d06..549f672b0 100644 --- a/docs/user-guide/default-ssl-certificate.md +++ b/docs/user-guide/default-ssl-certificate.md @@ -1,6 +1,6 @@ # Default SSL Certificate -NGINX provides the option to configure a server as a cath-all with [server name _](http://nginx.org/en/docs/http/server_names.html) for requests that do not match any of the configured server names. This configuration works without issues for HTTP traffic. +NGINX provides the option to configure a server as a catch-all with [server name _](http://nginx.org/en/docs/http/server_names.html) for requests that do not match any of the configured server names. This configuration works without issues for HTTP traffic. In case of HTTPS, NGINX requires a certificate. For this reason the Ingress controller provides the flag `--default-ssl-certificate`. The secret behind this flag contains the default certificate to be used in the mentioned scenario. If this flag is not provided NGINX will use a self signed certificate. diff --git a/docs/user-guide/opentracing.md b/docs/user-guide/opentracing.md index 4a592e4fa..c62506245 100644 --- a/docs/user-guide/opentracing.md +++ b/docs/user-guide/opentracing.md @@ -37,6 +37,6 @@ $ curl -v http://$(minikube ip) $ curl -v http://$(minikube ip) ``` -In the zipkin inteface we can see the details: +In the zipkin interface we can see the details: ![zipkin screenshot](../images/zipkin-demo.png "zipkin collector screenshot") diff --git a/docs/user-guide/tls.md b/docs/user-guide/tls.md index 4d9b42a24..56951bea3 100644 --- a/docs/user-guide/tls.md +++ b/docs/user-guide/tls.md @@ -9,7 +9,7 @@ ## Default SSL Certificate -NGINX provides the option to configure a server as a cath-all with [server name _](http://nginx.org/en/docs/http/server_names.html) for requests that do not match any of the configured server names. This configuration works without issues for HTTP traffic. +NGINX provides the option to configure a server as a catch-all with [server name _](http://nginx.org/en/docs/http/server_names.html) for requests that do not match any of the configured server names. This configuration works without issues for HTTP traffic. In case of HTTPS, NGINX requires a certificate. For this reason the Ingress controller provides the flag `--default-ssl-certificate`. The secret behind this flag contains the default certificate to be used in the mentioned scenario. If this flag is not provided NGINX will use a self signed certificate.