Skip to content

⚠️ Improve Cluster CRD Go type #12489

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
merged 2 commits into from
Jul 16, 2025
Merged

⚠️ Improve Cluster CRD Go type #12489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5004212
Improve Cluster type
sbueringer Jul 14, 2025
474a36b
Fix e2e tests
sbueringer Jul 15, 2025
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
12 changes: 8 additions & 4 deletions .golangci-kal.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ linters:
lintersConfig:
conditions:
isFirstField: Warn # Require conditions to be the first field in the status struct.
usePatchStrategy: Forbid # Require conditions to be the first field in the status struct.
usePatchStrategy: Forbid # Forbid patchStrategy markers on the Conditions field.
useProtobuf: Forbid # We don't use protobuf, so protobuf tags are not required.
optionalfields:
pointers:
Expand Down Expand Up @@ -171,11 +171,15 @@ linters:
linters:
- kubeapilinter
- path: "api/core/v1beta2/cluster_types.go"
text: "optionalfields: field (ControlPlaneEndpoint|ControlPlane|Metadata) is optional and should (be a pointer|have the omitempty tag)"
text: "optionalfields: field (ClusterNetwork|Services|Pods|ControlPlaneEndpoint|ControlPlane|Workers|Metadata|Variables|Strategy) is optional and should (be a pointer|have the omitempty tag)"
linters:
- kubeapilinter
- path: "api/core/v1beta2/clusterclass_types.go"
text: "optionalfields: field (Workers|Metadata|ControlPlane|Infrastructure|DeprecatedV1Beta1Metadata) is optional and should (be a pointer|have the omitempty tag)"
text: "optionalfields: field (Workers|Metadata|ControlPlane|Strategy|Infrastructure|DeprecatedV1Beta1Metadata) is optional and should (be a pointer|have the omitempty tag)"
linters:
- kubeapilinter
- path: "api/core/v1beta2/machinedeployment_types.go"
text: "optionalfields: field (Strategy|RollingUpdate|Remediation) is optional and should (be a pointer|have the omitempty tag)"
linters:
- kubeapilinter
- path: "api/ipam/v1beta2/ipaddressclaim_types.go"
Expand All @@ -184,7 +188,7 @@ linters:
- kubeapilinter
# KAL does not handle enum markers on enum types yet: https://github.com/kubernetes-sigs/kube-api-linter/issues/113
- path: ".*"
text: "optionalfields: field (Format|Encoding|Type|DeletePolicy|FailurePolicy) is optional and (should be a pointer|has a valid zero value)"
text: "optionalfields: field (Polarity|Format|Encoding|Type|DeletePolicy|FailurePolicy) is optional and (should be a pointer|has a valid zero value)"
linters:
- kubeapilinter

