experiment

Author: sbueringer

.golangci-kal.yml

@@ -43,17 +43,17 @@ linters:
               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.
               useProtobuf: Forbid # We don't use protobuf, so protobuf tags are not required.
-          # jsonTags:
-          #   jsonTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$" # The default regex is appropriate for our use case.
-          # optionalOrRequired:
-          #   preferredOptionalMarker: optional | kubebuilder:validation:Optional # The preferred optional marker to use, fixes will suggest to use this marker. Defaults to `optional`.
-          #   preferredRequiredMarker: required | kubebuilder:validation:Required # The preferred required marker to use, fixes will suggest to use this marker. Defaults to `required`.
             optionalFields:
               pointers:
-                preference: Always # Always | WhenRequired # Whether to always require pointers, or only when required. Defaults to `Always`.
+                preference: WhenRequired # Always | WhenRequired # Whether to always require pointers, or only when required. Defaults to `Always`.
                 policy: SuggestFix # SuggestFix | Warn # The policy for pointers in optional fields. Defaults to `SuggestFix`.
               omitempty:
                 policy: SuggestFix # SuggestFix | Warn | Ignore # The policy for omitempty in optional fields. Defaults to `SuggestFix`.
+          # jsonTags:
+          #   jsonTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$" # The default regex is appropriate for our use case.
+          # optionalOrRequired:
+          #   preferredOptionalMarker: optional | kubebuilder:validation:Optional # The preferred optional marker to use, fixes will suggest to use this marker. Defaults to `optional`.
+          #   preferredRequiredMarker: required | kubebuilder:validation:Required # The preferred required marker to use, fixes will suggest to use this marker. Defaults to `required`.
           # requiredFields:
           #   pointerPolicy: Warn | SuggestFix # Defaults to `SuggestFix`. We want our required fields to not be pointers.
 
@@ -78,7 +78,7 @@ linters:
       text: "Conditions field must be a slice of metav1.Condition"
       linters:
         - kubeapilinter
-    - path: "api/addons/v1beta1/*|api/bootstrap/kubeadm/v1beta1/*|api/controlplane/kubeadm/v1beta1/*|api/core/v1beta1/*|api/ipam/v1beta1/*|api/ipam/v1alpha1/*|api/runtime/v1alpha1/*"
+    - path: "api/addons/v1beta1/*|api/bootstrap/kubeadm/v1beta1/*|api/controlplane/kubeadm/v1beta1/*|api/core/v1beta1/*|api/ipam/v1beta1/*|api/ipam/v1alpha1/*|api/runtime/v1alpha1/*|cmd/clusterctl/api/v1alpha3/*"
       text: "optionalfields"
       linters:
         - kubeapilinter
@@ -155,6 +155,17 @@ linters:
       text: "field Ref is marked as required, should not be a pointer"
       linters:
         - kubeapilinter
+
+    ## TODO: optional required tasks.
+    - path: ".*"
+      text: "field Spec|Status is optional"
+      linters:
+        - kubeapilinter
+    # Audit the entire hook types + builtins from a serialization point of view (this is not a CRD)
+    - path: "api/runtime/hooks/v1alpha1/*"
+      text: "optionalfields"
+      linters:
+        - kubeapilinter
 issues:
   max-same-issues: 0
   max-issues-per-linter: 0

api/addons/v1beta2/clusterresourceset_types.go

