MinProperties, enum etc.

Author: sbueringer

.golangci-kal.yml

@@ -174,12 +174,35 @@ linters:
 
     # https://github.com/kubernetes-sigs/cluster-api/pull/12431
     # https://github.com/kubernetes-sigs/cluster-api/pull/12435
-    # Take a closer look
+    # FIXME: this excludes too much atm (also things not fixed in the PRs)
     - path: ".*"
       text: "field Spec|Status is optional"
       linters:
         - kubeapilinter
 
+    # MinProperties PR: FIXME
+    - path: "api/bootstrap/kubeadm/v1beta2/kubeadm_types.go"
+      text: "optionalfields: field (NodeRegistration|LocalAPIEndpoint|Etcd|APIServer|ControllerManager|Scheduler|DNS|Discovery) is optional and should (be a pointer|have the omitempty tag)"
+      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)"
+      linters:
+        - kubeapilinter
+    - path: "api/core/v1beta2/clusterclass_types.go"
+      text: "optionalfields: field (Workers|Metadata|DeprecatedV1Beta1Metadata) is optional and should (be a pointer|have the omitempty tag)"
+      linters:
+        - kubeapilinter
+    - path: "api/ipam/v1beta2/ipaddressclaim_types.go"
+      text: "optionalfields: field AddressRef is optional and should (be a pointer|have the omitempty tag)"
+      linters:
+        - kubeapilinter
+
+    # enum bug: https://github.com/kubernetes-sigs/kube-api-linter/issues/113
+    - path: ".*"
+      text: "optionalfields: field (Format|Encoding|Type) is optional and (should be a pointer|has a valid zero value)"
+      linters:
+        - kubeapilinter
 issues:
   max-same-issues: 0
   max-issues-per-linter: 0

api/bootstrap/kubeadm/v1beta1/conversion.go

@@ -375,6 +375,14 @@ func Convert_v1beta2_KubeadmConfigStatus_To_v1beta1_KubeadmConfigStatus(in *boot
 	return nil
 }
 
