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

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

Open
mlavacca opened this issue Nov 8, 2022 · 25 comments · Fixed by #2263
Open

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

mlavacca opened this issue Nov 8, 2022 · 25 comments · Fixed by #2263
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/needs-information Indicates an issue needs more information in order to work on it.

Comments

@mlavacca
Copy link
Member

mlavacca commented Nov 8, 2022

What would you like to be added:

The listener spec field allowedRoutes.kinds documentation states:

// Kinds specifies the groups and kinds of Routes that are allowed to bind
// to this Gateway Listener. When unspecified or empty, the kinds of Routes
// selected are determined using the Listener protocol.
//
// A RouteGroupKind MUST correspond to kinds of Routes that are compatible
// with the application protocol specified in the Listener's Protocol field.
// If an implementation does not support or recognize this resource type, it
// MUST set the "ResolvedRefs" condition to False for this Listener with the
// "InvalidRouteKinds" reason.

But there is no indication about the core kinds compatible with each protocolType. For this reason, an indication of which core routes are compatible for each protocol type is an important piece of information to add to the documentation.

Why this is needed:

This is needed to clearly state the core route kinds supported by each protocol type.

@mlavacca mlavacca added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 8, 2022
@mlavacca
Copy link
Member Author

mlavacca commented Nov 8, 2022

/kind docs

@k8s-ci-robot
Copy link
Contributor

@mlavacca: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to this:

/kind docs

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.

@mlavacca
Copy link
Member Author

mlavacca commented Nov 8, 2022

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 8, 2022
@mlavacca mlavacca changed the title docs: specify the route kinds supported by each protocolType docs: specify the route kinds compatible with each protocolType Nov 8, 2022
@shaneutt shaneutt added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Nov 8, 2022
@shaneutt shaneutt added this to the v0.6.1 milestone Nov 8, 2022
@shaneutt shaneutt modified the milestones: v0.6.1, v0.6.2 Jan 31, 2023
@shaneutt shaneutt added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Feb 21, 2023
@shaneutt shaneutt modified the milestones: v0.6.2, v0.7.0 Mar 14, 2023
@shaneutt shaneutt added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Mar 14, 2023
@ashutosh887
Copy link

I would like to take this @shaneutt

@youngnick
Copy link
Contributor

I think this is fine, but it's important to specify that the ones included in Gateway API are examples, not a full list. It's also intended that if implementations add their own types of Routes, then they include those custom Routes in allowedRoutes.

A similar disclaimer applies to supportedKinds in the status stanza.

@shaneutt
Copy link
Member

@ashutosh887 sounds good, but keep in mind this one could end up requiring some consensus building. Check in with us here or on K8s slack if you run into any questions along the way, and let us know how we can support you in this!

/assign @ashutosh887

@shaneutt
Copy link
Member

@ashutosh887 how are things going? Need any help moving this forward?

@shaneutt shaneutt assigned shaneutt and unassigned shaneutt and ashutosh887 May 18, 2023
@shaneutt shaneutt modified the milestones: v0.8.0, v1.0.0 May 22, 2023
@shaneutt
Copy link
Member

Still want this, but we expect it will be OK to have this after v1.0.0. We can hold on it until after the release.

@shaneutt shaneutt removed help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Jul 10, 2023
@shaneutt shaneutt removed this from the v1.0.0 milestone Jul 10, 2023
@abs007
Copy link
Contributor

abs007 commented Jul 10, 2023

I'm working on this. Haven't got the time to respond yet. Will do soon

@mlavacca
Copy link
Member Author

Thank you, @abs007!

/assign @abs007

@abs007
Copy link
Contributor

abs007 commented Jul 16, 2023

@mlavacca this is the table that I intend to make changes upon:
https://docs.google.com/spreadsheets/d/1trCeFLYDCiTnpkhxCMaRQ8DuwxgafJmNQMCI5QgsmLk/edit?usp=sharing

I am currently trying to understand the kind supported for each protocol. Do you have any additional info that you could point me to? Thanks

@mlavacca
Copy link
Member Author

@mlavacca this is the table that I intend to make changes upon: https://docs.google.com/spreadsheets/d/1trCeFLYDCiTnpkhxCMaRQ8DuwxgafJmNQMCI5QgsmLk/edit?usp=sharing

I am currently trying to understand the kind supported for each protocol. Do you have any additional info that you could point me to? Thanks

In addition to the list you provided here, I think we should add HTTPRoutes and GRPCRoutes to the HTTPS section. We should build consensus on this one. Therefore, I suggest you open a PR with such a table so that we can have a conversation there with the broader community.

@abs007
Copy link
Contributor

abs007 commented Jul 26, 2023

Any specific location where I should place the table?

Also, I'll make it in markdown, I suppose?

@mlavacca
Copy link
Member Author

mlavacca commented Aug 3, 2023

Any specific location where I should place the table?

Also, I'll make it in markdown, I suppose?

I'd say we need such information in two different places:

  1. in the documentation (md), in the form of a table. I'd say putting such a table in this file is ok.
  2. in the code, in the form of comments.

@k8s-triage-robot
Copy link

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 25, 2024
@k8s-triage-robot
Copy link

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 24, 2024
@k8s-triage-robot
Copy link

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

This bot triages issues 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 issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

@k8s-ci-robot k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 25, 2024
@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

This bot triages issues 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 issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

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.

@mlavacca
Copy link
Member Author

/reopen

@k8s-ci-robot
Copy link
Contributor

@mlavacca: Reopened this issue.

In response to this:

/reopen

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 k8s-ci-robot reopened this Mar 29, 2024
@mlavacca
Copy link
Member Author

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 29, 2024
@mlavacca
Copy link
Member Author

Reopening as #2263 has been reverted

/reopen

@k8s-ci-robot
Copy link
Contributor

@mlavacca: Reopened this issue.

In response to this:

Reopening as #2263 has been reverted

/reopen

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.

@k8s-ci-robot k8s-ci-robot reopened this Aug 19, 2024
@shaneutt shaneutt added the triage/needs-information Indicates an issue needs more information in order to work on it. label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
Status: Triage
Development

Successfully merging a pull request may close this issue.

8 participants