Documentation should not mention ingress controller specific annotations [File: /content/en/docs/concepts/services-networking/ingress.md]

[onitake]

This is a...

• Feature Request
• Bug Report

Problem:
The ingress resource documentation describes examples that contain an annotation that will not work with other ingress controllers besides nginx: nginx.ingress.kubernetes.io/rewrite-target

Proposed Solution:
While this may help some users, there is also a generic rewrite-target annotation called ingress.kubernetes.io/rewrite-target. This annotation will also work with traefik and other ingress controllers.

The documentation should be kept as implementation-agnostic as possible, so the reference to nginx should be dropped.

Page to Update:
https://kubernetes.io/docs/concepts/services-networking/ingress/

[anlunas]

Working on it

[onitake]

Cool, thank you.

I did a little bit of research, and it seems that behaviour differs a bit between different ingress controllers, but at least ingress-nginx and Træfik have supported the generic annotation for a while.
I don't know about others.

[onitake]

Apparently, what I said is not quite true, as can be seen in this comment: kubernetes/ingress-nginx#3109 (comment)

But there's a somewhat more pragmatic discussion for Træfik: traefik/traefik#1723

However, I think it would make a lot of sense to have a common syntax for different ingress controllers. The ingress.kubernetes.io/rewrite-target annotation seems to work well in many cases, but a controller-specific prefix may be needed. The documentation should reflect this, or a design decision may be needed (well out of scope for this bug report).

Here is the documentation for Træfik: https://docs.traefik.io/configuration/backends/kubernetes/#general-annotations
And for nginx: https://github.com/kubernetes/ingress-nginx/blob/master/docs/examples/rewrite/README.md

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[onitake]

/remove-lifecycle stale

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.