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.47%. Comparing base (fa94869) to head (b659359).
Report is 9 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5111      +/-   ##
==========================================
+ Coverage   51.35%   52.47%   +1.11%     
==========================================
  Files         273      273              
  Lines       24670    29087    +4417     
==========================================
+ Hits        12670    15264    +2594     
- Misses      11211    13033    +1822     
- Partials      789      790       +1

☔ 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?

nojnhuh · 2024-09-27T19:27:41Z

api/v1beta1/azuremanagedcontrolplane_default.go

@@ -90,11 +87,8 @@ func (m *AzureManagedControlPlane) setDefaultSubnet() {
 	if m.Spec.VirtualNetwork.Subnet.Name == "" {
 		m.Spec.VirtualNetwork.Subnet.Name = m.Name
 	}
-	if m.Spec.VirtualNetwork.Subnet.CIDRBlock == "" {


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?

Webhooks are 100% invoked by the e2e tests. I'm not exactly sure why this specific error is cropping up, but the logic around here seems non-trivial so I'd be okay to omit the CIDR block changes from this PR. My main idea with #4204 was to pick off the low-hanging fruit.

Ok sounds good. I'll put those back.

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.

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]>

k8s-ci-robot · 2024-11-06T13:39:19Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign nojnhuh 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:

OWNERS

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

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

k8s-ci-robot · 2024-11-07T18:49:18Z

@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	`157f495`	link	false	`/test pull-cluster-api-provider-azure-apidiff`
pull-cluster-api-provider-azure-e2e-aks	`157f495`	link	true	`/test pull-cluster-api-provider-azure-e2e-aks`

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.

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

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

Set default values in API rather than in webhooks

157f495

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 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

Open

11 tasks

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 Sep 27, 2024

bryan-cox Sep 28, 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

k8s-ci-robot commented Nov 6, 2024

bryan-cox commented Nov 6, 2024

nojnhuh commented Nov 7, 2024

bryan-cox commented Nov 7, 2024

k8s-ci-robot commented Nov 7, 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

Are you sure you want to change the base?

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 Sep 27, 2024

Choose a reason for hiding this comment

bryan-cox Sep 28, 2024

Choose a reason for hiding this comment

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

k8s-ci-robot commented Nov 6, 2024

bryan-cox commented Nov 6, 2024

nojnhuh commented Nov 7, 2024

bryan-cox commented Nov 7, 2024

k8s-ci-robot commented Nov 7, 2024

codecov bot commented Sep 6, 2024 •

edited

Loading