+func Convert_v1beta2_ControllerManager_To_v1beta1_ControlPlaneComponent(in *bootstrapv1.ControllerManager, out *ControlPlaneComponent, s apimachineryconversion.Scope) error {
+	return Convert_v1beta2_ControlPlaneComponent_To_v1beta1_ControlPlaneComponent(&in.ControlPlaneComponent, out, s)
+}
+
+func Convert_v1beta2_Scheduler_To_v1beta1_ControlPlaneComponent(in *bootstrapv1.Scheduler, out *ControlPlaneComponent, s apimachineryconversion.Scope) error {
+	return Convert_v1beta2_ControlPlaneComponent_To_v1beta1_ControlPlaneComponent(&in.ControlPlaneComponent, out, s)
+}
+
 func Convert_v1beta2_ControlPlaneComponent_To_v1beta1_ControlPlaneComponent(in *bootstrapv1.ControlPlaneComponent, out *ControlPlaneComponent, s apimachineryconversion.Scope) error {
 	// Following fields require a custom conversions.
 	out.ExtraArgs = bootstrapv1.ConvertFromArgs(in.ExtraArgs)
@@ -406,6 +414,14 @@ func Convert_v1beta1_APIServer_To_v1beta2_APIServer(in *APIServer, out *bootstra
 	return autoConvert_v1beta1_APIServer_To_v1beta2_APIServer(in, out, s)
 }
 
+func Convert_v1beta1_ControlPlaneComponent_To_v1beta2_ControllerManager(in *ControlPlaneComponent, out *bootstrapv1.ControllerManager, s apimachineryconversion.Scope) error {
+	return Convert_v1beta1_ControlPlaneComponent_To_v1beta2_ControlPlaneComponent(in, &out.ControlPlaneComponent, s)
+}
+
+func Convert_v1beta1_ControlPlaneComponent_To_v1beta2_Scheduler(in *ControlPlaneComponent, out *bootstrapv1.Scheduler, s apimachineryconversion.Scope) error {
+	return Convert_v1beta1_ControlPlaneComponent_To_v1beta2_ControlPlaneComponent(in, &out.ControlPlaneComponent, s)
+}
+
 func Convert_v1beta1_Discovery_To_v1beta2_Discovery(in *Discovery, out *bootstrapv1.Discovery, s apimachineryconversion.Scope) error {
 	// Timeout has been removed in v1beta2
 	return autoConvert_v1beta1_Discovery_To_v1beta2_Discovery(in, out, s)

api/bootstrap/kubeadm/v1beta1/zz_generated.conversion.go

@@ -85,8 +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,omitzero"` // nolint:kubeapilinter // nolint:kubeapilinter
+	NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty,omitzero"`
 
 	// localAPIEndpoint represents the endpoint of the API server instance that's deployed on this control plane node
 	// In HA setups, this differs from ClusterConfiguration.ControlPlaneEndpoint in the sense that ControlPlaneEndpoint
@@ -95,8 +94,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,omitzero"` // nolint:kubeapilinter
+	LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty,omitzero"`
 
 	// skipPhases is a list of phases to skip during command execution.
 	// The list of phases can be obtained with the "kubeadm init --help" command.
@@ -121,9 +119,9 @@ type InitConfiguration struct {
 type ClusterConfiguration struct {
 	// etcd holds configuration for etcd.
 	// NB: This value defaults to a Local (stacked) etcd
+	// FIXME: double check that unsetting etcd still works: https://github.com/kubernetes-sigs/cluster-api/pull/12065
 	// +optional
-	// +kubebuilder:validation:MinProperties=1
-	Etcd Etcd `json:"etcd,omitempty,omitzero"` // nolint:kubeapilinter // FIXME: double check that unsetting etcd still works: https://github.com/kubernetes-sigs/cluster-api/pull/12065
+	Etcd Etcd `json:"etcd,omitempty,omitzero"`
 
 	// controlPlaneEndpoint sets a stable IP address or DNS name for the control plane; it
 	// can be a valid IP address or a RFC-1123 DNS subdomain, both with optional TCP port.
@@ -144,23 +142,19 @@ type ClusterConfiguration struct {
 
 	// apiServer contains extra settings for the API server control plane component
 	// +optional
-	// +kubebuilder:validation:MinProperties=1
-	APIServer APIServer `json:"apiServer,omitempty,omitzero"` // nolint:kubeapilinter
+	APIServer APIServer `json:"apiServer,omitempty,omitzero"`
 
 	// controllerManager contains extra settings for the controller manager control plane component
 	// +optional
-	// +kubebuilder:validation:MinProperties=1
-	ControllerManager ControlPlaneComponent `json:"controllerManager,omitempty,omitzero"` // nolint:kubeapilinter // FIXME: replace with ControllerManager struct
+	ControllerManager ControllerManager `json:"controllerManager,omitempty,omitzero"`
 
 	// scheduler contains extra settings for the scheduler control plane component
 	// +optional
-	// +kubebuilder:validation:MinProperties=1
-	Scheduler ControlPlaneComponent `json:"scheduler,omitempty,omitzero"` // nolint:kubeapilinter // FIXME: replace with Scheduler struct
+	Scheduler Scheduler `json:"scheduler,omitempty,omitzero"`
 
 	// dns defines the options for the DNS add-on installed in the cluster.
 	// +optional
-	// +kubebuilder:validation:MinProperties=1
-	DNS DNS `json:"dns,omitempty,omitzero"` // nolint:kubeapilinter
+	DNS DNS `json:"dns,omitempty,omitzero"`
 
 	// certificatesDir specifies where to store or look for all required certificates.
 	// NB: if not provided, this will default to `/etc/kubernetes/pki`
@@ -191,6 +185,7 @@ type ClusterConfiguration struct {
 }
 
 // ControlPlaneComponent holds settings common to control plane component of the cluster.
+// +kubebuilder:validation:MinProperties=1
 type ControlPlaneComponent struct {
 	// extraArgs is a list of args to pass to the control plane component.
 	// The arg name must match the command line flag name except without leading dash(es).
@@ -229,7 +224,18 @@ type APIServer struct {
 	CertSANs []string `json:"certSANs,omitempty"`
 }
 
+// ControllerManager holds settings necessary for controller-manager deployments in the cluster.
+type ControllerManager struct {
+	ControlPlaneComponent `json:",inline"`
+}
+
+// Scheduler holds settings necessary for scheduler deployments in the cluster.
+type Scheduler struct {
+	ControlPlaneComponent `json:",inline"`
+}
+
 // DNS defines the DNS addon that should be used in the cluster.
+// +kubebuilder:validation:MinProperties=1
 type DNS struct {
 	// ImageMeta allows to customize the image used for the DNS component
 	ImageMeta `json:",inline"`
@@ -256,6 +262,7 @@ type ImageMeta struct {
 }
 
 // APIEndpoint struct contains elements of API server instance deployed on a node.
+// +kubebuilder:validation:MinProperties=1
 type APIEndpoint struct {
 	// advertiseAddress sets the IP address for the API server to advertise.
 	// +optional
@@ -271,9 +278,10 @@ type APIEndpoint struct {
 }
 
 // NodeRegistrationOptions holds fields that relate to registering a new control-plane or node to the cluster, either via "kubeadm init" or "kubeadm join".
+// FIXME: somehow cannot apply this marker to this struct? // +kubebuilder:validation:MinProperties=1
+// FIXME: maybe the marshal func? Check if we can just get rid of it => []Taints => *[]Taints
 // Note: The NodeRegistrationOptions struct has to be kept in sync with the structs in MarshalJSON.
 type NodeRegistrationOptions struct {
-
 	// name is the `.Metadata.Name` field of the Node API object that will be created in this `kubeadm init` or `kubeadm join` operation.
 	// This field is also used in the CommonName field of the kubelet's client certificate to the API server.
 	// Defaults to the hostname of the node if not provided.
@@ -421,7 +429,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
@@ -518,8 +525,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,omitzero"` // nolint:kubeapilinter
+	NodeRegistration NodeRegistrationOptions `json:"nodeRegistration,omitempty,omitzero"`
 
 	// caCertPath is the path to the SSL certificate authority used to
 	// secure communications between node and control-plane.
@@ -533,9 +539,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,omitzero"` // nolint:kubeapilinter
+	Discovery Discovery `json:"discovery,omitempty,omitzero"`
 
 	// controlPlane defines the additional control plane instance to be deployed on the joining node.
 	// If nil, no additional control plane instance will be deployed.
@@ -565,11 +570,11 @@ 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,omitzero"` // nolint:kubeapilinter
+	LocalAPIEndpoint APIEndpoint `json:"localAPIEndpoint,omitempty,omitzero"`
 }
 
 // Discovery specifies the options for the kubelet to use during the TLS Bootstrap process.
+// +kubebuilder:validation:MinProperties=1
 type Discovery struct {
 	// bootstrapToken is used to set the options for bootstrap token based discovery
 	// BootstrapToken and File are mutually exclusive

api/bootstrap/kubeadm/v1beta2/kubeadm_types.go

@@ -116,7 +116,7 @@ type KubeadmConfigSpec struct {
 
 	// format specifies the output format of the bootstrap data
 	// +optional
-	Format Format `json:"format,omitempty"` // nolint:kubeapilinter // FIXME: Talk to Joel: optionalfields linter should be improved to detect enum on the type
+	Format Format `json:"format,omitempty"`
 
 	// verbosity is the number for the kubeadm log level verbosity.
 	// It overrides the `--v` flag in kubeadm commands.
@@ -630,7 +630,7 @@ type File struct {
 
 	// encoding specifies the encoding of the file contents.
 	// +optional
-	Encoding Encoding `json:"encoding,omitempty"` // nolint:kubeapilinter // FIXME: Talk to Joel: optionalfields linter should be improved to detect enum on the type
+	Encoding Encoding `json:"encoding,omitempty"`
 
 	// append specifies whether to append Content to existing file if Path exists.
 	// +optional

api/bootstrap/kubeadm/v1beta2/kubeadmconfig_types.go

@@ -35,7 +35,7 @@ type KubeadmConfigTemplateResource struct {
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
-	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"`
+	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty,omitzero"`
 
 	// spec is the desired state of KubeadmConfig.
 	// +optional

api/bootstrap/kubeadm/v1beta2/kubeadmconfigtemplate_types.go

@@ -480,7 +480,7 @@ type KubeadmControlPlaneMachineTemplate struct {
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
-	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"`
+	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty,omitzero"`
 
 	// infrastructureRef is a required reference to a custom resource
 	// offered by an infrastructure provider.
@@ -538,7 +538,7 @@ type RolloutStrategy struct {
 	// "RollingUpdate".
 	// Default is RollingUpdate.
 	// +optional
-	Type RolloutStrategyType `json:"type,omitempty"` // nolint:kubeapilinter // FIXME: Talk to Joel: optionalfields linter should be improved to detect enum on the type
+	Type RolloutStrategyType `json:"type,omitempty"`
 
 	// rollingUpdate is the rolling update config params. Present only if
 	// RolloutStrategyType = RollingUpdate.

api/bootstrap/kubeadm/v1beta2/zz_generated.deepcopy.go

@@ -72,7 +72,7 @@ type KubeadmControlPlaneTemplateResource struct {
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
-	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"`
+	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty,omitzero"`
 
 	// spec is the desired state of KubeadmControlPlaneTemplateResource.
 	// +optional
@@ -134,7 +134,7 @@ type KubeadmControlPlaneTemplateMachineTemplate struct {
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 	// +optional
-	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty"`
+	ObjectMeta clusterv1.ObjectMeta `json:"metadata,omitempty,omitzero"`
 
 	// nodeDrainTimeoutSeconds is the total amount of time that the controller will spend on draining a controlplane node
 	// The default value is 0, meaning that the node can be drained without any time limitations.