Minor documentation cleanup (#7826)
* clarify link * Add section headers * console blocks * grpc example json was not valid * multi-tls update text The preceding point 1 related to4f2cb51ef8/ingress/controllers/nginx/examples/ingress.yamland the deployments referenced in4f2cb51ef8/ingress/controllers/nginx/examples/README.mdThey are not relevant to the current instructions. * add whitespace around parens * grammar setup would be a proper noun, but it is not the intended concept, which is a state * grammar * is-only * via * Use bullets for choices * ingress-controller nginx is a distinct brand. generally this repo talks about ingress-controller, although it is quite inconsistent about how... * drop stray paren * OAuth is a brand and needs an article here also GitHub is a brand * Indent text under numbered lists * use e.g. * Document that customer header config maps changes do not trigger updates This should be removed if https://github.com/kubernetes/ingress-nginx/issues/5238 is fixed. * article * period * infinitive verb + period * clarify that the gRPC server is responsible for listening for TCP traffic and not some other part of the backend application * avoid using ; and reword * whitespace * brand: gRPC * only-does is the right form `for` adds nothing here * spelling: GitHub * punctuation `;` is generally not the right punctuation... * drop stray `to` * sentence * backticks * fix link * Improve readability of compare/vs * Renumber list * punctuation * Favor Ingress-NGINX and Ingress NGINX * Simplify custom header restart text * Undo typo damage Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
This commit is contained in:
parent
784f9c53bb
commit
1614027cd4
27 changed files with 208 additions and 169 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# Default backend
|
||||
|
||||
The default backend is a service which handles all URL paths and hosts the nginx controller doesn't understand
|
||||
The default backend is a service which handles all URL paths and hosts the Ingress-NGINX controller doesn't understand
|
||||
(i.e., all the requests that are not mapped with an Ingress).
|
||||
|
||||
Basically a default backend exposes two URLs:
|
||||
|
|
|
|||
|
|
@ -22,11 +22,11 @@ This tutorial will show you how to install [Prometheus](https://prometheus.io/)
|
|||
--set-string controller.podAnnotations."prometheus\.io/scrape"="true" \
|
||||
--set-string controller.podAnnotations."prometheus\.io/port"="10254"
|
||||
```
|
||||
- You can validate that the controller is configured for metrics by looking at the values of the installed release, like this ;
|
||||
- You can validate that the controller is configured for metrics by looking at the values of the installed release, like this:
|
||||
```
|
||||
helm get values ingress-controller --namespace ingress-nginx
|
||||
```
|
||||
- You should be able to see the values shown below ;
|
||||
- You should be able to see the values shown below:
|
||||
```
|
||||
..
|
||||
controller:
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ metadata:
|
|||
kubernetes.io/ingress.class: "gce"
|
||||
```
|
||||
|
||||
will target the GCE controller, forcing the nginx controller to ignore it, while an annotation like
|
||||
will target the GCE controller, forcing the Ingress-NGINX controller to ignore it, while an annotation like:
|
||||
|
||||
```yaml
|
||||
metadata:
|
||||
|
|
@ -91,7 +91,7 @@ metadata:
|
|||
kubernetes.io/ingress.class: "nginx"
|
||||
```
|
||||
|
||||
will target the nginx controller, forcing the GCE controller to ignore it.
|
||||
will target the Ingress-NGINX controller, forcing the GCE controller to ignore it.
|
||||
|
||||
You can change the value "nginx" to something else by setting the `--ingress-class` flag:
|
||||
|
||||
|
|
|
|||
|
|
@ -221,7 +221,7 @@ Enables the return of the header Server from the backend instead of the generic
|
|||
|
||||
## allow-snippet-annotations
|
||||
|
||||
Enables Ingress to parse and add *-snippet annotations/directives created by the user. _**default:**_ `true`;
|
||||
Enables Ingress to parse and add *-snippet annotations/directives created by the user. _**default:**_ `true`
|
||||
|
||||
Warning: We recommend enabling this option only if you TRUST users with permission to create Ingress objects, as this
|
||||
may allow a user to add restricted configurations to the final nginx.conf file
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/ma
|
|||
kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/master/kubernetes/deployment.yaml
|
||||
```
|
||||
|
||||
Also we need to configure the NGINX controller ConfigMap with the required values:
|
||||
Also we need to configure the Ingress-NGINX controller ConfigMap with the required values:
|
||||
|
||||
```
|
||||
$ echo '
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue