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

Mark group as optional in LocalObjectReference #3332

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tamalsaha
Copy link

@tamalsaha tamalsaha commented Sep 12, 2024

What type of PR is this?
/kind bug

What this PR does / why we need it:
Make group as optional in LocalObjectReference

Which issue(s) this PR fixes:

Fixes #3322

Does this PR introduce a user-facing change?:

Mark group as optional in LocalObjectReference

@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/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. kind/bug Categorizes issue or PR as related to a bug. labels Sep 12, 2024
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 12, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tamalsaha
Once this PR has been reviewed and has the lgtm label, please assign youngnick for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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
Copy link
Contributor

Welcome @tamalsaha!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@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/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 12, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @tamalsaha. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Sep 12, 2024
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 12, 2024
@tamalsaha tamalsaha changed the title Make group as optional in LocalObjectReference Mark group as optional in LocalObjectReference Sep 12, 2024
@youngnick
Copy link
Contributor

/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 Sep 12, 2024
@@ -27,6 +27,8 @@ package v1
type LocalObjectReference struct {
// Group is the group of the referent. For example, "gateway.networking.k8s.io".
// When unspecified or empty string, core API group is inferred.
//
// +optional
Copy link
Contributor

@arkodg arkodg Sep 12, 2024

Choose a reason for hiding this comment

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

also need to make Group a pointer and add an omitempty tag

Copy link
Author

Choose a reason for hiding this comment

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

Done!

@arkodg
Copy link
Contributor

arkodg commented Sep 12, 2024

this may not be a breaking change for users, but may be a breaking change for implementations, I still +1 this change to improve user experience (lesser config to write)

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 12, 2024
Signed-off-by: Tamal Saha <[email protected]>
@tamalsaha
Copy link
Author

/retest

@robscott
Copy link
Member

Let's hold off on this for a minute, I think this actually requires a bit more discussion.

/hold

Although I certainly would love to save some unnecessary config here if we can, I'm worried that we're going to end up with some unintended consequences.

As far as I can tell, there are currently 3 places in the API where we have a default group, and in all cases we also default kind:

  1. ParentRefs have a default group of gateway.networking.k8s.io and a default kind of Gateway
  2. BackendRefs have a default group "" and a default kind of Service
  3. SecretRefs (CertRef and ClientCertRef) have a default group of "" and a default kind of Secret

It looks like we're currently using LocalObjectReference in 2 places:

  1. ExtensionRef in HTTPRoute and GRPCRoute
  2. CACertificateRefs in BackendTLSPolicy

It seems very clear that we'd never want to default to the core ("") API group for ExtensionRef. CACertificateRefs is a little bit less clear on the surface, but given that our goal is to move to recommending something like ClusterTrustBundle here when it's ready instead of ConfigMaps, I think we'd regret defaulting to "" here.

So with all that said, my proposed change here would be much smaller. We'd just change "When unspecified or empty string" to "When empty string".

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/bug Categorizes issue or PR as related to a bug. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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.

Group is not optional in LocalObjectReference
5 participants