From 17745a920dcf61278afffb216676b53848a0c791 Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Tue, 24 Apr 2018 14:32:27 +0300 Subject: [PATCH] Move "Customizing NGINX" documentation under "NGINX Configuration" --- docs/deploy/index.md | 2 +- docs/user-guide/.pages | 3 +++ docs/user-guide/nginx-configuration/.pages | 1 + .../{ => nginx-configuration}/annotations.md | 16 ++++++++-------- .../{ => nginx-configuration}/configmap.md | 3 ++- .../{ => nginx-configuration}/custom-template.md | 0 .../index.md} | 2 +- .../{ => nginx-configuration}/log-format.md | 0 8 files changed, 16 insertions(+), 11 deletions(-) create mode 100644 docs/user-guide/.pages create mode 100644 docs/user-guide/nginx-configuration/.pages rename docs/user-guide/{ => nginx-configuration}/annotations.md (98%) rename docs/user-guide/{ => nginx-configuration}/configmap.md (99%) rename docs/user-guide/{ => nginx-configuration}/custom-template.md (100%) rename docs/user-guide/{customizing-nginx.md => nginx-configuration/index.md} (96%) rename docs/user-guide/{ => nginx-configuration}/log-format.md (100%) diff --git a/docs/deploy/index.md b/docs/deploy/index.md index 12b3654b7..b4e6432bf 100644 --- a/docs/deploy/index.md +++ b/docs/deploy/index.md @@ -318,4 +318,4 @@ and is setup to be used in the deployment [without-rbac](../deploy/without-rbac. - --configmap=$(POD_NAMESPACE)/nginx-configuration ``` -For information on using the config-map, see its [user-guide](../user-guide/configmap.md). +For information on using the config-map, see its [user-guide](../user-guide/nginx-configuration/configmap.md). diff --git a/docs/user-guide/.pages b/docs/user-guide/.pages new file mode 100644 index 000000000..946bbcec5 --- /dev/null +++ b/docs/user-guide/.pages @@ -0,0 +1,3 @@ +arrange: +- nginx-configuration +- ... \ No newline at end of file diff --git a/docs/user-guide/nginx-configuration/.pages b/docs/user-guide/nginx-configuration/.pages new file mode 100644 index 000000000..42ff10d0b --- /dev/null +++ b/docs/user-guide/nginx-configuration/.pages @@ -0,0 +1 @@ +title: NGINX Configuration diff --git a/docs/user-guide/annotations.md b/docs/user-guide/nginx-configuration/annotations.md similarity index 98% rename from docs/user-guide/annotations.md rename to docs/user-guide/nginx-configuration/annotations.md index 4b9ed3db6..f58d5c54d 100644 --- a/docs/user-guide/annotations.md +++ b/docs/user-guide/nginx-configuration/annotations.md @@ -1,13 +1,13 @@ # Annotations +You can add these Kubernetes annotations to specific Ingress objects to customize their behavior. + !!! tip Annotation keys and values can only be strings. Other types, such as boolean or numeric values must be quoted, i.e. `"true"`, `"false"`, `"100"`. -The following annotations are supported: - |Name | type | |---------------------------|------| |[nginx.ingress.kubernetes.io/add-base-url](#rewrite)|"true" or "false"| @@ -82,14 +82,14 @@ If the scheme of [`base` tag](https://developer.mozilla.org/en/docs/Web/HTML/Ele If the Application Root is exposed in a different path and needs to be redirected, set the annotation `nginx.ingress.kubernetes.io/app-root` to redirect requests for `/`. -Please check the [rewrite](../examples/rewrite/README.md) example. +Please check the [rewrite](../../examples/rewrite/README.md) example. ### Session Affinity The annotation `nginx.ingress.kubernetes.io/affinity` enables and sets the affinity type in all Upstreams of an Ingress. This way, a request will always be directed to the same upstream server. The only affinity type available for NGINX is `cookie`. -Please check the [affinity](../examples/affinity/cookie/README.md) example. +Please check the [affinity](../../examples/affinity/cookie/README.md) example. ### Authentication @@ -113,7 +113,7 @@ This annotation also accepts the alternative form "namespace/secretName", in whi nginx.ingress.kubernetes.io/auth-realm: "realm string" ``` -Please check the [auth](../examples/auth/basic/README.md) example. +Please check the [auth](../../examples/auth/basic/README.md) example. ### Custom NGINX upstream checks @@ -131,7 +131,7 @@ In NGINX, backend server pools are called "[upstreams](http://nginx.org/en/docs/ **Important:** All Ingress rules using the same service will use the same upstream. Only one of the Ingress rules should define annotations to configure the upstream servers. -Please check the [custom upstream check](../examples/customization/custom-upstream-check/README.md) example. +Please check the [custom upstream check](../../examples/customization/custom-upstream-check/README.md) example. ### Custom NGINX upstream hashing @@ -187,7 +187,7 @@ nginx.ingress.kubernetes.io/auth-tls-pass-certificate-to-upstream Indicates if the received certificates should be passed or not to the upstream server. By default this is disabled. -Please check the [client-certs](../examples/auth/client-certs/README.md) example. +Please check the [client-certs](../../examples/auth/client-certs/README.md) example. **Important:** @@ -313,7 +313,7 @@ Additionally it is possible to set: `nginx.ingress.kubernetes.io/auth-request-redirect`: `` to specify the X-Auth-Request-Redirect header value. -Please check the [external-auth](../examples/auth/external-auth/README.md) example. +Please check the [external-auth](../../examples/auth/external-auth/README.md) example. ### Rate limiting diff --git a/docs/user-guide/configmap.md b/docs/user-guide/nginx-configuration/configmap.md similarity index 99% rename from docs/user-guide/configmap.md rename to docs/user-guide/nginx-configuration/configmap.md index 65dc1862a..f164d94dd 100644 --- a/docs/user-guide/configmap.md +++ b/docs/user-guide/nginx-configuration/configmap.md @@ -1,6 +1,7 @@ -# NGINX Ingress controller configuration ConfigMap +# ConfigMaps ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable. + The ConfigMap API resource stores configuration data as key-value pairs. The data provides the configurations for system components for the nginx-controller. Before you can begin using a config-map it must be [deployed](../../deploy/README.md/#deploying-the-config-map). diff --git a/docs/user-guide/custom-template.md b/docs/user-guide/nginx-configuration/custom-template.md similarity index 100% rename from docs/user-guide/custom-template.md rename to docs/user-guide/nginx-configuration/custom-template.md diff --git a/docs/user-guide/customizing-nginx.md b/docs/user-guide/nginx-configuration/index.md similarity index 96% rename from docs/user-guide/customizing-nginx.md rename to docs/user-guide/nginx-configuration/index.md index 337c8da4e..9cd5f6a15 100644 --- a/docs/user-guide/customizing-nginx.md +++ b/docs/user-guide/nginx-configuration/index.md @@ -1,4 +1,4 @@ -# Customizing NGINX +# NGINX Configuration There are three ways to customize NGINX: diff --git a/docs/user-guide/log-format.md b/docs/user-guide/nginx-configuration/log-format.md similarity index 100% rename from docs/user-guide/log-format.md rename to docs/user-guide/nginx-configuration/log-format.md