Document annotation nginx.ingress.kubernetes.io/configuration-snippet #43950

kundan2707 · 2023-11-15T07:48:37Z

Documented nginx.ingress.kubernetes.io/configuration-snippet ingress-nginx annotation.

kundan2707 · 2023-11-15T07:49:04Z

/language en

netlify · 2023-11-15T07:50:58Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`93bc0de`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66425daabe12b30008c51486
😎 Deploy Preview	https://deploy-preview-43950--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim · 2023-11-15T15:33:18Z

/retitle Document annotation nginx.ingress.kubernetes.io/configuration-snippet

sftim

Thank you.
I don't think this PR fixes #43698
Please edit the PR description if you agree.

Documenting the one annotation that the issue lists as an example is helpful, but falls short of doing all the work required. To fix that, change the description of this PR.

sftim · 2023-11-15T15:39:09Z

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

+Example: `nginx.ingress.kubernetes.io/configuration-snippet: |
+  more_set_headers "Request-Id: $req_id";`


Please avoid a multiline example here. I think this would be OK even if it's hard to read as it gives readers the sense that the annotation value is complex.

Suggested change

Example: `nginx.ingress.kubernetes.io/configuration-snippet: |

more_set_headers "Request-Id: $req_id";`

Example: `nginx.ingress.kubernetes.io/configuration-snippet: " more_set_headers \"Request-Id: $req_id\";\nmore_set_headers \"Example: 42\";\n"`

sftim · 2023-11-15T15:39:50Z

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

+Used on: Ingress
+
+With use of this annotation someone can add additional configuration to the
+Nginx location as mentioned in example above. `configuration-snippet` annotation is disabled


I'd signpost readers to read the ingress controller's docs for the full details and an example.

natalisucks · 2024-01-19T19:56:58Z

@kundan2707 Hi there – do you have the capacity to review the feedback left on this PR?

kundan2707 · 2024-02-07T07:14:13Z

@natalisucks i will incorporate feeback and push new changes this week.

sftim · 2024-02-25T18:17:19Z

How's this going @kundan2707?

kundan2707 · 2024-02-26T07:38:20Z

@sftim sorry for delay. I incorporated review comments today.

divya-mohan0209 · 2024-03-08T06:31:00Z

Hey @kundan2707 , please sign the commits appropriately. The PR has been labelled with the cncf-cla:no label.

rudrakshkarpe · 2024-03-11T12:44:02Z

/easycla

kundan2707 · 2024-03-14T09:56:37Z

@divya-mohan0209 cncf-cla : no label removed now.

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

kundan2707 · 2024-03-15T01:25:53Z

@stmcginnis incorporated review comments.

sftim

/lgtm

More feedback, if you'd like it.

sftim · 2024-03-15T10:16:54Z

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

+With use of this annotation someone can add additional 
+configuration to the
+Nginx location as mentioned in example above.


Suggested change

With use of this annotation someone can add additional

configuration to the

Nginx location as mentioned in example above.

You can use this annotation to set extra configuration on an Ingress that

