kubernetes-sigs
Document when each type of route should be used
What would you like to be added: There is still some confusion on when each type of route should be used. When is it HTTPRoute? When is it TLSRoute?
This way, it would be good to know on a single documentation page what kind of routes we support, what is the difference between each one of them, when one should be selected over the other.
For some more reference:
https://github.com/kubernetes-sigs/gateway-api/pull/4064/files#r2562310833
/good-first-issue /help
@rikatz: This request has been marked as suitable for new contributors.
Guidelines
Please ensure that the issue body includes answers to the following questions:
- Why are we solving this issue?
- To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
- How can the assignee reach out to you for help?
For more details on the requirements of such an issue, please see here and ensure that they are met.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.
In response to this:
What would you like to be added: There is still some confusion on when each type of route should be used. When is it HTTPRoute? When is it TLSRoute?
This way, it would be good to know on a single documentation page what kind of routes we support, what is the difference between each one of them, when one should be selected over the other.
For some more reference:
https://github.com/kubernetes-sigs/gateway-api/pull/4064/files#r2562310833
/good-first-issue /help
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-sigs/prow repository.
Hi! I’m a new contributor and would like to work on this documentation issue. I will start working on it and open a draft PR soon. Please let me know if you have any guidance or expectations for the doc structure.
hi @ryurulz thanks for jumping in on this one.
I think it would be very important to consider, when you are writing this doc, what you as a user would expect to see to help guiding you. Eg.: given now we have HTTPRoute, GRPCRoute (standard), TLSRoute (being promoted), TCPRoute and UDPRoute (experimental), and you are deploying your application, which one should be used, and why? What makes them different? What should I check on my Gateway or with my admin to know which one to use.
There's no much expectation on the doc structure, you can look into some previous art from our docs like https://gateway-api.sigs.k8s.io/concepts/use-cases/
Feel free to ping me here (or even better, on Slack as I may answer faster) if you have any questions!
Hi @rikatz
I have opened a PR for this documentation update.
PR: https://github.com/kubernetes-sigs/gateway-api/pull/4330
Please let me know if any changes are needed.
Thank you