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.

Sign up for GitHub

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

Jump to bottom

Update API and docs for GEP-2907 changes (BackendTLSPolicy) #2955

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Update API and docs for GEP-2907 changes (BackendTLSPolicy) #2955

merged 1 commit into from
Apr 18, 2024

Conversation

candita
Copy link
Contributor

@candita candita commented Apr 9, 2024 •
edited
Loading

What type of PR is this?

/kind cleanup
/kind documentation

What this PR does / why we need it:
Change BackendTLSPolicy.Spec.TLS to BackendTLSPolicy.Spec.Validation
Change BackendTLSPolicyConfig to BackendTLSPolicyValidation
Change CACertRefs to CACertificateRefs
Change WellKnownCACerts to WellKnownCACertificates

Updated code:
apis/v1alpha3/backendtlspolicy_types.go with GEP-2907 changes.

Changes to add v1alpha3 package name for build and code generation: apis/v1alpha3/doc.go
apis/v1alpha3/policy_types.go
apis/v1alpha3/shared_types.go
hack/update-codegen.sh
pkg/generator/main.go

Updated docs:
examples/experimental/v1alpha2/backendtlspolicy-ca-certs.yaml examples/experimental/v1alpha2/backendtlspolicy-system-certs.yaml geps/gep-1897/index.md
site-src/api-types/backendtlspolicy.md
site-src/guides/tls.md

All other file changes resulted from code generation.

TODO: May still need to update site-src/images/backendtlspolicy-api.png

Does this PR introduce a user-facing change?:

Adds v1alpha3 experimental BackendTLSPolicy with updated field names.
Change `BackendTLSPolicy.Spec.TLS` to `BackendTLSPolicy.Spec.Validation`
Change `BackendTLSPolicyConfig` to `BackendTLSPolicyValidation`
Change `CACertRefs` to `CACertificateRefs` 
Change `WellKnownCACerts` to `WellKnownCACertificates`

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. 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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 9, 2024
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/gep PRs related to Gateway Enhancement Proposal(GEP) labels Apr 9, 2024
robscott
robscott reviewed Apr 9, 2024
View reviewed changes
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks for all the work on this @candita!

apis/v1alpha3/backendtlspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha3/backendtlspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha3/backendtlspolicy_types.go Outdated Show resolved Hide resolved
apis/v1alpha3/policy_types.go Outdated Show resolved Hide resolved
apis/v1alpha3/shared_types.go Outdated Show resolved Hide resolved
examples/experimental/v1alpha2/backendtlspolicy-ca-certs.yaml Show resolved Hide resolved
hack/update-codegen.sh Outdated Show resolved Hide resolved
site-src/guides/tls.md Outdated Show resolved Hide resolved
@k8s-ci-robot
Copy link
Contributor

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

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

In response to this:

Given the overall painfulness of breaking changes, we may want to get ahead of one of the ones that seems very likely, plural targetRefs. This was one of the takeaways from our policy-focused meeting + KubeCon discussions that seemed to have broad consensus. More discussion in #2927 (comment). (Need more discussion before actually committing to a change here, but want to raise this as a discussion point so we can potentially avoid another breaking change in v1.2).

/cc @arkodg @gcs278 @guicassolato @mikemorris @shaneutt

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.

@candita candita force-pushed the gep-1897-update-for-gep-2907 branch 3 times, most recently from 3444517 to 99aaae6 Compare April 10, 2024 00:21
@candita candita changed the title For Gateway API changes introduced in GEP-2907 to be reflected in the docs and the new v1alpha3 API Gateway API changes introduced in GEP-2907 are to be reflected in the docs and the new v1alpha3 API Apr 10, 2024
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch 4 times, most recently from 33d8689 to 6b9ea8c Compare April 10, 2024 22:14
robscott
robscott reviewed Apr 11, 2024
View reviewed changes
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks for all the work on this @candita!

