Document the route kinds compatible for each protocolType #2263

abs007 · 2023-08-05T06:40:12Z

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR documents the route kinds compatible for each protocolType

Which issue(s) this PR fixes:
Fixes #1515

Does this PR introduce a user-facing change?:

NONE

linux-foundation-easycla · 2023-08-05T06:40:17Z

The committers listed above are authorized under a signed CLA.

✅ login: abs007 / name: Abhisman (49fdad0, d97d5d3, efd7923, fa88a77, 2f4ba59, 62ab86d)
✅ login: shaneutt / name: Shane Utt (cdf6d0b, d5c2b0a)

k8s-ci-robot · 2023-08-05T06:40:20Z

Welcome @abs007!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-08-05T06:40:21Z

Hi @abs007. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

shaneutt · 2023-08-07T18:47:03Z

/cc @mlavacca

Wanted to check if this is what you had in mind when you created #1512

mlavacca

Thanks for the PR, @abs007!

It looks like you need to run make update-codegen to fix the CI issue.

Wanted to check if this is what you had in mind when you created #1512

Yep, I meant something similar. However, I'm not 100% sure about the exhaustiveness and the correctness of the data. I think it makes sense to double-check it with the maintainers.

/cc @shaneutt @robscott @youngnick

youngnick · 2023-08-16T05:36:56Z

Thanks for laying this out so clearly, @abs007!

Seeing it like this, makes me think about the fact that the protocol is currently effectively a way to limit the kinds of Routes that may attach to a Listener - it's almost syntactic sugar for specific allowedRoutes config. I seem to recall having discussions about whether to allow protocol: TLS listener to have HTTPRoutes attach (implying that TLS mode must also be set to Terminate), but it seems like it may be better to keep things at this very simple level.

It's probably also worth checking if we have any conformance tests that don't fit into these buckets too.

abs007 · 2023-08-17T08:45:03Z

Thank you @youngnick!

Can you give a bit more context into the conformance tests bit?

skriss · 2023-08-17T15:07:14Z

apis/v1beta1/gateway_types.go

+	// HTTPS: HTTPRoutes, GRPCRoutes
+	// TCP: TCPRoute
+	// UDP:	UDPRoute
+	// TLS: TLSRoute


TLS protocol + TCPRoute should also be supported, right? (ref. https://gateway-api.sigs.k8s.io/guides/tls/ and https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-summary-table)

apis/v1beta1/gateway_types.go

youngnick · 2023-08-20T23:10:15Z

Thanks for the changes @abs007, I meant that it would be good to check that there's nothing else that we conformance test for - I suspect @skriss may have picked up one extra case, but it would be good if we could make sure there aren't any others.

abs007 · 2023-08-23T22:18:54Z

@youngnick and is this something that I verify by going through the code in the conformance folder? Asking as I'm a bit confused.

youngnick · 2023-08-24T06:58:33Z

Yeah, I don't think there's any quicker way than to check the conformance tests to make sure we're not allowing any other types of traffic. Sorry.

abs007 · 2023-08-24T07:45:54Z

That's alright. I just needed confirmation on where to look at.

abs007 · 2023-09-02T20:13:57Z

I've pushed a protocol:route combination that I could find.

mlavacca · 2023-09-13T08:25:08Z

I've pushed a protocol:route combination that I could find.

Can you point out where did you find such a combination, please?

youngnick · 2024-03-27T22:53:46Z

/remove-lifecycle rotten

/approve

/hold

apis/v1/gateway_types.go

site-src/concepts/api-overview.md

Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com>

mlavacca

Hi @abs007! this lgtm, if you can rebase it, I think we can merge it 👍

shaneutt · 2024-06-21T15:29:56Z

/approve
/lgtm
/unhold

k8s-ci-robot · 2024-06-21T15:30:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abs007, shaneutt, youngnick

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:

~~OWNERS~~ [shaneutt,youngnick]

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 · 2024-06-21T17:05:14Z

New changes are detected. LGTM label has been removed.

candita · 2024-06-24T17:15:13Z

We haven't documented some of these changes completely.
/revert a518fef

)" This reverts commit a518fef.

…-sigs#2263) * Document the route kinds compatible for each protocolType Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Fix grammar Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add suggested changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * chore: run generators --------- Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> Co-authored-by: Shane Utt <shaneutt@linux.com>

…bernetes-sigs#2263)" This reverts commit a518fef.

…-sigs#2263) * Document the route kinds compatible for each protocolType Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Fix grammar Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add suggested changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * chore: run generators --------- Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> Co-authored-by: Shane Utt <shaneutt@linux.com>

…bernetes-sigs#2263)" This reverts commit a518fef.

…-sigs#2263) * Document the route kinds compatible for each protocolType Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Fix grammar Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Run make command Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * Add suggested changes Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> * chore: run generators --------- Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com> Co-authored-by: Shane Utt <shaneutt@linux.com>

…bernetes-sigs#2263)" This reverts commit a518fef.

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Aug 5, 2023

