Skip to content

Commit

Permalink
Update custom headers annotation documentation (#12317)
Browse files Browse the repository at this point in the history
Signed-off-by: Satyam Zode <[email protected]>
Co-authored-by: Satyam Zode <[email protected]>
  • Loading branch information
satyamz and satyamz authored Nov 6, 2024
1 parent b3742aa commit af095e4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/user-guide/nginx-configuration/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <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:
```yaml
Expand All @@ -345,6 +351,7 @@ data:
kind: ConfigMap
metadata:
name: custom-headers-configmap
namespace: default
```

!!! attention
Expand Down

0 comments on commit af095e4

Please sign in to comment.