Set default values in API rather than in webhooks #5111

bryan-cox · 2024-09-05T19:42:13Z

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
This commit removes default values previously set in webhooks and adds the default values directly in the API through the kubebuilder annotation, kubebuilder:default.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #4204

Special notes for your reviewer:

cherry-pick candidate

TODOs:

squashed commits
includes documentation
adds unit tests

Release note:

Removes default values previously set in webhooks and adds the default values directly in the API through the kubebuilder annotation, `kubebuilder:default`.

k8s-ci-robot · 2024-09-05T19:42:23Z

Hi @bryan-cox. 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.

api/v1beta1/azuremanagedcontrolplane_types.go

codecov · 2024-09-06T19:00:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.34%. Comparing base (fa94869) to head (a0b707d).
Report is 150 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5111      +/-   ##
==========================================
+ Coverage   51.35%   52.34%   +0.98%     
==========================================
  Files         273      272       -1     
  Lines       24670    29343    +4673     
==========================================
+ Hits        12670    15360    +2690     
- Misses      11211    13178    +1967     
- Partials      789      805      +16

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bryan-cox · 2024-09-26T16:03:49Z

@nojnhuh @jackfrancis - do we want to continue with this PR? If so, could I get an ok to test this please?

mboersma · 2024-09-26T16:13:39Z

/ok-to-test

bryan-cox · 2024-09-26T18:17:23Z

/retest

bryan-cox · 2024-09-26T19:22:57Z

For pull-cluster-api-provider-azure-e2e-aks