Expand Down
1 change: 1 addition & 0 deletions api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,7 @@ type KubeadmControlPlaneMachineTemplate struct {
// +optional
// +listType=map
// +listMapKey=conditionType
// +kubebuilder:validation:MinItems=1
// +kubebuilder:validation:MaxItems=32
ReadinessGates []clusterv1.MachineReadinessGate `json:"readinessGates,omitempty"`

Expand Down
260 changes: 245 additions & 15 deletions api/core/v1beta1/conversion.go
View file
Open in desktop

Large diffs are not rendered by default.

96 changes: 75 additions & 21 deletions api/core/v1beta1/conversion_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,15 @@ func spokeCluster(in *Cluster, c randfill.Continue) {

dropEmptyStringsCluster(in)

if in.Spec.Topology != nil && in.Spec.Topology.Workers != nil {
for _, md := range in.Spec.Topology.Workers.MachineDeployments {
if md.Strategy != nil && md.Strategy.RollingUpdate != nil &&
md.Strategy.RollingUpdate.DeletePolicy != nil && *md.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
md.Strategy.RollingUpdate.DeletePolicy = nil
}
if in.Spec.ClusterNetwork != nil {
if in.Spec.ClusterNetwork.Services != nil && reflect.DeepEqual(in.Spec.ClusterNetwork.Services, &NetworkRanges{}) {
in.Spec.ClusterNetwork.Services = nil
}
if in.Spec.ClusterNetwork.Pods != nil && reflect.DeepEqual(in.Spec.ClusterNetwork.Pods, &NetworkRanges{}) {
in.Spec.ClusterNetwork.Pods = nil
}
if reflect.DeepEqual(in.Spec.ClusterNetwork, &ClusterNetwork{}) {
in.Spec.ClusterNetwork = nil
}
}
}
Expand All @@ -211,6 +213,10 @@ func spokeClusterTopology(in *Topology, c randfill.Continue) {

// RolloutAfter was unused and has been removed in v1beta2.
in.RolloutAfter = nil

if in.Workers != nil && reflect.DeepEqual(in.Workers, &WorkersTopology{}) {
in.Workers = nil
}
}

func spokeClusterStatus(in *ClusterStatus, c randfill.Continue) {
Expand Down Expand Up @@ -326,14 +332,6 @@ func spokeClusterClass(in *ClusterClass, c randfill.Continue) {
in.Namespace = "foo"

dropEmptyStringsClusterClass(in)

for _, md := range in.Spec.Workers.MachineDeployments {
if md.Strategy != nil && md.Strategy.RollingUpdate != nil &&
md.Strategy.RollingUpdate.DeletePolicy != nil && *md.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
md.Strategy.RollingUpdate.DeletePolicy = nil
}
}
}

func spokeClusterClassStatus(in *ClusterClassStatus, c randfill.Continue) {
Expand Down Expand Up @@ -589,12 +587,6 @@ func spokeMachineDeployment(in *MachineDeployment, c randfill.Continue) {
fillMachineSpec(&in.Spec.Template.Spec, c, in.Namespace)

dropEmptyStringsMachineSpec(&in.Spec.Template.Spec)

if in.Spec.Strategy != nil && in.Spec.Strategy.RollingUpdate != nil &&
in.Spec.Strategy.RollingUpdate.DeletePolicy != nil && *in.Spec.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
in.Spec.Strategy.RollingUpdate.DeletePolicy = nil
}
}

func spokeMachineDeploymentSpec(in *MachineDeploymentSpec, c randfill.Continue) {
Expand All @@ -605,6 +597,24 @@ func spokeMachineDeploymentSpec(in *MachineDeploymentSpec, c randfill.Continue)

// Drop RevisionHistoryLimit as we intentionally don't preserve it.
in.RevisionHistoryLimit = nil

if in.Strategy != nil {
if in.Strategy.RollingUpdate != nil {
if in.Strategy.RollingUpdate.DeletePolicy != nil && *in.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
in.Strategy.RollingUpdate.DeletePolicy = nil
}
if reflect.DeepEqual(in.Strategy.RollingUpdate, &MachineRollingUpdateDeployment{}) {
in.Strategy.RollingUpdate = nil
}
}
if in.Strategy.Remediation != nil && reflect.DeepEqual(in.Strategy.Remediation, &RemediationStrategy{}) {
in.Strategy.Remediation = nil
}
if reflect.DeepEqual(in.Strategy, &MachineDeploymentStrategy{}) {
in.Strategy = nil
}
}
}

func spokeMachineDeploymentStatus(in *MachineDeploymentStatus, c randfill.Continue) {
Expand Down Expand Up @@ -726,6 +736,10 @@ func spokeControlPlaneTopology(in *ControlPlaneTopology, c randfill.Continue) {
if in.NodeDeletionTimeout != nil {
in.NodeDeletionTimeout = ptr.To[metav1.Duration](metav1.Duration{Duration: time.Duration(c.Int31()) * time.Second})
}

if in.Variables != nil && reflect.DeepEqual(in.Variables, &ControlPlaneVariables{}) {
in.Variables = nil
}
}

func spokeMachineDeploymentTopology(in *MachineDeploymentTopology, c randfill.Continue) {
Expand All @@ -740,6 +754,26 @@ func spokeMachineDeploymentTopology(in *MachineDeploymentTopology, c randfill.Co
if in.NodeDeletionTimeout != nil {
in.NodeDeletionTimeout = ptr.To[metav1.Duration](metav1.Duration{Duration: time.Duration(c.Int31()) * time.Second})
}
if in.Variables != nil && reflect.DeepEqual(in.Variables, &MachineDeploymentVariables{}) {
in.Variables = nil
}
if in.Strategy != nil {
if in.Strategy.RollingUpdate != nil {
if in.Strategy.RollingUpdate.DeletePolicy != nil && *in.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
in.Strategy.RollingUpdate.DeletePolicy = nil
}
if reflect.DeepEqual(in.Strategy.RollingUpdate, &MachineRollingUpdateDeployment{}) {
in.Strategy.RollingUpdate = nil
}
}
if in.Strategy.Remediation != nil && reflect.DeepEqual(in.Strategy.Remediation, &RemediationStrategy{}) {
in.Strategy.Remediation = nil
}
if reflect.DeepEqual(in.Strategy, &MachineDeploymentStrategy{}) {
in.Strategy = nil
}
}
}

func spokeMachinePoolTopology(in *MachinePoolTopology, c randfill.Continue) {
Expand All @@ -754,6 +788,9 @@ func spokeMachinePoolTopology(in *MachinePoolTopology, c randfill.Continue) {
if in.NodeDeletionTimeout != nil {
in.NodeDeletionTimeout = ptr.To[metav1.Duration](metav1.Duration{Duration: time.Duration(c.Int31()) * time.Second})
}
if in.Variables != nil && reflect.DeepEqual(in.Variables, &MachinePoolVariables{}) {
in.Variables = nil
}
}

func spokeMachineHealthCheckClass(in *MachineHealthCheckClass, c randfill.Continue) {
Expand Down Expand Up @@ -790,6 +827,23 @@ func spokeMachineDeploymentClass(in *MachineDeploymentClass, c randfill.Continue
if in.NodeDeletionTimeout != nil {
in.NodeDeletionTimeout = ptr.To[metav1.Duration](metav1.Duration{Duration: time.Duration(c.Int31()) * time.Second})
}
if in.Strategy != nil {
if in.Strategy.RollingUpdate != nil {
if in.Strategy.RollingUpdate.DeletePolicy != nil && *in.Strategy.RollingUpdate.DeletePolicy == "" {
// &"" Is not a valid value for DeletePolicy as the enum validation enforces an enum value if DeletePolicy is set.
in.Strategy.RollingUpdate.DeletePolicy = nil
}
if reflect.DeepEqual(in.Strategy.RollingUpdate, &MachineRollingUpdateDeployment{}) {
in.Strategy.RollingUpdate = nil
}
}
if in.Strategy.Remediation != nil && reflect.DeepEqual(in.Strategy.Remediation, &RemediationStrategy{}) {
in.Strategy.Remediation = nil
}
if reflect.DeepEqual(in.Strategy, &MachineDeploymentStrategy{}) {
in.Strategy = nil
}
}
}

func spokeMachinePoolClass(in *MachinePoolClass, c randfill.Continue) {
Expand Down
Loading