Skip to content

🐛 Fix ControlPlaneComponentHealthCheckSeconds validation in KubeadmConfigSpec.Validate #12609

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

Merged
k8s-ci-robot merged 1 commit into from
Aug 11, 2025
Merged

🐛 Fix ControlPlaneComponentHealthCheckSeconds validation in KubeadmConfigSpec.Validate #12609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 29 additions & 24 deletions api/bootstrap/kubeadm/v1beta2/kubeadmconfig_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ type KubeadmConfigSpec struct {
}

// Validate ensures the KubeadmConfigSpec is valid.
func (c *KubeadmConfigSpec) Validate(pathPrefix *field.Path) field.ErrorList {
func (c *KubeadmConfigSpec) Validate(isKCP bool, pathPrefix *field.Path) field.ErrorList {
var allErrs field.ErrorList

allErrs = append(allErrs, c.validateFiles(pathPrefix)...)
Expand All @@ -166,29 +166,34 @@ func (c *KubeadmConfigSpec) Validate(pathPrefix *field.Path) field.ErrorList {
}
}

// Validate timeouts
// Note: When v1beta1 will be removed, we can drop this limitation.
tInit := "unset"
if c.InitConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds != nil {
tInit = fmt.Sprintf("%d", *c.InitConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds)
}
tJoin := "unset"
if c.JoinConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds != nil {
tJoin = fmt.Sprintf("%d", *c.JoinConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds)
}
if tInit != tJoin {
allErrs = append(allErrs,
field.Invalid(
pathPrefix.Child("initConfiguration", "timeouts", "controlPlaneComponentHealthCheckSeconds"),
tInit,
fmt.Sprintf("controlPlaneComponentHealthCheckSeconds must be set to the same value both in initConfiguration.timeouts (%s) and in joinConfiguration.timeouts (%s)", tInit, tJoin),
),
field.Invalid(
pathPrefix.Child("joinConfiguration", "timeouts", "controlPlaneComponentHealthCheckSeconds"),
tJoin,
fmt.Sprintf("controlPlaneComponentHealthCheckSeconds must be set to the same value both in initConfiguration.timeouts (%s) and in joinConfiguration.timeouts (%s)", tInit, tJoin),
),
)
// Only ensure ControlPlaneComponentHealthCheckSeconds fields are equal for KubeadmControlPlane and KubeadmControlPlaneTemplate.
// In KubeadmConfig objects usually only one of InitConfiguration or JoinConfiguration is defined as a Machine uses
// either kubeadm init or kubeadm join, but not both.
if isKCP {
Copy link
Member Author

@sbueringer sbueringer Aug 11, 2025

Choose a reason for hiding this comment

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

We can't enforce this for KubeadmConfig / KubeadmConfigTemplate.

KubeadmConfig will only have InitConfiguration or JoinConfiguration
KubeadmConfigTemplate will only have JoinConfiguration (it's only for worker nodes and they only use kubeadm join)

Anyway, this whole validation block will be removed when we drop v1beta1

// Validate timeouts
// Note: When v1beta1 will be removed, we can drop this limitation.
tInit := "unset"
if c.InitConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds != nil {
tInit = fmt.Sprintf("%d", *c.InitConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds)
}
tJoin := "unset"
if c.JoinConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds != nil {
tJoin = fmt.Sprintf("%d", *c.JoinConfiguration.Timeouts.ControlPlaneComponentHealthCheckSeconds)
}
if tInit != tJoin {
allErrs = append(allErrs,
field.Invalid(
pathPrefix.Child("initConfiguration", "timeouts", "controlPlaneComponentHealthCheckSeconds"),
tInit,
fmt.Sprintf("controlPlaneComponentHealthCheckSeconds must be set to the same value both in initConfiguration.timeouts (%s) and in joinConfiguration.timeouts (%s)", tInit, tJoin),
),
field.Invalid(
pathPrefix.Child("joinConfiguration", "timeouts", "controlPlaneComponentHealthCheckSeconds"),
tJoin,
fmt.Sprintf("controlPlaneComponentHealthCheckSeconds must be set to the same value both in initConfiguration.timeouts (%s) and in joinConfiguration.timeouts (%s)", tInit, tJoin),
),
)
}
}

return allErrs
Expand Down
2 changes: 1 addition & 1 deletion bootstrap/kubeadm/internal/webhooks/kubeadmconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func (webhook *KubeadmConfig) ValidateDelete(_ context.Context, _ runtime.Object
}

func (webhook *KubeadmConfig) validate(c bootstrapv1.KubeadmConfigSpec, name string) error {
allErrs := c.Validate(field.NewPath("spec"))
allErrs := c.Validate(false, field.NewPath("spec"))

if len(allErrs) == 0 {
return nil
Expand Down
20 changes: 18 additions & 2 deletions bootstrap/kubeadm/internal/webhooks/kubeadmconfig_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ func TestKubeadmConfigValidate(t *testing.T) {
},
},
},
"invalid ControlPlaneComponentHealthCheckSeconds": {
"valid ControlPlaneComponentHealthCheckSeconds (JoinConfiguration not defined)": {
in: &bootstrapv1.KubeadmConfig{
ObjectMeta: metav1.ObjectMeta{
Name: "baz",
Expand All @@ -464,7 +464,23 @@ func TestKubeadmConfigValidate(t *testing.T) {
},
},
},
expectErr: true,
expectErr: false,
},
"valid ControlPlaneComponentHealthCheckSeconds (InitConfiguration not defined)": {
in: &bootstrapv1.KubeadmConfig{
ObjectMeta: metav1.ObjectMeta{
Name: "baz",
Namespace: metav1.NamespaceDefault,
},
Spec: bootstrapv1.KubeadmConfigSpec{
JoinConfiguration: bootstrapv1.JoinConfiguration{
Timeouts: bootstrapv1.Timeouts{
ControlPlaneComponentHealthCheckSeconds: ptr.To[int32](10),
},
},
},
},
expectErr: false,
},
"valid ControlPlaneComponentHealthCheckSeconds": {
in: &bootstrapv1.KubeadmConfig{
Expand Down
2 changes: 1 addition & 1 deletion bootstrap/kubeadm/internal/webhooks/kubeadmconfigtemplate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func (webhook *KubeadmConfigTemplate) ValidateDelete(_ context.Context, _ runtim
func (webhook *KubeadmConfigTemplate) validate(r *bootstrapv1.KubeadmConfigTemplateSpec, name string) error {
var allErrs field.ErrorList

allErrs = append(allErrs, r.Template.Spec.Validate(field.NewPath("spec", "template", "spec"))...)
allErrs = append(allErrs, r.Template.Spec.Validate(false, field.NewPath("spec", "template", "spec"))...)
// Validate the metadata of the template.
allErrs = append(allErrs, r.Template.ObjectMeta.Validate(field.NewPath("spec", "template", "metadata"))...)

Expand Down
4 changes: 2 additions & 2 deletions controlplane/kubeadm/internal/webhooks/kubeadm_control_plane.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func (webhook *KubeadmControlPlane) ValidateCreate(_ context.Context, obj runtim
spec := k.Spec
allErrs := validateKubeadmControlPlaneSpec(spec, field.NewPath("spec"))
allErrs = append(allErrs, validateClusterConfiguration(nil, &spec.KubeadmConfigSpec.ClusterConfiguration, field.NewPath("spec", "kubeadmConfigSpec", "clusterConfiguration"))...)
allErrs = append(allErrs, spec.KubeadmConfigSpec.Validate(field.NewPath("spec", "kubeadmConfigSpec"))...)
allErrs = append(allErrs, spec.KubeadmConfigSpec.Validate(true, field.NewPath("spec", "kubeadmConfigSpec"))...)
if len(allErrs) > 0 {
return nil, apierrors.NewInvalid(clusterv1.GroupVersion.WithKind("KubeadmControlPlane").GroupKind(), k.Name, allErrs)
}
Expand Down Expand Up @@ -261,7 +261,7 @@ func (webhook *KubeadmControlPlane) ValidateUpdate(_ context.Context, oldObj, ne
allErrs = append(allErrs, webhook.validateVersion(oldK, newK)...)
allErrs = append(allErrs, validateClusterConfiguration(&oldK.Spec.KubeadmConfigSpec.ClusterConfiguration, &newK.Spec.KubeadmConfigSpec.ClusterConfiguration, field.NewPath("spec", "kubeadmConfigSpec", "clusterConfiguration"))...)
allErrs = append(allErrs, webhook.validateCoreDNSVersion(oldK, newK)...)
allErrs = append(allErrs, newK.Spec.KubeadmConfigSpec.Validate(field.NewPath("spec", "kubeadmConfigSpec"))...)
allErrs = append(allErrs, newK.Spec.KubeadmConfigSpec.Validate(true, field.NewPath("spec", "kubeadmConfigSpec"))...)

if len(allErrs) > 0 {
return nil, apierrors.NewInvalid(clusterv1.GroupVersion.WithKind("KubeadmControlPlane").GroupKind(), newK.Name, allErrs)
Expand Down
2 changes: 1 addition & 1 deletion controlplane/kubeadm/internal/webhooks/kubeadmcontrolplanetemplate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func (webhook *KubeadmControlPlaneTemplate) ValidateCreate(_ context.Context, ob
spec := k.Spec.Template.Spec
allErrs := validateKubeadmControlPlaneTemplateResourceSpec(spec, field.NewPath("spec", "template", "spec"))
allErrs = append(allErrs, validateClusterConfiguration(nil, &spec.KubeadmConfigSpec.ClusterConfiguration, field.NewPath("spec", "template", "spec", "kubeadmConfigSpec", "clusterConfiguration"))...)
allErrs = append(allErrs, spec.KubeadmConfigSpec.Validate(field.NewPath("spec", "template", "spec", "kubeadmConfigSpec"))...)
allErrs = append(allErrs, spec.KubeadmConfigSpec.Validate(true, field.NewPath("spec", "template", "spec", "kubeadmConfigSpec"))...)
// Validate the metadata of the KubeadmControlPlaneTemplateResource
allErrs = append(allErrs, k.Spec.Template.ObjectMeta.Validate(field.NewPath("spec", "template", "metadata"))...)
if len(allErrs) > 0 {
Expand Down
1 change: 1 addition & 0 deletions test/e2e/data/infrastructure-docker/main/clusterclass-quick-start-runtimesdk-v1beta1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ spec:
kubeadmConfigSpec:
clusterConfiguration:
apiServer:
timeoutForControlPlane: 20m
Copy link
Member Author

@sbueringer sbueringer Aug 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Some easy e2e test coverage. This would fail without the fix, because the KubeadmConfigs that KCP generates only have InitConfiguration or JoinConfiguration defined, but not both

# host.docker.internal is required by kubetest when running on MacOS because of the way ports are proxied.
certSANs: [localhost, 127.0.0.1, 0.0.0.0, host.docker.internal]
initConfiguration:
Expand Down