From af095e42166e9769ec2a062790c5b443dc91cc78 Mon Sep 17 00:00:00 2001 From: Satyam Zode <5508956+satyamz@users.noreply.github.com> Date: Wed, 6 Nov 2024 23:23:30 +0530 Subject: [PATCH] Update custom headers annotation documentation (#12317) Signed-off-by: Satyam Zode Co-authored-by: Satyam Zode --- docs/user-guide/nginx-configuration/annotations.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/nginx-configuration/annotations.md b/docs/user-guide/nginx-configuration/annotations.md index 29cd9cf14d..bc72a692ce 100755 --- a/docs/user-guide/nginx-configuration/annotations.md +++ b/docs/user-guide/nginx-configuration/annotations.md @@ -335,7 +335,13 @@ nginx.ingress.kubernetes.io/custom-http-errors: "404,415" ``` ### 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: /` 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: ```yaml @@ -345,6 +351,7 @@ data: kind: ConfigMap metadata: name: custom-headers-configmap + namespace: default ``` !!! attention