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

Phasing out Beta from Versioning Guide #2446

Merged
merged 1 commit into from Oct 9, 2023

Conversation

robscott
Copy link
Member

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This is a long overdue follow up from my original proposal to phase out beta from Gateway API versioning. Earlier this year, we presented this idea to SIG Network (Jan 19), Gateway API (Jan 23 and Aug 21), and SIG Architecture (Jan 26) meetings. In all cases, I believe we had consensus to move forward with this approach, I just needed to translate the proposal into reality.

With the upcoming v1.0 release of Gateway API, the time has come to define exactly how our versioning policy will work with GA APIs. As I'm doing that, I'm also taking the opportunity to translate this earlier proposal into reality.

Does this PR introduce a user-facing change?:

Gateway API versioning will continue to rely on two release channels - Standard and Experimental. New resources will start in the Experimental Channel with an alpha API Version and then graduate to the Standard Channel with a GA API version. Resources that already have Beta API versions will continue to have them, but no additional Gateway API resources will get a Beta API version.

This is a big change that will have a lasting impact on the API. Asking for lots of reviewers here. As always, please don't hesitate to review if I didn't list you below, trying to not mention too many people here, but everyone's input is appreciated.

/hold for consensus
/cc @arkodg @candita @gcs278 @mlavacca @sunjayBhatia
/assign @shaneutt @youngnick

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Sep 29, 2023
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 29, 2023
@k8s-ci-robot
Copy link
Contributor

@robscott: GitHub didn't allow me to request PR reviews from the following users: candita, gcs278.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This is a long overdue follow up from my original proposal to phase out beta from Gateway API versioning. Earlier this year, we presented this idea to SIG Network (Jan 19), Gateway API (Jan 23 and Aug 21), and SIG Architecture (Jan 26) meetings. In all cases, I believe we had consensus to move forward with this approach, I just needed to translate the proposal into reality.

With the upcoming v1.0 release of Gateway API, the time has come to define exactly how our versioning policy will work with GA APIs. As I'm doing that, I'm also taking the opportunity to translate this earlier proposal into reality.

Does this PR introduce a user-facing change?:

Gateway API versioning will continue to rely on two release channels - Standard and Experimental. New resources will start in the Experimental Channel with an alpha API Version and then graduate to the Standard Channel with a GA API version. Resources that already have Beta API versions will continue to have them, but no additional Gateway API resources will get a Beta API version.

This is a big change that will have a lasting impact on the API. Asking for lots of reviewers here. As always, please don't hesitate to review if I didn't list you below, trying to not mention too many people here, but everyone's input is appreciated.

/hold for consensus
/cc @arkodg @candita @gcs278 @mlavacca @sunjayBhatia
/assign @shaneutt @youngnick

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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 29, 2023
@robscott robscott added this to the v1.0.0 milestone Sep 29, 2023
Copy link
Contributor

@gcs278 gcs278 left a comment

Choose a reason for hiding this comment

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

Looks good to me. I just have some nit picks.

site-src/concepts/versioning.md Outdated Show resolved Hide resolved
site-src/concepts/versioning.md Outdated Show resolved Hide resolved
site-src/concepts/versioning.md Show resolved Hide resolved
Copy link
Contributor

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

This looks great, @robscott -- I have a question and I agree with the two nits @gcs278 pointed out, but I'm approving anyway because those could be tackled in a followon PR.

site-src/concepts/versioning.md Show resolved Hide resolved
@@ -3,19 +3,24 @@
* Issue: [#922](https://github.com/kubernetes-sigs/gateway-api/issues/922)
* Status: Standard

!!! note
Copy link
Member

Choose a reason for hiding this comment

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

is !!! note intended to be as it is? I see no fancy markdown stuff being rendered.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, it's rendered in the deploy preview - this is a directive to mkdocs, not a standard Markdown one.

@robscott
Copy link
Member Author

robscott commented Oct 3, 2023

Thanks everyone for the feedback! I think I've addressed everything, PTAL.

Copy link
Member

@mlavacca mlavacca left a comment

Choose a reason for hiding this comment

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

Looks great to me!

@mikemorris
Copy link
Contributor

mikemorris commented Oct 3, 2023

I think this change makes sense as we approach GA (where users should be able to expect the CRDs commonly installed by default to be stable and to not have breaking changes) and will help reduce the combinatorial complexity of understanding how release channels interact with API resource versioning.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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

@robscott
Copy link
Member Author

robscott commented Oct 6, 2023

Thanks everyone for the feedback! I think I've resolved everything now, PTAL.

@robscott
Copy link
Member Author

robscott commented Oct 6, 2023

I think we've got enough consensus here, going to remove the hold so the next LGTM merges this.

/hold cancel

@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 Oct 6, 2023
@youngnick
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 9, 2023
@k8s-ci-robot k8s-ci-robot merged commit a14be13 into kubernetes-sigs:main Oct 9, 2023
7 of 8 checks passed
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. 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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants