Skip to content

Commit 5847d1f

Browse files
committed
Improve and move the customization example
- Improve the customization example - Move it to the docs folder - Remove the example yaml files
1 parent d0bea69 commit 5847d1f

File tree

11 files changed

+185
-240
lines changed

11 files changed

+185
-240
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ We provide the following extensions to our Ingress controller:
3535
* [Session Persistence](examples/session-persistence) (NGINX Plus only), which guarantees that all the requests from the same client are always passed to the same backend container.
3636
* [Support for JWTs](examples/jwt) (NGINX Plus only), which allows NGINX Plus to authenticate requests by validating JSON Web Tokens (JWTs).
3737

38-
Additional extensions as well as a mechanism to customize NGINX configuration are available. See [examples/customization](examples/customization).
38+
Additional extensions as well as a mechanism to customize NGINX configuration are available. See [ConfigMap and Annotations doc](docs/configmap-and-annotations.md).
3939

4040
## NGINX Ingress Controller Releases
4141

docs/configmap-and-annotations.md

Lines changed: 176 additions & 0 deletions
Large diffs are not rendered by default.

docs/custom-annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Custom annotations enable you to quickly extend the Ingress Controller to suppor
44

55
## What are Custom Annotations
66

7-
NGINX Ingress Controller supports a number of annotations that fine tune NGINX configuration (for example, connection timeouts) or enable additional features (for example, JWT validation). The complete list of annotations is available [here](../examples/customization).
7+
NGINX Ingress Controller supports a number of annotations that fine tune NGINX configuration (for example, connection timeouts) or enable additional features (for example, JWT validation). The complete list of annotations is available [here](configmap-and-annotations.md).
88

99
The annotations are provided only for the most common features and use cases, meaning that not every NGINX feature or a customization option is available through the annotations. Additionally, even if an annotation is available, it might not give you the satisfactory level of control of a particular NGINX feature.
1010

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The installation manifests are located in the [deployments](../deployments) fold
2424
2525
**Note**: The default server returns the Not Found page with the 404 status code for all requests for domains for which there are no Ingress rules defined. For testing purposes we include a self-signed certificate and key that we generated. However, we recommend that you use your own certificate and key.
2626
27-
1. Create a config map for customizing NGINX configuration (read more about customization [here](../examples/customization)):
27+
1. Create a config map for customizing NGINX configuration (read more about customization [here](configmap-and-annotations.md)):
2828
```
2929
$ kubectl apply -f common/nginx-config.yaml
3030
```

docs/nginx-ingress-controllers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ The table below summarizes the key difference between nginxinc/kubernetes-ingres
1818
| Commercial support | N/A | N/A | Included |
1919
| **Load balancing configuration** |
2020
| Merging Ingress rules with the same host | Supported | Supported | Supported |
21-
| HTTP load balancing extensions - Annotations | See the [supported annotations](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/annotations.md) | See the [supported annotations](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/customization) | See the [supported annotations](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/customization)|
22-
| HTTP load balancing extensions -- ConfigMap | See the [supported ConfigMap keys](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/configmap.md) | See the [supported ConfigMap keys](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/customization) | See the [supported ConfigMap keys](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/customization) |
21+
| HTTP load balancing extensions - Annotations | See the [supported annotations](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/annotations.md) | See the [supported annotations](configmap-and-annotations.md) | See the [supported annotations](configmap-and-annotations.md)|
22+
| HTTP load balancing extensions -- ConfigMap | See the [supported ConfigMap keys](https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/configmap.md) | See the [supported ConfigMap keys](configmap-and-annotations.md) | See the [supported ConfigMap keys](configmap-and-annotations.md) |
2323
| TCP/UDP | Supported via a ConfigMap | Supported via a ConfigMap with native NGINX configuration | Supported via a ConfigMap with native NGINX configuration |
2424
| Websocket | Supported | Supported via an [annotation](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/websocket) | Supported via an [annotation](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/websocket) |
2525
| TCP SSL Passthrough | Supported via a ConfigMap | Not supported | Not supported |

docs/report-ingress-status.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Ingress controller must be configured to report an Ingress status:
1313

1414
1. Use the command-line flag `-report-ingress-status`.
1515
2. Define a source for an external address. This can be either of:
16-
1. A user defined address, specified in the `external-status-address` [ConfigMap key](../examples/customization).
16+
1. A user defined address, specified in the `external-status-address` [ConfigMap key](configmap-and-annotations.md).
1717
2. A Service of the type LoadBalancer configured with an external IP or address and specified by the `-external-service` command-line flag.
1818
3. If you're running multiple replicas of the Ingress controller, enable leader election with the `-enable-leader-election` flag
1919
to ensure that only one replica updates an Ingress status.

examples/custom-templates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Custom Templates
22

3-
The Ingress controller allows you to customize your templates through a [ConfigMap](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples/customization) via the following keys:
3+
The Ingress controller allows you to customize your templates through a [ConfigMap](../../docs/configmap-and-annotations.md) via the following keys:
44
* `main-template` - Sets the main NGINX configuration template.
55
* `ingress-template` - Sets the Ingress NGINX configuration template for an Ingress resource.
66

0 commit comments

Comments
 (0)