Skip to content

⚠️ Drop unnecessary fields from ClusterClass template references #12358

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
Merged
merged 6 commits into from
Jun 17, 2025
Merged

⚠️ Drop unnecessary fields from ClusterClass template references #12358

merged 6 commits into from
Jun 17, 2025

Conversation

fabriziopandini
Copy link
Member

What this PR does / why we need it:
Another cleanup to keep our API surface as small as clean as we can

Part of #6539

/area clusterclass

@k8s-ci-robot k8s-ci-robot added area/clusterclass Issues or PRs related to clusterclass cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 13, 2025
@k8s-ci-robot k8s-ci-robot requested review from elmiko and JoelSpeed June 13, 2025 18:02
@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 13, 2025
@k8s-ci-robot
Copy link
Contributor

@fabriziopandini: The /test command needs one or more targets.
The following commands are available to trigger required jobs:

/test pull-cluster-api-build-main

/test pull-cluster-api-e2e-blocking-main

/test pull-cluster-api-e2e-conformance-ci-latest-main

/test pull-cluster-api-e2e-conformance-main

/test pull-cluster-api-e2e-latestk8s-main

/test pull-cluster-api-e2e-main

/test pull-cluster-api-e2e-mink8s-main

/test pull-cluster-api-e2e-upgrade-1-33-1-34-main

/test pull-cluster-api-test-main

/test pull-cluster-api-test-mink8s-main

/test pull-cluster-api-verify-main

The following commands are available to trigger optional jobs:

/test pull-cluster-api-apidiff-main

Use /test all to run the following jobs that were automatically triggered:

pull-cluster-api-apidiff-main

pull-cluster-api-build-main

pull-cluster-api-e2e-blocking-main

pull-cluster-api-test-main

pull-cluster-api-verify-main

In response to this:

/test

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.

@fabriziopandini
Copy link
Member Author

/test pull-cluster-api-e2e-conformance-ci-latest-main
/test pull-cluster-api-e2e-conformance-main
/test pull-cluster-api-e2e-latestk8s-main
/test pull-cluster-api-e2e-main
/test pull-cluster-api-e2e-mink8s-main
/test pull-cluster-api-e2e-upgrade-1-33-1-34-main

@fabriziopandini fabriziopandini added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jun 16, 2025
@fabriziopandini
Copy link
Member Author

/test pull-cluster-api-e2e-conformance-ci-latest-main
/test pull-cluster-api-e2e-conformance-main
/test pull-cluster-api-e2e-latestk8s-main
/test pull-cluster-api-e2e-main
/test pull-cluster-api-e2e-mink8s-main
/test pull-cluster-api-e2e-upgrade-1-33-1-34-main

JoelSpeed
JoelSpeed reviewed Jun 16, 2025
View reviewed changes
JoelSpeed
JoelSpeed reviewed Jun 16, 2025
View reviewed changes
@JoelSpeed JoelSpeed mentioned this pull request Jun 16, 2025
Merged
sbueringer
sbueringer reviewed Jun 16, 2025
View reviewed changes
@fabriziopandini
Copy link
Member Author

/test pull-cluster-api-e2e-conformance-ci-latest-main
/test pull-cluster-api-e2e-conformance-main
/test pull-cluster-api-e2e-latestk8s-main
/test pull-cluster-api-e2e-main
/test pull-cluster-api-e2e-mink8s-main
/test pull-cluster-api-e2e-upgrade-1-33-1-34-main

JoelSpeed
JoelSpeed reviewed Jun 16, 2025
View reviewed changes
JoelSpeed
JoelSpeed reviewed Jun 16, 2025
View reviewed changes
@fabriziopandini fabriziopandini force-pushed the refactor-clusterclass-templateRef branch from dc364d2 to ca3719e Compare June 16, 2025 14:33
JoelSpeed
JoelSpeed reviewed Jun 16, 2025
View reviewed changes
@fabriziopandini
Copy link
Member Author

/test pull-cluster-api-e2e-conformance-ci-latest-main
/test pull-cluster-api-e2e-conformance-main
/test pull-cluster-api-e2e-latestk8s-main
/test pull-cluster-api-e2e-main
/test pull-cluster-api-e2e-mink8s-main
/test pull-cluster-api-e2e-upgrade-1-33-1-34-main

@fabriziopandini fabriziopandini mentioned this pull request Jun 16, 2025
Merged
sbueringer
sbueringer reviewed Jun 17, 2025
View reviewed changes
@fabriziopandini
Copy link
Member Author

@JoelSpeed @sbueringer comments should be addressed.
If you want to take more time to decide how to surface validation rule, let's also consider merging this PR and circle back later when there is agreement

@sbueringer
Copy link
Member

Thank you!!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 17, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8aa20659570aee3619322cd060bbc24dfb8c22d1

@sbueringer
Copy link
Member

/test pull-cluster-api-e2e-main

JoelSpeed
JoelSpeed reviewed Jun 17, 2025
View reviewed changes
api/core/v1beta2/clusterclass_types.go
// ref is a required reference to a custom resource
// offered by a provider.
// +required
Ref *corev1.ObjectReference `json:"ref"`
Ref *ClusterClassTemplateReference `json:"ref"`
Copy link
Contributor

Choose a reason for hiding this comment

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

Given this is required, does it need to be a pointer? I think we could avoid dereferencing complexity

I think the correct thing to do here is

Suggested change
Ref *ClusterClassTemplateReference `json:"ref"`
Ref ClusterClassTemplateReference `json:"ref,omitzero"`

With this, when there's nothing specified within, the field will be omitted from the representation, which will trigger the field to fail a "required" check implemented by the openapi validation on CRDs.

(Assuming we are using Go 1.24?)

Is there something specific we are using a pointer to represent here?

Copy link
Member

Choose a reason for hiding this comment

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

Let's defer this. We're tracking this one in #10852.

I now also linked your comment there

Copy link
Member

Choose a reason for hiding this comment

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

Fixed in #12299

@sbueringer sbueringer mentioned this pull request Jun 17, 2025
Closed
62 tasks
@JoelSpeed
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JoelSpeed

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 Jun 17, 2025
@k8s-ci-robot k8s-ci-robot merged commit 01ff70b into kubernetes-sigs:main Jun 17, 2025
20 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.11 milestone Jun 17, 2025
@fabriziopandini fabriziopandini deleted the refactor-clusterclass-templateRef branch July 22, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbueringer sbueringer sbueringer left review comments

@elmiko elmiko Awaiting requested review from elmiko

+1 more reviewer

@JoelSpeed JoelSpeed JoelSpeed left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@sbueringer sbueringer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/clusterclass Issues or PRs related to clusterclass cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
v1.11
Development

Successfully merging this pull request may close these issues.
4 participants
@fabriziopandini @k8s-ci-robot @sbueringer @JoelSpeed