k8s-ci-robot requested review from kflynn and shaneutt August 5, 2023 06:40

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 5, 2023

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 5, 2023

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 Aug 5, 2023

shaneutt added this to the v1.0.0 milestone Aug 7, 2023

k8s-ci-robot requested a review from mlavacca August 7, 2023 18:47

shaneutt added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 7, 2023

mlavacca reviewed Aug 10, 2023

View reviewed changes

k8s-ci-robot requested review from robscott and youngnick August 10, 2023 12:23

skriss reviewed Aug 17, 2023

View reviewed changes

mlavacca reviewed Aug 18, 2023

View reviewed changes

apis/v1beta1/gateway_types.go Outdated Show resolved Hide resolved

mlavacca reviewed Mar 29, 2024

View reviewed changes

apis/v1/gateway_types.go Outdated Show resolved Hide resolved

site-src/concepts/api-overview.md Outdated Show resolved Hide resolved

Add suggested changes

2f4ba59

Signed-off-by: Abhisman Sarkar <abhisman.sarkar@gmail.com>

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 17, 2024

mlavacca reviewed Jun 5, 2024

View reviewed changes

Merge branch 'main' into Document-route-kinds-for-protocolType

cdf6d0b

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 21, 2024

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 21, 2024

k8s-ci-robot assigned shaneutt Jun 21, 2024

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

chore: run generators

d5c2b0a

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

shaneutt added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2024

k8s-ci-robot merged commit a518fef into kubernetes-sigs:main Jun 21, 2024
8 checks passed

candita mentioned this pull request Jun 24, 2024

TLSRoute promotion to standard #3165

Open

shaneutt added a commit that referenced this pull request Jun 24, 2024

Revert "Document the route kinds compatible for each protocolType (#2263

c1b375b

)" This reverts commit a518fef.

BobyMCbobs pushed a commit to BobyMCbobs/kubernetes-sigs-gateway-api that referenced this pull request Jul 10, 2024

Revert "Document the route kinds compatible for each protocolType (ku…

2e9e0c2

…bernetes-sigs#2263)" This reverts commit a518fef.

BobyMCbobs pushed a commit to BobyMCbobs/kubernetes-sigs-gateway-api that referenced this pull request Jul 22, 2024

Revert "Document the route kinds compatible for each protocolType (ku…

a36ffb4

…bernetes-sigs#2263)" This reverts commit a518fef.

BobyMCbobs pushed a commit to BobyMCbobs/kubernetes-sigs-gateway-api that referenced this pull request Jul 22, 2024

Revert "Document the route kinds compatible for each protocolType (ku…

27b29ea

…bernetes-sigs#2263)" This reverts commit a518fef.

mlavacca mentioned this pull request Aug 19, 2024

docs: specify the route kinds compatible with each protocolType #1515

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the route kinds compatible for each protocolType #2263

Document the route kinds compatible for each protocolType #2263

abs007 commented Aug 5, 2023

linux-foundation-easycla bot commented Aug 5, 2023 •

edited

Loading

k8s-ci-robot commented Aug 5, 2023

k8s-ci-robot commented Aug 5, 2023

shaneutt commented Aug 7, 2023

mlavacca left a comment •

edited

Loading

youngnick commented Aug 16, 2023

abs007 commented Aug 17, 2023

skriss Aug 17, 2023

youngnick commented Aug 20, 2023

abs007 commented Aug 23, 2023

youngnick commented Aug 24, 2023

abs007 commented Aug 24, 2023

abs007 commented Sep 2, 2023

mlavacca commented Sep 13, 2023

youngnick commented Mar 27, 2024

mlavacca left a comment

shaneutt commented Jun 21, 2024

k8s-ci-robot commented Jun 21, 2024

k8s-ci-robot commented Jun 21, 2024

candita commented Jun 24, 2024

Document the route kinds compatible for each protocolType #2263

Document the route kinds compatible for each protocolType #2263

Conversation

abs007 commented Aug 5, 2023

linux-foundation-easycla bot commented Aug 5, 2023 • edited Loading

k8s-ci-robot commented Aug 5, 2023

k8s-ci-robot commented Aug 5, 2023

shaneutt commented Aug 7, 2023

mlavacca left a comment • edited Loading

Choose a reason for hiding this comment

youngnick commented Aug 16, 2023

abs007 commented Aug 17, 2023

skriss Aug 17, 2023

Choose a reason for hiding this comment

youngnick commented Aug 20, 2023

abs007 commented Aug 23, 2023

youngnick commented Aug 24, 2023

abs007 commented Aug 24, 2023

abs007 commented Sep 2, 2023

mlavacca commented Sep 13, 2023

youngnick commented Mar 27, 2024

mlavacca left a comment

Choose a reason for hiding this comment

shaneutt commented Jun 21, 2024

k8s-ci-robot commented Jun 21, 2024

k8s-ci-robot commented Jun 21, 2024

candita commented Jun 24, 2024

linux-foundation-easycla bot commented Aug 5, 2023 •

edited

Loading

mlavacca left a comment •

edited

Loading