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

No KIC 3.x KongConsumer or KongPlugin guide #6801

Open
2 tasks done
rainest opened this issue Jan 22, 2024 · 1 comment
Open
2 tasks done

No KIC 3.x KongConsumer or KongPlugin guide #6801

rainest opened this issue Jan 22, 2024 · 1 comment
Assignees

Comments

@rainest
Copy link
Contributor

rainest commented Jan 22, 2024

Where is the problem?

https://docs.konghq.com/kubernetes-ingress-controller/2.12.x/guides/using-consumer-credential-resource/

What happened?

The 2.x KIC docs included step-by-step guides for using KongConsumer, credential, and KongPlugin resources:
https://docs.konghq.com/kubernetes-ingress-controller/2.12.x/guides/using-consumer-credential-resource/
https://docs.konghq.com/kubernetes-ingress-controller/2.12.x/guides/using-kongplugin-resource/

The latest URLs for these redirect to https://docs.konghq.com/kubernetes-ingress-controller/latest/concepts/custom-resources/

https://docs.konghq.com/kubernetes-ingress-controller/latest/guides/using-consumer-credential-resource/
https://docs.konghq.com/kubernetes-ingress-controller/latest/guides/using-kongplugin-resource/

The concepts/custom-resources page is not a guide. It's a high-level overview that briefly describes the purpose of these resources. It does not show how to use them.

grepping for global='true' and kongCredType (or konghq.com/credential) indicates this content was not ported elsewhere.

https://docs.konghq.com/kubernetes-ingress-controller/latest/get-started/key-authentication/ roughly provides the equivalent information for consumers and credentials and would be a better redirect target, though its title indicates it's only for key-auth rather than a concept applicable to consumers in general.

We do have several plugin guides, but AFAICT none that cover the different means of attaching plugins and the precedence order that prioritizes, for example, a service+consumer plugin over a service plugin.

What did you expect to happen?

Content from those 2.x guides demonstrating usage of those resources is still available.

Code of Conduct and Community Expectations

  • I agree to follow this project's Code of Conduct
  • I agree to abide by the Community Expectations
@mheap mheap self-assigned this Jan 26, 2024
@mloskot
Copy link
Contributor

mloskot commented Dec 2, 2024

@mheap Any update on this?
I think this one is closely related to my request in #5324 which I submitted nearly two years ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants