Fix documentation format

This commit is contained in:
Manuel de Brito Fontes 2018-08-30 15:24:56 -03:00 committed by Manuel Alejandro de Brito Fontes
parent be0fdc620f
commit f5dda5fecc
No known key found for this signature in database
GPG key ID: 786136016A8BA02A
11 changed files with 25 additions and 25 deletions

View file

@ -1,8 +1,8 @@
# Upgrading # Upgrading
!!! important !!! important
No matter the method you use for upgrading, _if you use template overrides, No matter the method you use for upgrading, _if you use template overrides,
make sure your templates are compatible with the new version of ingress-nginx_. make sure your templates are compatible with the new version of ingress-nginx_.
## Without Helm ## Without Helm

View file

@ -1,4 +1,4 @@
# External authentication # External Basic Authentication
### Example 1: ### Example 1:

View file

@ -1,4 +1,4 @@
# External Authentication # External OAUTH Authentication
### Overview ### Overview
@ -6,7 +6,7 @@ The `auth-url` and `auth-signin` annotations allow you to use an external
authentication provider to protect your Ingress resources. authentication provider to protect your Ingress resources.
!!! Important !!! Important
this annotation requires `nginx-ingress-controller v0.9.0` or greater.) This annotation requires `nginx-ingress-controller v0.9.0` or greater.)
### Key Detail ### Key Detail

View file

@ -11,9 +11,9 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/mast
``` ```
!!! Important !!! Important
**DO NOT RUN THIS IN PRODUCTION** **DO NOT RUN THIS IN PRODUCTION**
This deployment uses `emptyDir` in the `volumeMount` which means the contents of the registry will be deleted when the pod dies. This deployment uses `emptyDir` in the `volumeMount` which means the contents of the registry will be deleted when the pod dies.
The next required step is creation of the ingress rules. To do this we have two options: with and without TLS The next required step is creation of the ingress rules. To do this we have two options: with and without TLS
@ -26,9 +26,9 @@ wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/exam
``` ```
!!! Important !!! Important
Running a docker registry without TLS requires we configure our local docker daemon with the insecure registry flag. Running a docker registry without TLS requires we configure our local docker daemon with the insecure registry flag.
Please check [deploy a plain http registry](https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry) Please check [deploy a plain http registry](https://docs.docker.com/registry/insecure/#deploy-a-plain-http-registry)
### With TLS ### With TLS

View file

@ -4,7 +4,7 @@ metadata:
annotations: annotations:
kubernetes.io/ingress.class: "nginx" kubernetes.io/ingress.class: "nginx"
nginx.ingress.kubernetes.io/ssl-redirect: "true" nginx.ingress.kubernetes.io/ssl-redirect: "true"
nginx.ingress.kubernetes.io/grpc-backend: "true" nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
name: fortune-ingress name: fortune-ingress
namespace: default namespace: default
spec: spec:

View file

@ -18,8 +18,8 @@ example, if the value of the `Accept` header send by the client was `application
could decide to return the error payload as a JSON document instead of HTML. could decide to return the error payload as a JSON document instead of HTML.
!!! Important !!! Important
The custom backend is expected to return the correct HTTP status code instead of `200`. NGINX does not change The custom backend is expected to return the correct HTTP status code instead of `200`.
the response from the custom default backend. NGINX does not change the response from the custom default backend.
An example of such custom backend is available inside the source repository at [images/custom-error-pages][img-custom-error-pages]. An example of such custom backend is available inside the source repository at [images/custom-error-pages][img-custom-error-pages].

View file

@ -11,7 +11,7 @@ Basically a default backend exposes two URLs:
!!! example !!! example
The sub-directory [`/images/404-server`](https://github.com/kubernetes/ingress-nginx/tree/master/images/404-server) The sub-directory [`/images/404-server`](https://github.com/kubernetes/ingress-nginx/tree/master/images/404-server)
provides a service which satisfies the requirements for a default backend. provides a service which satisfies the requirements for a default backend.
!!! example !!! example
The sub-directory [`/images/custom-error-pages`](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages) The sub-directory [`/images/custom-error-pages`](https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages)
provides an additional service for the purpose of customizing the error pages served via the default backend. provides an additional service for the purpose of customizing the error pages served via the default backend.

View file

@ -27,7 +27,7 @@ The default value of this settings is `60 seconds`.
A more adequate value to support websockets is a value higher than one hour (`3600`). A more adequate value to support websockets is a value higher than one hour (`3600`).
!!! Important !!! Important
If the NGINX ingress controller is exposed with a service `type=LoadBalancer` make sure the protocol between the loadbalancer and NGINX is TCP. If the NGINX ingress controller is exposed with a service `type=LoadBalancer` make sure the protocol between the loadbalancer and NGINX is TCP.
## Optimizing TLS Time To First Byte (TTTFB) ## Optimizing TLS Time To First Byte (TTTFB)

View file

@ -2,7 +2,8 @@
This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for scraping the metrics of the NGINX Ingress controller. This tutorial will show you how to install [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/) for scraping the metrics of the NGINX Ingress controller.
!!! Important: this example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod gets terminated you will lose all the data. !!! important
This example uses `emptyDir` volumes for Prometheus and Grafana. This means once the pod gets terminated you will lose all the data.
## Before You Begin ## Before You Begin

View file

@ -49,10 +49,9 @@ spec:
- '--configmap=ingress/nginx-ingress-internal-controller' - '--configmap=ingress/nginx-ingress-internal-controller'
``` ```
## !!! important !!! important
Deploying multiple Ingress controllers, of different types (e.g., `ingress-nginx` & `gce`), and not specifying a class annotation will
result in both or all controllers fighting to satisfy the Ingress, and all of them racing to update Ingress status field in confusing ways.
Deploying multiple Ingress controllers, of different types (e.g., `ingress-nginx` & `gce`), and not specifying a class annotation will When running multiple ingress-nginx controllers, it will only process an unset class annotation if one of the controllers uses the default
result in both or all controllers fighting to satisfy the Ingress, and all of them racing to update Ingress status field in confusing ways. `--ingress-class` value (see `IsValid` method in `internal/ingress/annotations/class/main.go`), otherwise the class annotation become required.
When running multiple ingress-nginx controllers, it will only process an unset class annotation if one of the controllers uses the default
`--ingress-class` value (see `IsValid` method in `internal/ingress/annotations/class/main.go`), otherwise the class annotation become required.

View file

@ -15,11 +15,11 @@ data:
``` ```
!!! Important !!! Important
The key and values in a ConfigMap can only be strings. 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". 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". Same for numbers, like "100".
"Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string. "Slice" types (defined below as `[]string` or `[]int` can be provided as a comma-delimited string.
## Configuration options ## Configuration options