Update custom headers annotation documentation (#12317)

Signed-off-by: Satyam Zode <satyamz@users.noreply.github.com>
Co-authored-by: Satyam Zode <satyamz@users.noreply.github.com>
This commit is contained in:
Satyam Zode 2024-11-06 23:23:30 +05:30 committed by GitHub
parent b3742aa5de
commit af095e4216
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -335,7 +335,13 @@ nginx.ingress.kubernetes.io/custom-http-errors: "404,415"
``` ```
### Custom Headers ### Custom Headers
This annotation is of the form `nginx.ingress.kubernetes.io/custom-headers: custom-headers-configmap` to specify a configmap name that contains custom headers. This annotation uses `more_set_headers` nginx directive. This annotation is of the form `nginx.ingress.kubernetes.io/custom-headers: <namespace>/<custom headers configmap>` to specify a namespace and configmap name that contains custom headers. This annotation uses `more_set_headers` nginx directive.
Example annotation for following example configmap:
```yaml
nginx.ingress.kubernetes.io/custom-headers: default/custom-headers-configmap
```
Example configmap: Example configmap:
```yaml ```yaml
@ -345,6 +351,7 @@ data:
kind: ConfigMap kind: ConfigMap
metadata: metadata:
name: custom-headers-configmap name: custom-headers-configmap
namespace: default
``` ```
!!! attention !!! attention