uses the [NGINX Ingress controller](https://github.com/kubernetes/ingress-nginx/).

sftim · 2024-03-15T10:17:24Z

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

+With use of this annotation someone can add additional 
+configuration to the
+Nginx location as mentioned in example above.
+`configuration-snippet` annotation is disabled


Suggested change

`configuration-snippet` annotation is disabled

The `configuration-snippet` annotation is ignored

sftim · 2024-03-15T10:19:32Z

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

+by default since version 1.9.0. `allow-snippet-annotations.` 
+has to be explicitly enabled to
+use this annotation.
+Enabling it can be dangerous in multi-tenant cluster, as it can lead people with otherwise


Suggested change

Enabling it can be dangerous in multi-tenant cluster, as it can lead people with otherwise

Enabling the annotation can be dangerous in a multi-tenant cluster, as it can lead people with otherwise

sftim · 2024-03-15T10:19:43Z

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

+has to be explicitly enabled to
+use this annotation.
+Enabling it can be dangerous in multi-tenant cluster, as it can lead people with otherwise
+limited permissions being able to retrieve all secrets in the cluster.


Suggested change

limited permissions being able to retrieve all secrets in the cluster.

limited permissions being able to retrieve all Secrets in the cluster.

sftim · 2024-03-15T10:20:15Z

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

+configuration to the
+Nginx location as mentioned in example above.
+`configuration-snippet` annotation is disabled
+by default since version 1.9.0. `allow-snippet-annotations.` 


Suggested change

by default since version 1.9.0. `allow-snippet-annotations.`

by default since version 1.9.0 of the ingress controller.

The NGINX ingress controller setting `allow-snippet-annotations`

k8s-ci-robot · 2024-03-15T10:20:23Z

LGTM label has been added.

Git tree hash: 92bc97ae721a201a3957e5aac3b2e4567476e2d4

reylejano · 2024-04-22T20:30:45Z

Hi @kundan2707, do you have time to address comments on this PR?

kundan2707 · 2024-05-07T11:02:17Z

@reylejano sorry for delay i will incorporate all comments by tommrow.

kundan2707 · 2024-05-13T18:38:09Z

@sftim incorporated your suggesions.

Superseded

sftim · 2024-07-24T12:34:09Z

/lgtm

k8s-ci-robot · 2024-07-24T12:34:15Z

LGTM label has been added.

Git tree hash: 89166adb96af814cb7aa286ae632cc32ace06232

divya-mohan0209

Thanks for this PR!
/approve

k8s-ci-robot · 2024-08-12T11:21:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: divya-mohan0209

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/docs/OWNERS~~ [divya-mohan0209]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 15, 2023

k8s-ci-robot requested review from bradtopol and natalisucks November 15, 2023 07:48

k8s-ci-robot changed the title ~~added configuration-snippet to label and annotation~~ Document annotation nginx.ingress.kubernetes.io/configuration-snippet Nov 15, 2023

sftim previously requested changes Nov 15, 2023

View reviewed changes

kundan2707 mentioned this pull request Nov 16, 2023

Ingress-NGINX annotations not registered / documented #43698

Open

kundan2707 force-pushed the configuration-snippet branch from 4b225b4 to 3264c72 Compare February 26, 2024 07:37

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 1, 2024

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 11, 2024

stmcginnis reviewed Mar 14, 2024

View reviewed changes

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

content/en/docs/reference/labels-annotations-taints/_index.md Outdated Show resolved Hide resolved

kundan2707 force-pushed the configuration-snippet branch from 3264c72 to ae15282 Compare March 15, 2024 01:24

sftim reviewed Mar 15, 2024

View reviewed changes

k8s-ci-robot assigned sftim Mar 15, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 15, 2024

added configuration-snippet

93bc0de

kundan2707 force-pushed the configuration-snippet branch from ae15282 to 93bc0de Compare May 13, 2024 18:36

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 13, 2024

k8s-ci-robot requested a review from sftim May 13, 2024 18:36

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 24, 2024

divya-mohan0209 reviewed Aug 12, 2024

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 12, 2024

k8s-ci-robot merged commit 96351bc into kubernetes:main Aug 12, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document annotation nginx.ingress.kubernetes.io/configuration-snippet #43950

Document annotation nginx.ingress.kubernetes.io/configuration-snippet #43950

kundan2707 commented Nov 15, 2023 •

edited

Loading

kundan2707 commented Nov 15, 2023

netlify bot commented Nov 15, 2023 •

edited

Loading

sftim commented Nov 15, 2023

sftim left a comment

sftim Nov 15, 2023

sftim Nov 15, 2023

natalisucks commented Jan 19, 2024

kundan2707 commented Feb 7, 2024

sftim commented Feb 25, 2024

kundan2707 commented Feb 26, 2024

divya-mohan0209 commented Mar 8, 2024

rudrakshkarpe commented Mar 11, 2024

kundan2707 commented Mar 14, 2024

kundan2707 commented Mar 15, 2024

sftim left a comment

sftim Mar 15, 2024

sftim Mar 15, 2024

sftim Mar 15, 2024

sftim Mar 15, 2024

sftim Mar 15, 2024

k8s-ci-robot commented Mar 15, 2024

reylejano commented Apr 22, 2024

kundan2707 commented May 7, 2024

kundan2707 commented May 13, 2024

sftim commented Jul 24, 2024

k8s-ci-robot commented Jul 24, 2024

divya-mohan0209 left a comment

k8s-ci-robot commented Aug 12, 2024

		Example: `nginx.ingress.kubernetes.io/configuration-snippet: \|
		more_set_headers "Request-Id: $req_id";`

	`configuration-snippet` annotation is disabled
	The `configuration-snippet` annotation is ignored

	Enabling it can be dangerous in multi-tenant cluster, as it can lead people with otherwise
	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.
	limited permissions being able to retrieve all Secrets in the cluster.

	by default since version 1.9.0. `allow-snippet-annotations.`
	by default since version 1.9.0 of the ingress controller.
	The NGINX ingress controller setting `allow-snippet-annotations`

Document annotation nginx.ingress.kubernetes.io/configuration-snippet #43950

Document annotation nginx.ingress.kubernetes.io/configuration-snippet #43950

Conversation

kundan2707 commented Nov 15, 2023 • edited Loading

kundan2707 commented Nov 15, 2023

netlify bot commented Nov 15, 2023 • edited Loading

✅ Pull request preview available for checking

sftim commented Nov 15, 2023

sftim left a comment

Choose a reason for hiding this comment

sftim Nov 15, 2023

Choose a reason for hiding this comment

sftim Nov 15, 2023

Choose a reason for hiding this comment

natalisucks commented Jan 19, 2024

kundan2707 commented Feb 7, 2024

sftim commented Feb 25, 2024

kundan2707 commented Feb 26, 2024

divya-mohan0209 commented Mar 8, 2024

rudrakshkarpe commented Mar 11, 2024

kundan2707 commented Mar 14, 2024

kundan2707 commented Mar 15, 2024

sftim left a comment

Choose a reason for hiding this comment

sftim Mar 15, 2024

Choose a reason for hiding this comment

sftim Mar 15, 2024

Choose a reason for hiding this comment

sftim Mar 15, 2024

Choose a reason for hiding this comment

sftim Mar 15, 2024

Choose a reason for hiding this comment

sftim Mar 15, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 15, 2024

reylejano commented Apr 22, 2024

kundan2707 commented May 7, 2024

kundan2707 commented May 13, 2024

sftim commented Jul 24, 2024

k8s-ci-robot commented Jul 24, 2024

divya-mohan0209 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 12, 2024

kundan2707 commented Nov 15, 2023 •

edited

Loading

netlify bot commented Nov 15, 2023 •

edited

Loading