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
!!! important
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_.
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_.
## Without Helm

View file

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

View file

@ -1,4 +1,4 @@
# External Authentication
# External OAUTH Authentication
### 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.
!!! 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

View file

@ -4,7 +4,7 @@ metadata:
annotations:
kubernetes.io/ingress.class: "nginx"
nginx.ingress.kubernetes.io/ssl-redirect: "true"
nginx.ingress.kubernetes.io/grpc-backend: "true"
nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
name: fortune-ingress
namespace: default
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.
!!! Important
The custom backend is expected to return the correct HTTP status code instead of `200`. NGINX does not change
the response from the custom default backend.
The custom backend is expected to return the correct HTTP status code instead of `200`.
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].

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.
!!! 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

View file

@ -49,10 +49,9 @@ spec:
- '--configmap=ingress/nginx-ingress-internal-controller'
```
## !!! 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.
!!! 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.
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.