Expected success, but got an error:
    <errors.aggregate | len:1, cap:1>: 
    admission webhook "validation.azuremanagedcontrolplanes.infrastructure.cluster.x-k8s.io" denied the request: [spec.virtualNetwork.CIDRBlock: Invalid value: "": pre-existing virtual networks CIDR block is invalid, spec.virtualNetwork.Subnet.CIDRBlock: Invalid value: "": pre-existing subnets CIDR block is invalid]
    [

Not sure how these would be empty when they are defaulted here and here.

Does the e2e use any API changes from the PR?

api/v1beta1/azuremanagedcontrolplane_default.go

nojnhuh

Loving all the red in this diff so far!

api/v1beta1/types.go

api/v1beta1/azuremanagedcontrolplane_default.go

nojnhuh · 2024-10-23T19:01:14Z

api/v1beta1/azuremanagedcontrolplane_default.go

-		// Default is the same as the ScanInterval so default to that same value if it isn't set
-		result.ScaleDownDelayAfterDelete = result.ScanInterval


I don't think this can be expressed in the kubebuilder annotations, so maybe best to keep just this field here.

Isn't setting this to the same default value in the kubebuilder annotations accomplishing the same purpose here though? It's just a default value if the value isn't set, which what was happening here before.

nojnhuh · 2024-10-23T19:22:50Z

api/v1beta1/azuremanagedcontrolplane_types.go

-	Name      string `json:"name"`
+	Name string `json:"name"`
+
+	// +kubebuilder:default:="10.240.0.0/16"


The logic we had for this already seems necessary, so I don't think it buys us anything to include this kubebuilder annotation.

Happy to remove it but does it hurt anything to include the default here?

nojnhuh · 2024-10-23T19:42:49Z

api/v1beta1/types_class.go

@@ -419,6 +422,7 @@ type AzureManagedMachinePoolClassSpec struct {

 // ManagedControlPlaneVirtualNetworkClassSpec defines the ManagedControlPlaneVirtualNetwork properties that may be shared across several managed control plane vnets.
 type ManagedControlPlaneVirtualNetworkClassSpec struct {
+	// +kubebuilder:default:="10.0.0.0/8"


Same as the other CIDR block comment above.

bryan-cox · 2024-11-06T15:04:21Z

/retest

nojnhuh · 2024-11-07T16:47:50Z

I'll get back to this as soon as I can.

/assign

bryan-cox · 2024-11-07T17:16:12Z

/test pull-cluster-api-provider-azure-e2e-aks

bryan-cox · 2024-11-25T19:05:52Z

/test pull-cluster-api-provider-azure-e2e-aks

mboersma · 2024-12-12T17:04:39Z

@nojnhuh could you take another look at this when time permits?

nojnhuh · 2024-12-12T19:23:20Z

Sorry, I'm not optimistic I'll be able to get back to this before I take off for the holidays. I'll let someone else take on reviewing this if I can't get back to it.

/unassign

willie-yao · 2024-12-12T19:32:24Z

No problem, I got it!
/assign

willie-yao

Looks good pending one minor nit!

api/v1beta1/azuremanagedcontrolplane_types.go

willie-yao · 2024-12-12T21:42:12Z

@mboersma Can you take a look as well so we have two reviewers?

This commit removes default values previously set in webhooks and adds the default values directly in the API through the kubebuilder annotation, `kubebuilder:default`. Signed-off-by: Bryan Cox <[email protected]>

mboersma

/lgtm
/test pull-cluster-api-provider-azure-e2e-optional
/test pull-cluster-api-provider-azure-apiversion-upgrade

k8s-ci-robot · 2024-12-13T17:53:57Z

LGTM label has been added.

Git tree hash: a95acb3b51f6d1cb17d036ba57bcba509f55d3c6

k8s-ci-robot · 2024-12-13T18:43:53Z

@bryan-cox: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-azure-apidiff	`a0b707d`	link	false	`/test pull-cluster-api-provider-azure-apidiff`
pull-cluster-api-provider-azure-e2e-optional	`a0b707d`	link	false	`/test pull-cluster-api-provider-azure-e2e-optional`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

willie-yao

/lgtm
/approve

Thank you for your work and patience on this! @bryan-cox

k8s-ci-robot · 2024-12-13T19:12:15Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: willie-yao

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:

~~OWNERS~~ [willie-yao]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

willie-yao · 2024-12-13T19:12:31Z

/retest

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 5, 2024

k8s-ci-robot requested review from jsturtevant and marosset September 5, 2024 19:42

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 5, 2024

jackfrancis reviewed Sep 5, 2024

View reviewed changes

api/v1beta1/azuremanagedcontrolplane_types.go Show resolved Hide resolved

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 26, 2024

nojnhuh reviewed Sep 27, 2024

View reviewed changes

api/v1beta1/azuremanagedcontrolplane_default.go Outdated Show resolved Hide resolved

bryan-cox force-pushed the 4204 branch 3 times, most recently from 317973f to b659359 Compare October 23, 2024 11:37

nojnhuh reviewed Oct 23, 2024

View reviewed changes

bryan-cox force-pushed the 4204 branch from b659359 to 157f495 Compare November 6, 2024 13:39

k8s-ci-robot assigned nojnhuh Nov 7, 2024

nawazkh added this to the v1.18 milestone Nov 7, 2024

bryan-cox mentioned this pull request Nov 15, 2024

REQUEST: New membership for @bryan-cox kubernetes/org#5260

Closed

11 tasks

dtzar modified the milestones: v1.18, next Nov 19, 2024

bryan-cox force-pushed the 4204 branch 3 times, most recently from 475fc5d to d06d8fb Compare December 5, 2024 20:00

k8s-ci-robot unassigned nojnhuh Dec 12, 2024

k8s-ci-robot assigned willie-yao Dec 12, 2024

willie-yao reviewed Dec 12, 2024

View reviewed changes

api/v1beta1/azuremanagedcontrolplane_types.go Outdated Show resolved Hide resolved

Set default values in API rather than in webhooks

a0b707d

This commit removes default values previously set in webhooks and adds the default values directly in the API through the kubebuilder annotation, `kubebuilder:default`. Signed-off-by: Bryan Cox <[email protected]>

bryan-cox force-pushed the 4204 branch from d06d8fb to a0b707d Compare December 13, 2024 02:24

mboersma reviewed Dec 13, 2024

View reviewed changes

k8s-ci-robot assigned mboersma Dec 13, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 13, 2024

willie-yao approved these changes Dec 13, 2024

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 13, 2024

k8s-ci-robot merged commit f35cdf1 into kubernetes-sigs:main Dec 13, 2024
21 of 23 checks passed

k8s-ci-robot modified the milestones: next, v1.18 Dec 13, 2024

bryan-cox deleted the 4204 branch December 13, 2024 19:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set default values in API rather than in webhooks #5111

Set default values in API rather than in webhooks #5111

bryan-cox commented Sep 5, 2024

k8s-ci-robot commented Sep 5, 2024

codecov bot commented Sep 6, 2024 •

edited

Loading

bryan-cox commented Sep 26, 2024

mboersma commented Sep 26, 2024

bryan-cox commented Sep 26, 2024

bryan-cox commented Sep 26, 2024

nojnhuh left a comment

nojnhuh Oct 23, 2024

bryan-cox Nov 6, 2024

nojnhuh Oct 23, 2024

bryan-cox Nov 6, 2024

nojnhuh Oct 23, 2024

bryan-cox commented Nov 6, 2024

nojnhuh commented Nov 7, 2024

bryan-cox commented Nov 7, 2024

bryan-cox commented Nov 25, 2024

mboersma commented Dec 12, 2024

nojnhuh commented Dec 12, 2024

willie-yao commented Dec 12, 2024

willie-yao left a comment

willie-yao commented Dec 12, 2024

mboersma left a comment

k8s-ci-robot commented Dec 13, 2024

k8s-ci-robot commented Dec 13, 2024

willie-yao left a comment

k8s-ci-robot commented Dec 13, 2024

willie-yao commented Dec 13, 2024

		// Default is the same as the ScanInterval so default to that same value if it isn't set
		result.ScaleDownDelayAfterDelete = result.ScanInterval

Set default values in API rather than in webhooks #5111

Set default values in API rather than in webhooks #5111

Conversation

bryan-cox commented Sep 5, 2024

k8s-ci-robot commented Sep 5, 2024

codecov bot commented Sep 6, 2024 • edited Loading

Codecov Report

bryan-cox commented Sep 26, 2024

mboersma commented Sep 26, 2024

bryan-cox commented Sep 26, 2024

bryan-cox commented Sep 26, 2024

nojnhuh left a comment

Choose a reason for hiding this comment

nojnhuh Oct 23, 2024

Choose a reason for hiding this comment

bryan-cox Nov 6, 2024

Choose a reason for hiding this comment

nojnhuh Oct 23, 2024

Choose a reason for hiding this comment

bryan-cox Nov 6, 2024

Choose a reason for hiding this comment

nojnhuh Oct 23, 2024

Choose a reason for hiding this comment

bryan-cox commented Nov 6, 2024

nojnhuh commented Nov 7, 2024

bryan-cox commented Nov 7, 2024

bryan-cox commented Nov 25, 2024

mboersma commented Dec 12, 2024

nojnhuh commented Dec 12, 2024

willie-yao commented Dec 12, 2024

willie-yao left a comment

Choose a reason for hiding this comment

willie-yao commented Dec 12, 2024

mboersma left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 13, 2024

k8s-ci-robot commented Dec 13, 2024

willie-yao left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Dec 13, 2024

willie-yao commented Dec 13, 2024

codecov bot commented Sep 6, 2024 •

edited

Loading