pkg/client/clientset/versioned/scheme/register.go Outdated Show resolved Hide resolved
apis/v1alpha3/shared_types.go Outdated Show resolved Hide resolved
apis/v1alpha2/backendtlspolicy_types.go Outdated Show resolved Hide resolved
@robscott robscott mentioned this pull request Apr 11, 2024
Merged
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch from 6b9ea8c to d5ebef6 Compare April 15, 2024 20:59
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch from d5ebef6 to d92cb16 Compare April 15, 2024 21:13
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 16, 2024
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Apr 16, 2024
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch 5 times, most recently from c8f5eb0 to 349b687 Compare April 17, 2024 18:18
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 17, 2024
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch 2 times, most recently from 871cae3 to 670ae83 Compare April 17, 2024 20:17
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Apr 17, 2024
@candita
For Gateway API changes introduced in GEP-2907 to be reflected in the…
4d45263 
… docs and the new v1alpha3 API.

Updated code:
apis/v1alpha3/backendtlspolicy_types.go with GEP-2907 changes.

Changes to add v1alpha3 package name for build and code generation:
apis/v1alpha3/doc.go
hack/update-codegen.sh
pkg/generator/main.go
pkg/test/cel/main_test.go
conformance/conformance.go
gwctl/pkg/common/clients.go

Updated docs:
examples/experimental/v1alpha3/backendtlspolicy-ca-certs.yaml
examples/experimental/v1alpha3/backendtlspolicy-system-certs.yaml
geps/gep-1897/index.md
site-src/api-types/backendtlspolicy.md
site-src/guides/tls.md

All other file changes resulted from code generation.

TODO: May still need to update site-src/images/backendtlspolicy-api.png
@candita candita force-pushed the gep-1897-update-for-gep-2907 branch from 670ae83 to 4d45263 Compare April 17, 2024 23:35
@robscott
Copy link
Member

Thanks for all the work on this @candita! Would love to get some feedback from someone that's implemented BackendTLSPolicy, but this LGTM.

/approve
/cc @arkodg @skriss @sunjayBhatia

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 17, 2024
@robscott robscott added this to the v1.1.0 milestone Apr 18, 2024
@arkodg
Copy link
Contributor

arkodg commented Apr 18, 2024

/approve

thanks !

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: arkodg, candita, 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

@robscott
Copy link
Member

Thanks @candita!

/hold cancel
/lgtm

@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 Apr 18, 2024
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 18, 2024
@k8s-ci-robot k8s-ci-robot merged commit a0fc8c2 into kubernetes-sigs:main Apr 18, 2024
8 checks passed
howardjohn added a commit to howardjohn/gateway-api that referenced this pull request Apr 25, 2024
@howardjohn
Add experimental kustomize back
7d07cf3 
Dropped in kubernetes-sigs#2955 for some reason. Since it was unrelated to that PR and
had no discussion, I assume it was accidental
@howardjohn howardjohn mentioned this pull request Apr 25, 2024
Merged
k8s-ci-robot pushed a commit that referenced this pull request Apr 25, 2024
@howardjohn
Add experimental kustomize back (#3022)
7320257 
Dropped in #2955 for some reason. Since it was unrelated to that PR and
had no discussion, I assume it was accidental
@mikemorris mikemorris mentioned this pull request Apr 26, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robscott robscott robscott left review comments

@kflynn kflynn kflynn left review comments

@gcs278 gcs278 Awaiting requested review from gcs278

@howardjohn howardjohn Awaiting requested review from howardjohn

@mikemorris mikemorris Awaiting requested review from mikemorris

@shaneutt shaneutt Awaiting requested review from shaneutt

@arkodg arkodg Awaiting requested review from arkodg

@LiorLieberman LiorLieberman Awaiting requested review from LiorLieberman

@mlavacca mlavacca Awaiting requested review from mlavacca

@skriss skriss Awaiting requested review from skriss

@sunjayBhatia sunjayBhatia Awaiting requested review from sunjayBhatia

Assignees

@robscott robscott

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/gwctl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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/gep PRs related to Gateway Enhancement Proposal(GEP) 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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
v1.1.0
Development

Successfully merging this pull request may close these issues.
6 participants
@candita @k8s-ci-robot @robscott @arkodg @kflynn @mikemorris