gateway-api icon indicating copy to clipboard operation
gateway-api copied to clipboard

Document the route kinds compatible for each protocolType

Open abs007 opened this issue 2 years ago • 22 comments

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

abs007 avatar Aug 05 '23 06:08 abs007

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: abs007 / name: Abhisman (49fdad094688a5c17b987ca80bb45d5083445c8e, d97d5d34040d7f42a0ed99fc8b3cb887041d5a5b, efd7923e18bb5eba3c85c73557e00fd515155c83, fa88a7740861000fbbe75ff101f9c8c59e5e09db, 2f4ba59c7e2be0f8a5c61d3526e18c27e8e445fb, 62ab86dd09a5260fdf2577e49100fe07393d8f37)
  • :white_check_mark: login: shaneutt / name: Shane Utt (cdf6d0bb1ce5145627e1cf7b128ceef33bfff5f9, d5c2b0a6b34d90f0231d3bb105de63e4aab834ee)

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. :smiley:

k8s-ci-robot avatar Aug 05 '23 06:08 k8s-ci-robot

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.

k8s-ci-robot avatar Aug 05 '23 06:08 k8s-ci-robot

/cc @mlavacca

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

shaneutt avatar Aug 07 '23 18:08 shaneutt

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.

youngnick avatar Aug 16 '23 05:08 youngnick

Thank you @youngnick!

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

abs007 avatar Aug 17 '23 08:08 abs007

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.

youngnick avatar Aug 20 '23 23:08 youngnick

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

abs007 avatar Aug 23 '23 22:08 abs007

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.

youngnick avatar Aug 24 '23 06:08 youngnick

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

abs007 avatar Aug 24 '23 07:08 abs007

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

abs007 avatar Sep 02 '23 20:09 abs007

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

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

mlavacca avatar Sep 13 '23 08:09 mlavacca

From the table here under the TLS Route section: https://gateway-api.sigs.k8s.io/concepts/api-overview/#route-summary-table

Precisely, this part: "Routing of TLS protocols including HTTPS"

abs007 avatar Sep 29 '23 20:09 abs007

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot avatar Jan 22 '24 16:01 k8s-triage-robot

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot avatar Feb 21 '24 16:02 k8s-triage-robot

HI @abs007, sorry to have put you on the spot earlier. I think that this change is fine as it is, once it's been rebased. Are you still able to pick it up?

youngnick avatar Feb 29 '24 05:02 youngnick

@youngnick Let me know if the current state of the pr is good enough for merging

abs007 avatar Mar 04 '24 06:03 abs007

Sorry @abs007, you'll just need to run make generate and then commit and repush.

youngnick avatar Mar 07 '24 22:03 youngnick

/remove-lifecycle rotten

/approve

/hold

youngnick avatar Mar 27 '24 22:03 youngnick

/approve /lgtm /unhold

shaneutt avatar Jun 21 '24 15:06 shaneutt

[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 avatar Jun 21 '24 15:06 k8s-ci-robot

New changes are detected. LGTM label has been removed.

k8s-ci-robot avatar Jun 21 '24 17:06 k8s-ci-robot

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

candita avatar Jun 24 '24 17:06 candita