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

Adding new SupportedVersion condition to GatewayClass #2384

Merged
merged 1 commit into from
Sep 14, 2023

Conversation

robscott
Copy link
Member

@robscott robscott commented Sep 9, 2023

What type of PR is this?
/kind documentation
/kind feature

What this PR does / why we need it:
This is intended to fix #2077 by adding a new SupportedVersion condition on GatewayClass and corresponding documentation.

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

Does this PR introduce a user-facing change?:

GatewayClass Status: A new SupportedVersion condition has been added that MUST be set when a GatewayClass is accepted.

/hold for consensus

@robscott robscott added this to the v1.0.0 milestone Sep 9, 2023
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 9, 2023
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 9, 2023
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it, LGTM. Holding though in case we need further review.

/lgtm
/hold

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 11, 2023
@@ -186,6 +187,49 @@ const (
GatewayClassReasonWaiting GatewayClassConditionReason = "Waiting"
)

const (
// This condition indicates whether the GatewayClass supports the version(s)
// of Gateway API CRDs present in the cluster. This condition MUST be set by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this condition "MUST be set", would it make sense to update the conformance tests too?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we'll want to have corresponding updates to the conformance tests. I'd initially thought those should be a separate PR, but they may be simple enough to combine here.

Copy link
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm aware of the dilemma with generally not wanting to rely on information from CRDs, but I'm also aware we don't have an alternative to get this feature. Also if we ever needed to change it, it would be mostly on implementations. Generally, if we ever move off CRDs I think having to change this will be the least of problems we have to contend with.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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

@youngnick
Copy link
Contributor

I think that we have no option than to require something like this; I'm working on an implementer's guide that will lay out some suggestions for how to determine the required information in the right way.

I like the Condition idea because it allows implementations to mark the GatewayClass as Accepted, but show a clear warning that not everything may work.

I also agree that it would be nice to have conformance tests for this behavior, but I think that they may be harder to build than it seems (since we don't have any way to install different versions of the CRDs in the testing suite).

So I am going to merge this as-is, and create an issue for follow-up conformance testing of this Condition.

/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 14, 2023
@k8s-ci-robot k8s-ci-robot merged commit c99f726 into kubernetes-sigs:main Sep 14, 2023
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/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implementation Guidelines: Document Version Skew Between Implementations and CRDs
5 participants