@@ -129,6 +129,7 @@ type ClusterResourceSetStatus struct {
 
 	// observedGeneration reflects the generation of the most recently observed ClusterResourceSet.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.

api/bootstrap/kubeadm/v1beta2/kubeadm_types.go

@@ -85,6 +85,7 @@ type InitConfiguration struct {
 	// When used in the context of control plane nodes, NodeRegistration should remain consistent
 	// across both InitConfiguration and JoinConfiguration
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"`
 
 	// localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node
@@ -94,6 +95,7 @@ type InitConfiguration struct {
 	// on. By default, kubeadm tries to auto-detect the IP of the default interface and use that, but in case that process
 	// fails you may set the desired value here.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty"`
 
 	// skipPhases is a list of phases to skip during command execution.
@@ -120,22 +122,27 @@ type ClusterConfiguration struct {
 	// etcd holds configuration for etcd.
 	// NB: This value defaults to a Local (stacked) etcd
 	// +optional
-	Etcd Etcd `json:"etcd,omitempty"`
+	// +kubebuilder:validation:MinProperties=1
+	Etcd Etcd `json:"etcd,omitempty"` // FIXME: consider omitzero
 
 	// apiServer contains extra settings for the API server control plane component
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	APIServer APIServer `json:"apiServer,omitempty"`
 
 	// controllerManager contains extra settings for the controller manager control plane component
 	// +optional
-	ControllerManager ControlPlaneComponent `json:"controllerManager,omitempty"`
+	// +kubebuilder:validation:MinProperties=1
+	ControllerManager ControlPlaneComponent `json:"controllerManager,omitempty"` // FIXME: replace with ControllerManager struct
 
 	// scheduler contains extra settings for the scheduler control plane component
 	// +optional
-	Scheduler ControlPlaneComponent `json:"scheduler,omitempty"`
+	// +kubebuilder:validation:MinProperties=1
+	Scheduler ControlPlaneComponent `json:"scheduler,omitempty"` // FIXME: replace with Scheduler struct
 
 	// dns defines the options for the DNS add-on installed in the cluster.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	DNS DNS `json:"dns,omitempty"`
 
 	// certificatesDir specifies where to store or look for all required certificates.
@@ -396,7 +403,6 @@ type BootstrapToken struct {
 
 // Etcd contains elements describing Etcd configuration.
 type Etcd struct {
-
 	// local provides configuration knobs for configuring the local etcd instance
 	// Local and External are mutually exclusive
 	// +optional
@@ -492,6 +498,7 @@ type JoinConfiguration struct {
 	// When used in the context of control plane nodes, NodeRegistration should remain consistent
 	// across both InitConfiguration and JoinConfiguration
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty"`
 
 	// caCertPath is the path to the SSL certificate authority used to
@@ -506,6 +513,8 @@ type JoinConfiguration struct {
 	// discovery specifies the options for the kubelet to use during the TLS Bootstrap process
 	// +optional
 	// TODO: revisit when there is defaulting from k/k
+	// +kubebuilder:validation:MinProperties=1
+	// FIXME: double check that one of BootstrapToken or File must be set
 	Discovery Discovery `json:"discovery,omitempty"`
 
 	// controlPlane defines the additional control plane instance to be deployed on the joining node.
@@ -536,6 +545,7 @@ type JoinConfiguration struct {
 type JoinControlPlane struct {
 	// localAPIEndpoint represents the endpoint of the API server instance to be deployed on this node.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty"`
 }
 

api/bootstrap/kubeadm/v1beta2/kubeadmconfig_types.go

@@ -472,6 +472,7 @@ type KubeadmConfigStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.

api/controlplane/kubeadm/v1beta2/kubeadm_control_plane_types.go

@@ -676,6 +676,7 @@ type KubeadmControlPlaneStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// lastRemediation stores info about last remediation performed.

api/core/v1beta2/cluster_types.go

@@ -549,6 +549,11 @@ type Topology struct {
 
 	// controlPlane describes the cluster control plane.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
+	// FIXME: double check if ratcheting ensures this won't break pre-existing objects
+	// * P0: storage migration + conversion probably removes empty {}, if we fix marshalling on our v1beta2 structs (e.g. omitzero)
+	// * CRD ratcheting was enabled per default with v1.30, GA with v1.33 => Cluster API min mgmt is v1.30
+	// * which use cases are actually breaking (does it also break updates that only try to modify other fields)
 	ControlPlane ControlPlaneTopology `json:"controlPlane,omitempty"`
 
 	// workers encapsulates the different constructs that form the worker nodes
@@ -597,6 +602,7 @@ type ControlPlaneTopology struct {
 	// is applied only to the ControlPlane.
 	// At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// replicas is the number of control plane nodes.
@@ -675,6 +681,7 @@ type MachineDeploymentTopology struct {
 	// metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment.
 	// At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// class is the name of the MachineDeploymentClass used to create the set of worker nodes.
@@ -789,6 +796,7 @@ type MachinePoolTopology struct {
 	// metadata is the metadata applied to the MachinePool.
 	// At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// class is the name of the MachinePoolClass used to create the pool of worker nodes.
@@ -997,6 +1005,7 @@ type ClusterStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.

api/core/v1beta2/clusterclass_types.go

@@ -103,17 +103,20 @@ type ClusterClassSpec struct {
 	// infrastructure is a reference to a local struct that holds the details
 	// for provisioning the infrastructure cluster for the Cluster.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Infrastructure InfrastructureClass `json:"infrastructure,omitempty"`
 
 	// controlPlane is a reference to a local struct that holds the details
 	// for provisioning the Control Plane for the Cluster.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	ControlPlane ControlPlaneClass `json:"controlPlane,omitempty"`
 
 	// workers describes the worker nodes for the cluster.
 	// It is a collection of node types which can be used to create
 	// the worker nodes of the cluster.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Workers WorkersClass `json:"workers,omitempty"`
 
 	// variables defines the variables which can be configured
@@ -150,6 +153,7 @@ type ControlPlaneClass struct {
 	// This field is supported if and only if the control plane provider template
 	// referenced is Machine based.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// LocalObjectTemplate contains the reference to a provider-specific control plane template.
@@ -353,6 +357,7 @@ type MachineDeploymentClassTemplate struct {
 	// metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment.
 	// At runtime this metadata is merged with the corresponding metadata from the topology.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// bootstrap contains the bootstrap template reference to be used
@@ -503,6 +508,7 @@ type MachinePoolClassTemplate struct {
 	// metadata is the metadata applied to the MachinePool.
 	// At runtime this metadata is merged with the corresponding metadata from the topology.
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	Metadata ObjectMeta `json:"metadata,omitempty"`
 
 	// bootstrap contains the bootstrap template reference to be used
@@ -560,6 +566,7 @@ type ClusterClassVariable struct {
 	// Deprecated: This field is deprecated and will be removed when support for v1beta1 will be dropped. Please use XMetadata in JSONSchemaProps instead.
 	//
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	DeprecatedV1Beta1Metadata ClusterClassVariableMetadata `json:"deprecatedV1Beta1Metadata,omitempty"`
 
 	// schema defines the schema of the variable.
@@ -1218,6 +1225,7 @@ type ClusterClassStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.
@@ -1286,6 +1294,7 @@ type ClusterClassStatusVariableDefinition struct {
 	// Deprecated: This field is deprecated and will be removed when support for v1beta1 will be dropped. Please use XMetadata in JSONSchemaProps instead.
 	//
 	// +optional
+	// +kubebuilder:validation:MinProperties=1
 	DeprecatedV1Beta1Metadata ClusterClassVariableMetadata `json:"deprecatedV1Beta1Metadata,omitempty"`
 
 	// schema defines the schema of the variable.

api/core/v1beta2/machine_types.go

@@ -544,6 +544,7 @@ type MachineStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deletion contains information relating to removal of the Machine.

api/core/v1beta2/machinedeployment_types.go

@@ -431,6 +431,7 @@ type MachineDeploymentStatus struct {
 
 	// observedGeneration is the generation observed by the deployment controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// selector is the same as the label selector but in the string format to avoid introspection

api/core/v1beta2/machinehealthcheck_types.go

@@ -225,6 +225,7 @@ type MachineHealthCheckStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// targets shows the current list of machines the machine health check is watching

api/core/v1beta2/machinepool_types.go

@@ -147,6 +147,7 @@ type MachinePoolStatus struct {
 
 	// observedGeneration is the latest generation observed by the controller.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.

api/core/v1beta2/machineset_types.go

@@ -81,8 +81,8 @@ type MachineSetSpec struct {
 	// template is the object that describes the machine that will be created if
 	// insufficient replicas are detected.
 	// Object references to custom resources are treated as templates.
-	// +optional
-	Template MachineTemplateSpec `json:"template,omitempty"`
+	// +required
+	Template MachineTemplateSpec `json:"template"`
 
 	// machineNamingStrategy allows changing the naming pattern used when creating Machines.
 	// Note: InfraMachines & BootstrapConfigs will use the same name as the corresponding Machines.
@@ -312,6 +312,7 @@ type MachineSetStatus struct {
 
 	// observedGeneration reflects the generation of the most recently observed MachineSet.
 	// +optional
+	// +kubebuilder:validation:Minimum=1
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// deprecated groups all the status fields that are deprecated and will be removed when all the nested field are removed.