Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup docs #5043

Merged
merged 1 commit into from
Feb 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,11 @@ dev-env: check-go-version ## Starts a local Kubernetes cluster using minikube, b

.PHONY: live-docs
live-docs: ## Build and launch a local copy of the documentation website in http://localhost:3000
@docker build --pull -t ingress-nginx/mkdocs images/mkdocs
@docker buildx build \
--pull \
--load \
--progress plain \
-t ingress-nginx/mkdocs images/mkdocs
@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs ingress-nginx/mkdocs

.PHONY: build-docs
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/customization/custom-errors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you do not already have an instance of the NGINX Ingress controller running,
ingress-nginx ClusterIP 10.0.0.13 <none> 80/TCP,443/TCP 10m
```

!!! Note
!!! note
The `ingress-nginx` Service is of type `ClusterIP` in this example. This may vary depending on your environment.
Make sure you can use the Service to reach NGINX before proceeding with the rest of this example.

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/docker-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/exam
```

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

Expand Down
8 changes: 3 additions & 5 deletions docs/user-guide/fcgi-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,13 @@ spec:
servicePort: fastcgi
```

## The FastCGI Ingress Annotations
## FastCGI Ingress Annotations

### The `nginx.ingress.kubernetes.io/backend-protocol` Annotation

To enable FastCGI, the `backend-protocol` annotation needs to be set to `FCGI`, which overrides the default `HTTP` value.
To enable FastCGI, the `nginx.ingress.kubernetes.io/backend-protocol` annotation needs to be set to `FCGI`, which overrides the default `HTTP` value.

> `nginx.ingress.kubernetes.io/backend-protocol: "FCGI"`

This enables the _FastCGI_ mode for the whole _Ingress_ object.
**This enables the _FastCGI_ mode for all paths defined in the _Ingress_ object**

### The `nginx.ingress.kubernetes.io/fastcgi-index` Annotation

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/ingress-path-matching.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The ingress controller supports **case insensitive** regular expressions in the
This can be enabled by setting the `nginx.ingress.kubernetes.io/use-regex` annotation to `true` (the default is false).

!!! hint
Kubernetes only accept expressions that comply with the RE2 engine syntax. It is possible that valid expressions accepted by NGINX cannot be used with ingress-nginx, because the PCRE library (used in NGINX) supports a wider syntax than RE2.
See the [RE2 Syntax](https://github.com/google/re2/wiki/Syntax) documentation for differences.
Kubernetes only accept expressions that comply with the RE2 engine syntax. It is possible that valid expressions accepted by NGINX cannot be used with ingress-nginx, because the PCRE library (used in NGINX) supports a wider syntax than RE2.
See the [RE2 Syntax](https://github.com/google/re2/wiki/Syntax) documentation for differences.

See the [description](./nginx-configuration/annotations.md#use-regex) of the `use-regex` annotation for more details.

Expand Down
9 changes: 5 additions & 4 deletions docs/user-guide/nginx-configuration/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Enables automatic conversion of preload links specified in the “Link” respon
Allows the definition of one or more aliases in the server definition of the NGINX configuration using the annotation `nginx.ingress.kubernetes.io/server-alias: "<alias 1>,<alias 2>"`.
This will create a server with the same configuration, but adding new values to the `server_name` directive.

!!! Note
!!! note
A server-alias name cannot conflict with the hostname of an existing server. If it does, the server-alias annotation will be ignored.
If a server-alias is created and later a new server with the same hostname is created, the new server configuration will take
place over the alias configuration.
Expand Down Expand Up @@ -446,7 +446,8 @@ By default the controller redirects all requests to an existing service that pro
`nginx.ingress.kubernetes.io/enable-global-auth`:
indicates if GlobalExternalAuth configuration should be applied or not to this Ingress rule. Default values is set to `"true"`.

!!! note For more information please see [global-auth-url](./configmap.md#global-auth-url).
!!! note
For more information please see [global-auth-url](./configmap.md#global-auth-url).

### Rate limiting

Expand Down Expand Up @@ -837,7 +838,7 @@ nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
### Use Regex

!!! attention
When using this annotation with the NGINX annotation `nginx.ingress.kubernetes.io/affinity` of type `cookie`, `nginx.ingress.kubernetes.io/session-cookie-path` must be also set; Session cookie paths do not support regex.
When using this annotation with the NGINX annotation `nginx.ingress.kubernetes.io/affinity` of type `cookie`, `nginx.ingress.kubernetes.io/session-cookie-path` must be also set; Session cookie paths do not support regex.

Using the `nginx.ingress.kubernetes.io/use-regex` annotation will indicate whether or not the paths defined on an Ingress use regular expressions. The default value is `false`.

Expand Down Expand Up @@ -885,4 +886,4 @@ nginx.ingress.kubernetes.io/mirror-request-body: "off"

The request sent to the mirror is linked to the orignial request. If you have a slow mirror backend, then the orignial request will throttle.

For more information on the mirror module see https://nginx.org/en/docs/http/ngx_http_mirror_module.html
For more information on the mirror module see [ngx_http_mirror_module](https://nginx.org/en/docs/http/ngx_http_mirror_module.html)
4 changes: 2 additions & 2 deletions docs/user-guide/nginx-configuration/configmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ data:
ssl-protocols: SSLv2
```

!!! Important
!!! important
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".
Same for numbers, like "100".
Expand Down Expand Up @@ -567,7 +567,7 @@ Since `0.27.0` and due to a [change in the MaxMind databases](https://blog.maxmi
For this reason, it is required to define a new flag `--maxmind-license-key` in the ingress controller deployment to download the databases needed during the initialization of the ingress controller.
Alternatively, it is possible to use a volume to mount the files `/etc/nginx/geoip/GeoLite2-City.mmdb` and `/etc/nginx/geoip/GeoLite2-ASN.mmdb`, avoiding the overhead of the download.

!!! Important
!!! important
If the feature is enabled but the files are missing, GeoIP2 will not be enabled.

_**default:**_ false
Expand Down
1 change: 0 additions & 1 deletion docs/user-guide/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ or per-Ingress with the `nginx.ingress.kubernetes.io/ssl-redirect: "false"`
annotation in the particular resource.

!!! tip

When using SSL offloading outside of cluster (e.g. AWS ELB) it may be useful to enforce a
redirect to HTTPS even when there is no TLS certificate available.
This can be achieved by using the `nginx.ingress.kubernetes.io/force-ssl-redirect: "true"`
Expand Down
34 changes: 0 additions & 34 deletions labels.yaml

This file was deleted.

6 changes: 3 additions & 3 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs-material~=4.4.0
mkdocs-material~=4.6.2
mkdocs~=1.0.4
pymdown-extensions~=6.0
pygments~=2.3.1
pymdown-extensions~=6.3
pygments~=2.5.2