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

Unsupported feature warning mechanism #1804

Open
shaneutt opened this issue Mar 10, 2023 · 9 comments
Open

Unsupported feature warning mechanism #1804

shaneutt opened this issue Mar 10, 2023 · 9 comments
Assignees
Labels
area/gwctl kind/feature Categorizes issue or PR as related to a new feature. kind/gep PRs related to Gateway Enhancement Proposal(GEP) priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@shaneutt
Copy link
Member

shaneutt commented Mar 10, 2023

What would you like to be added:

A mechanism by which implementations can clearly indicate when they don't support a particular feature and raise that to end-users who try to use the feature.

Why this is needed:

Presently if an end-user tries to use a feature on any given implementation (without having first thoroughly read the docs) it may be very unclear why that feature doesn't work if the implementation doesn't support it. As an improvement to UX it would be nice if implementations can implicate the features they do or do not support so that this can bubble up to the end-users.

Additional Notes:

I'm aware of two proposed ideas for the implementation of this historically:

  • using statuses to do this on individual objects
  • using the status on GatewayClass to indicate feature support, therefore enabling the validating webhook to make enforcements before the offending configurations can even be stored

We should consider those and any other options and make a small GEP for this to make sure we have consensus amongst stakeholders.

This relates slightly to #1709 and we should consider where there may be cross-pollination.

@shaneutt shaneutt added kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. labels Mar 10, 2023
@shaneutt shaneutt added this to the v1.0.0 milestone Mar 10, 2023
@shaneutt shaneutt added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels May 18, 2023
@LiorLieberman
Copy link
Member

/assign @LiorLieberman

@shaneutt shaneutt added the kind/gep PRs related to Gateway Enhancement Proposal(GEP) label Jun 12, 2023
@shaneutt shaneutt moved this from Backlog to In Progress in Gateway API: The Road to GA Jun 12, 2023
@shaneutt
Copy link
Member Author

Hey @LiorLieberman 👋 just checking in. Let us know if you need any help moving this forward, have any questions, e.t.c.

@LiorLieberman
Copy link
Member

As discussed, I opened a discussion item about it #2108.

Will try to follow up with a GEP OR expanding the conformance profiles GEP next week.

The first iteration would be enhancing the API, we will follow up with the webhook work once we have a few implementations already reporting features in the GWC status.

@shaneutt shaneutt removed this from the v1.0.0 milestone Sep 27, 2023
@LiorLieberman
Copy link
Member

GatewayClassStatus enhancement to include the features is covered by #2163 and is implemented in #2461.

What do you want to do with this issue? I think we should wait until we see more implementations of the SupportedFeatures in status and then revisit the warning mechanism. It may also fit to be a gwctl command

@shaneutt
Copy link
Member Author

I don't want to see it become only a gwctl command as I think functionality should be exposed through the API as much as possible, but obviously it would be fine if gwctl has some special handling of it for convenience.

@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 31, 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 Mar 1, 2024
@gauravkghildiyal
Copy link
Member

gauravkghildiyal commented Jul 24, 2024

/area gwctl
(Adding a tag for better tracking, but I agree with the sentiment from Shane in #1804 (comment) that this isn't necessarily restricted to gwctl)

@LiorLieberman
Copy link
Member

/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 Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/gwctl kind/feature Categorizes issue or PR as related to a new feature. kind/gep PRs related to Gateway Enhancement Proposal(GEP) priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

No branches or pull requests

5 participants