kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #43950 from kundan2707/configuration-snippet 

Document annotation nginx.ingress.kubernetes.io/configuration-snippet
This commit is contained in:
Kubernetes Prow Robot 2024-08-12 04:26:04 -07:00 committed by GitHub
parent a25ef2db33 93bc0de15b
commit 96351bc872
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
content/en/docs/reference/labels-annotations-taints/_index.md
View File

@ -1209,6 +1209,24 @@ Used on: IngressClass
When a IngressClass resource has this annotation set to `"true"`, new Ingress resource
without a class specified will be assigned this default class.
### nginx.ingress.kubernetes.io/configuration-snippet
Type: Annotation
Example: `nginx.ingress.kubernetes.io/configuration-snippet: " more_set_headers \"Request-Id: $req_id\";\nmore_set_headers \"Example: 42\";\n"`
Used on: Ingress
You can use this annotation to set extra configuration on an Ingress that
uses the [NGINX Ingress Controller] (https://github.com/kubernetes/ingress-nginx/)
The `configuration-snippet` annotation is ignored
by default since version 1.9.0 of the ingress controller.
The NGINX ingress controller setting `allow-snippet-annotations.`
has to be explicitly enabled to
use this annotation.
Enabling the annotation can be dangerous in a multi-tenant cluster, as it can lead people with otherwise
limited permissions being able to retrieve all Secrets in the cluster.
### kubernetes.io/ingress.class (deprecated)
Type: Annotation