Add omitempty/omitzero to required fields

Author: sbueringer

.golangci-kal.yml

@@ -95,6 +95,10 @@ linters:
       text: "field Conditions type Conditions must have a maximum items, add kubebuilder:validation:MaxItems marker"
       linters:
         - kubeapilinter
+    - path: "api/core/v1beta2/condition_types.go"
+      text: "requiredfields: field (Type|Status|LastTransitionTime) should have the omitempty tag"
+      linters:
+        - kubeapilinter
 
     ## Excludes for current clusterctl v1alpha3 and Runtime Hooks v1alpha1 apiVersions (can be fixed once we bump their apiVersion).
     # Note: The types in api/runtime/hooks/v1alpha1 are not CRDs, so e.g. SSA markers don't make sense there.

api/addons/v1beta2/clusterresourceset_types.go

@@ -58,14 +58,14 @@ type ClusterResourceSetSpec struct {
 	// It must match the Cluster labels. This field is immutable.
 	// Label selector cannot be empty.
 	// +required
-	ClusterSelector metav1.LabelSelector `json:"clusterSelector"`
+	ClusterSelector metav1.LabelSelector `json:"clusterSelector,omitempty,omitzero"`
 
 	// resources is a list of Secrets/ConfigMaps where each contains 1 or more resources to be applied to remote clusters.
 	// +required
 	// +listType=atomic
 	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:MaxItems=100
-	Resources []ResourceRef `json:"resources"`
+	Resources []ResourceRef `json:"resources,omitempty"`
 
 	// strategy is the strategy to be used during applying resources. Defaults to ApplyOnce. This field is immutable.
 	// +kubebuilder:validation:Enum=ApplyOnce;Reconcile

api/bootstrap/kubeadm/v1beta2/kubeadm_types.go

@@ -560,7 +560,7 @@ type ExternalEtcd struct {
 	// +kubebuilder:validation:MaxItems=50
 	// +kubebuilder:validation:items:MinLength=1
 	// +kubebuilder:validation:items:MaxLength=512
-	Endpoints []string `json:"endpoints"`
+	Endpoints []string `json:"endpoints,omitempty"`
 
 	// caFile is an SSL Certificate Authority file used to secure etcd communication.
 	// Required if using a TLS connection.

api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go

@@ -569,7 +569,7 @@ type KubeadmControlPlaneRolloutStrategy struct {
 	// "RollingUpdate".
 	// Default is RollingUpdate.
 	// +required
-	Type KubeadmControlPlaneRolloutStrategyType `json:"type"`
+	Type KubeadmControlPlaneRolloutStrategyType `json:"type,omitempty"`
 
 	// rollingUpdate is the rolling update config params. Present only if
 	// type = RollingUpdate.
@@ -809,7 +809,7 @@ type LastRemediationStatus struct {
 
 	// time is when last remediation happened. It is represented in RFC3339 form and is in UTC.
 	// +required
-	Time metav1.Time `json:"time"`
+	Time metav1.Time `json:"time,omitempty,omitzero"`
 
 	// retryCount used to keep track of remediation retry for the last remediated machine.
 	// A retry happens when a machine that was created as a replacement for an unhealthy machine also fails.

api/core/v1beta2/cluster_types.go

@@ -1081,7 +1081,7 @@ type MachineDeploymentTopologyRolloutStrategy struct {
 	// type of rollout. Allowed values are RollingUpdate and OnDelete.
 	// Default is RollingUpdate.
 	// +required
-	Type MachineDeploymentRolloutStrategyType `json:"type"`
+	Type MachineDeploymentRolloutStrategyType `json:"type,omitempty"`
 
 	// rollingUpdate is the rolling update config params. Present only if
 	// type = RollingUpdate.
@@ -1225,7 +1225,7 @@ type ClusterVariable struct {
 	// i.e. it is not possible to have no type field.
 	// Ref: https://github.com/kubernetes-sigs/controller-tools/blob/d0e03a142d0ecdd5491593e941ee1d6b5d91dba6/pkg/crd/known_types.go#L106-L111
 	// +required
-	Value apiextensionsv1.JSON `json:"value"`
+	Value apiextensionsv1.JSON `json:"value,omitempty,omitzero"`
 }
 
 // ControlPlaneVariables can be used to provide variables for the ControlPlane.
@@ -1299,7 +1299,7 @@ type NetworkRanges struct {
 	// +kubebuilder:validation:MaxItems=100
 	// +kubebuilder:validation:items:MinLength=1
 	// +kubebuilder:validation:items:MaxLength=43
-	CIDRBlocks []string `json:"cidrBlocks"`
+	CIDRBlocks []string `json:"cidrBlocks,omitempty"`
 }
 
 func (n NetworkRanges) String() string {

api/core/v1beta2/clusterclass_types.go

@@ -652,7 +652,7 @@ type MachineDeploymentClassRolloutStrategy struct {
 	// type of rollout. Allowed values are RollingUpdate and OnDelete.
 	// Default is RollingUpdate.
 	// +required
-	Type MachineDeploymentRolloutStrategyType `json:"type"`
+	Type MachineDeploymentRolloutStrategyType `json:"type,omitempty"`
 
 	// rollingUpdate is the rolling update config params. Present only if
 	// type = RollingUpdate.
@@ -1280,12 +1280,13 @@ type PatchSelector struct {
 
 	// matchResources selects templates based on where they are referenced.
 	// +required
-	MatchResources PatchSelectorMatch `json:"matchResources"`
+	MatchResources PatchSelectorMatch `json:"matchResources,omitempty,omitzero"`
 }
 
 // PatchSelectorMatch selects templates based on where they are referenced.
 // Note: The selector must match at least one template.
 // Note: The results of selection based on the individual fields are ORed.
+// +kubebuilder:validation:MinProperties=1
 type PatchSelectorMatch struct {
 	// controlPlane selects templates referenced in .spec.ControlPlane.
 	// Note: this will match the controlPlane and also the controlPlane
@@ -1563,8 +1564,9 @@ type ClusterClassStatusVariable struct {
 	// definitions is a list of definitions for a variable.
 	// +required
 	// +listType=atomic
+	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:MaxItems=100
-	Definitions []ClusterClassStatusVariableDefinition `json:"definitions"`
+	Definitions []ClusterClassStatusVariableDefinition `json:"definitions,omitempty"`
 }
 
 // ClusterClassStatusVariableDefinition defines a variable which appears in the status of a ClusterClass.

api/core/v1beta2/common_types.go

@@ -292,7 +292,7 @@ const (
 type MachineAddress struct {
 	// type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.
 	// +required
-	Type MachineAddressType `json:"type"`
+	Type MachineAddressType `json:"type,omitempty"`
 
 	// address is the machine address.
 	// +required

api/core/v1beta2/machinedeployment_types.go

@@ -270,7 +270,7 @@ type MachineDeploymentSpec struct {
 	// selected by this will be the ones affected by this deployment.
 	// It must match the machine template's labels.
 	// +required
-	Selector metav1.LabelSelector `json:"selector"`
+	Selector metav1.LabelSelector `json:"selector,omitempty,omitzero"`
 
 	// template describes the machines that will be created.
 	// +required
@@ -318,7 +318,7 @@ type MachineDeploymentRolloutStrategy struct {
 	// type of rollout. Allowed values are RollingUpdate and OnDelete.
 	// Default is RollingUpdate.
 	// +required
-	Type MachineDeploymentRolloutStrategyType `json:"type"`
+	Type MachineDeploymentRolloutStrategyType `json:"type,omitempty"`
 
 	// rollingUpdate is the rolling update config params. Present only if
 	// type = RollingUpdate.

api/core/v1beta2/machinedrainrules_types.go

@@ -129,7 +129,7 @@ type MachineDrainRuleDrainConfig struct {
 	// "WaitCompleted" means that the pods to which this MachineDrainRule applies will never be evicted
 	// and we wait for them to be completed, it is enforced that pods marked with this behavior always have Order=0.
 	// +required
-	Behavior MachineDrainRuleDrainBehavior `json:"behavior"`
+	Behavior MachineDrainRuleDrainBehavior `json:"behavior,omitempty"`
 
 	// order defines the order in which Pods are drained.
 	// Pods with higher order are drained after Pods with lower order.

api/core/v1beta2/machinehealthcheck_types.go

@@ -56,7 +56,7 @@ type MachineHealthCheckSpec struct {
 
 	// selector is a label selector to match machines whose health will be exercised
 	// +required
-	Selector metav1.LabelSelector `json:"selector"`
+	Selector metav1.LabelSelector `json:"selector,omitempty,omitzero"`
 
 	// checks are the checks that are used to evaluate if a Machine is healthy.
 	//
@@ -217,13 +217,13 @@ type UnhealthyNodeCondition struct {
 	// +kubebuilder:validation:Type=string
 	// +kubebuilder:validation:MinLength=1
 	// +required
-	Type corev1.NodeConditionType `json:"type"`
+	Type corev1.NodeConditionType `json:"type,omitempty"`
 
 	// status of the condition, one of True, False, Unknown.
 	// +kubebuilder:validation:Type=string
 	// +kubebuilder:validation:MinLength=1
 	// +required
-	Status corev1.ConditionStatus `json:"status"`
+	Status corev1.ConditionStatus `json:"status,omitempty"`
 
 	// timeoutSeconds is the duration that a node must be in a given status for,
 	// after which the node is considered unhealthy.