Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ingress-NGINX annotations not registered / documented #43698

Open
sftim opened this issue Oct 26, 2023 · 7 comments
Open

Ingress-NGINX annotations not registered / documented #43698

sftim opened this issue Oct 26, 2023 · 7 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/network Categorizes an issue or PR as relevant to SIG Network. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@sftim
Copy link
Contributor

sftim commented Oct 26, 2023

This is a Bug Report

Problem:
The Ingress-NGINX controller uses annotations, such as nginx.ingress.kubernetes.io/configuration-snippet, that use an official Kubernetes namespace, but aren't registered or documented.

Proposed Solution:
Document the annotations (and any labels) that this ingress controller uses.

Page to Update:
https://kubernetes.io/docs/reference/labels-annotations-taints/

Additional Information:
/sig network
/lifecycle frozen

@sftim sftim added the kind/bug Categorizes issue or PR as related to a bug. label Oct 26, 2023
@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/network Categorizes an issue or PR as relevant to SIG Network. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 26, 2023
@mengjiao-liu
Copy link
Member

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 27, 2023
@kumarankit999
Copy link

Hey @sftim, Which annotations are been left, That we are trying to add on the https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md , Can you help me into this.

@kumarankit999
Copy link

@sftim ??????

@sftim
Copy link
Contributor Author

sftim commented Oct 29, 2023

Hi @kumarankit999

It sounds like you're inviting me to make time to help you learn how to contribute here. Thank you for the offer, however I'm going to decline it.

Some context:
Although I can spot that the issue exists, I haven't investigated enough to be able to explain what work is needed to fix the issue. I could do that investigation but right now it's not a priority for me.

@kundan2707
Copy link
Contributor

@kumarankit999 @sftim I have idea for this issue and would like to take on this issue.

@kundan2707
Copy link
Contributor

/assign

@kundan2707
Copy link
Contributor

Documented configuration-snippet in #43950

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/network Categorizes an issue or PR as relevant to SIG Network. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

5 participants