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

api: remove ListenerReasonUnsupportedExtension #1146

Conversation

mikemorris
Copy link
Contributor

@mikemorris mikemorris commented May 4, 2022

What type of PR is this?

/kind cleanup
/kind documentation
/kind api-change
/kind deprecation

What this PR does / why we need it:
This appears to be an artifact of the v1alpha1 configuration style where a listener selects routes directly. If I understand correctly, this is a reference to the ExtensionRef field on HTTPRouteRule (and other xRouteRule objects), which are the only other uses of the term Extension currently in the spec codebase.

UnsupportedExtension should likely become a RouteConditionReason instead, but I'm not quite sure with which RouteConditionType it should be used.

The intended behavior now is a bit unclear (it's an edge case not currently described in #1112). While rejecting a route entirely because of a single unsupported filter on one rule might have a large blast radius, I'm thinking through a few possible scenarios and potential impact/mitigation and wondering if that might actually be okay (and might even be desirable if using ExtensionRef to implement something like JWT auth):

  • Moving from one Gateway API implementation to another - some degree of breaking change is likely expected here and would hopefully be discovered in a test environment and mitigated manually.
  • Upgrading a Gateway API implementation to a new version which drops support for an old filter - this seems like something that should be clearly identified by the implementation as a breaking change in a changelog or mitigated safely through a deprecation process.
  • Attempting to add a new filter to an existing route rule and making a typo - this feels like the most likely common operator risk, could we perhaps suggest implementations add custom webhook validation for this field to prevent accepting invalid ExtensionRef configurations that cause an attached route to become detached?

Which issue(s) this PR fixes:

Refs #1077, #935 (comment)

Does this PR introduce a user-facing change?:

removes the UnsupportedExtension ListenerConditionReason intended for a route selection model that has changed in the v1alpha2 API

This appears to be an artifact of the v1alpha1 configuration style where
a listener selects routes.
@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/deprecation Categorizes issue or PR as related to a feature/enhancement marked for deprecation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 4, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @mikemorris. 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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 4, 2022
@robscott
Copy link
Member

robscott commented May 4, 2022

/ok-to-test

@k8s-ci-robot k8s-ci-robot 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 May 4, 2022
@robscott
Copy link
Member

robscott commented May 6, 2022

I agree that this removal makes sense. We should not detach a listener if a Route fails to attach to it. I think we should create a follow up issue to discuss what we should do instead of this. Will leave this for @hbagdi, @youngnick, or someone else to sign off. Or we can get final sign off at community meeting on Monday.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikemorris, robscott

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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 6, 2022
@youngnick
Copy link
Contributor

/lgtm

I agree this should go, and we can follow up the extra edge cases separately.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 19, 2022
@youngnick
Copy link
Contributor

/retest

@k8s-ci-robot k8s-ci-robot merged commit 91cb3c3 into kubernetes-sigs:master May 19, 2022
@mikemorris mikemorris deleted the api/remove-listener-reason-unsupported-extension branch May 20, 2022 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/deprecation Categorizes issue or PR as related to a feature/enhancement marked for deprecation. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants