enable the requiredfields linter and make spec fields required

Author: eljohnson92

.golangci-kal.yml

@@ -22,7 +22,6 @@ linters:
               - "integers"
               # jsontags linter will force the json fields to go from _ usage to camelCase, we will wait for v1beta1 to enable this
               - "jsontags"
-              - "requiredfields"
               - "optionalfields"
           lintersConfig: { }
   exclusions:

api/v1alpha2/addressset_types.go

@@ -21,6 +21,7 @@ import (
 )
 
 // AddressSetSpec defines the desired state of AddressSet
+// +kubebuilder:validation:MinProperties=1
 type AddressSetSpec struct {
 	// ipv4 defines a list of IPv4 address strings
 	// +optional
@@ -46,8 +47,8 @@ type AddressSet struct {
 	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 	// spec is the desired state of the AddressSet
-	// +optional
-	Spec AddressSetSpec `json:"spec,omitempty"`
+	// +required
+	Spec AddressSetSpec `json:"spec,omitzero,omitempty"`
 	// status is the observed state of the AddressSet
 	// +optional
 	Status AddressSetStatus `json:"status,omitempty"`

api/v1alpha2/firewallrule_types.go

@@ -25,12 +25,14 @@ import (
 // FirewallRuleSpec defines the desired state of FirewallRule.
 type FirewallRuleSpec struct {
 	// action is the action to take when the rule matches.
+	// +kubebuilder:validation:Enum=ACCEPT;DROP
 	// +required
-	Action string `json:"action"`
+	Action string `json:"action,omitempty"`
 
 	// label is the label of the rule.
+	// +kubebuilder:validation:MinLength=3
 	// +required
-	Label string `json:"label"`
+	Label string `json:"label,omitempty"`
 
 	// description is the description of the rule.
 	// +optional
@@ -43,7 +45,7 @@ type FirewallRuleSpec struct {
 	// protocol is the protocol to apply the rule to.
 	// +kubebuilder:validation:Enum=TCP;UDP;ICMP;IPENCAP
 	// +required
-	Protocol linodego.NetworkProtocol `json:"protocol"`
+	Protocol linodego.NetworkProtocol `json:"protocol,omitempty"`
 
 	// addresses is a list of addresses to apply the rule to.
 	// +optional
@@ -89,8 +91,8 @@ type FirewallRule struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of the FirewallRule.
-	// +optional
-	Spec FirewallRuleSpec `json:"spec,omitempty"`
+	// +required
+	Spec FirewallRuleSpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the FirewallRule.
 	// +optional

api/v1alpha2/linodecluster_types.go

@@ -32,8 +32,9 @@ const (
 // LinodeClusterSpec defines the desired state of LinodeCluster
 type LinodeClusterSpec struct {
 	// region the LinodeCluster lives in.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Region string `json:"region"`
+	Region string `json:"region,omitempty"`
 
 	// controlPlaneEndpoint represents the endpoint used to communicate with the LinodeCluster control plane
 	// If ControlPlaneEndpoint is unset then the Nodebalancer ip will be used.
@@ -114,8 +115,8 @@ type LinodeCluster struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of the LinodeCluster.
-	// +optional
-	Spec LinodeClusterSpec `json:"spec,omitempty"`
+	// +required
+	Spec LinodeClusterSpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the LinodeCluster.
 	// +optional
@@ -247,7 +248,7 @@ type LinodeNBPortConfig struct {
 	// +kubebuilder:validation:Minimum=1
 	// +kubebuilder:validation:Maximum=65535
 	// +required
-	Port int `json:"port"`
+	Port int `json:"port,omitempty"`
 
 	// nodeBalancerConfigID is the config ID of port's NodeBalancer config.
 	// +optional

api/v1alpha2/linodeclustertemplate_types.go

@@ -24,14 +24,14 @@ import (
 type LinodeClusterTemplateSpec struct {
 	// template defines the specification for a LinodeCluster.
 	// +required
-	Template LinodeClusterTemplateResource `json:"template"`
+	Template LinodeClusterTemplateResource `json:"template,omitzero"`
 }
 
 // LinodeClusterTemplateResource describes the data needed to create a LinodeCluster from a template.
 type LinodeClusterTemplateResource struct {
 	// spec is the specification of the LinodeCluster.
 	// +required
-	Spec LinodeClusterSpec `json:"spec"`
+	Spec LinodeClusterSpec `json:"spec,omitzero,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -47,7 +47,7 @@ type LinodeClusterTemplate struct {
 
 	// spec is the desired state of the LinodeClusterTemplate.
 	// +optional
-	Spec LinodeClusterTemplateSpec `json:"spec,omitempty"`
+	Spec LinodeClusterTemplateSpec `json:"spec,omitzero,omitempty"`
 }
 
 // +kubebuilder:object:root=true

api/v1alpha2/linodefirewall_types.go

@@ -28,6 +28,7 @@ const (
 )
 
 // LinodeFirewallSpec defines the desired state of LinodeFirewall
+// +kubebuilder:validation:MinProperties=1
 type LinodeFirewallSpec struct {
 	// firewallID is the ID of the Firewall.
 	// +optional
@@ -147,8 +148,8 @@ type LinodeFirewall struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of the LinodeFirewall.
-	// +optional
-	Spec LinodeFirewallSpec `json:"spec,omitempty"`
+	// +required
+	Spec LinodeFirewallSpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the LinodeFirewall.
 	// +optional

api/v1alpha2/linodemachine_types.go

@@ -42,14 +42,16 @@ type LinodeMachineSpec struct {
 	InstanceID *int `json:"instanceID,omitempty"`
 
 	// region is the Linode region to create the instance in.
+	// +kubebuilder:validation:MinLength=1
 	// +required
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
-	Region string `json:"region"`
+	Region string `json:"region,omitempty"`
 
 	// type is the Linode instance type to create.
+	// +kubebuilder:validation:MinLength=1
 	// +required
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
-	Type string `json:"type"`
+	Type string `json:"type,omitempty"`
 
 	// group is the Linode group to create the instance in.
 	// +optional
@@ -364,8 +366,9 @@ type PublicInterfaceIPv4CreateOptions struct {
 // PublicInterfaceIPv4AddressCreateOptions defines the public IPv4 address and whether it is primary
 type PublicInterfaceIPv4AddressCreateOptions struct {
 	// address is the IPv4 address for the public interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Address string `json:"address"`
+	Address string `json:"address,omitempty"`
 
 	// primary is a boolean indicating whether the address is primary.
 	// +optional
@@ -384,15 +387,17 @@ type PublicInterfaceIPv6CreateOptions struct {
 // PublicInterfaceIPv6RangeCreateOptions defines the IPv6 range for a public interface
 type PublicInterfaceIPv6RangeCreateOptions struct {
 	// range is the IPv6 range for the public interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Range string `json:"range"`
+	Range string `json:"range,omitempty"`
 }
 
 // VPCInterfaceCreateOptions defines the VPC interface configuration for an instance
 type VPCInterfaceCreateOptions struct {
 	// subnet_id is the ID of the subnet to use for the interface.
+	// +kubebuilder:validation:Minimum=1
 	// +required
-	SubnetID int `json:"subnet_id"`
+	SubnetID int `json:"subnet_id,omitempty"`
 
 	// ipv4 is the IPv4 configuration for the interface.
 	// +optional
@@ -419,21 +424,23 @@ type VPCInterfaceIPv6CreateOptions struct {
 
 	// is_public is a boolean indicating whether the interface is public.
 	// +required
-	IsPublic bool `json:"is_public"`
+	IsPublic *bool `json:"is_public,omitempty"`
 }
 
 // VPCInterfaceIPv6SLAACCreateOptions defines the Range for IPv6 SLAAC
 type VPCInterfaceIPv6SLAACCreateOptions struct {
 	// range is the IPv6 range for the interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Range string `json:"range"`
+	Range string `json:"range,omitempty"`
 }
 
 // VPCInterfaceIPv6RangeCreateOptions defines the IPv6 range for a VPC interface
 type VPCInterfaceIPv6RangeCreateOptions struct {
 	// range is the IPv6 range for the interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Range string `json:"range"`
+	Range string `json:"range,omitempty"`
 }
 
 // VPCInterfaceIPv4CreateOptions defines the IPv4 address and range configuration for a VPC interface
@@ -454,8 +461,9 @@ type VPCInterfaceIPv4CreateOptions struct {
 // VPCInterfaceIPv4AddressCreateOptions defines the IPv4 configuration for a VPC interface
 type VPCInterfaceIPv4AddressCreateOptions struct {
 	// address is the IPv4 address for the interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Address string `json:"address"`
+	Address string `json:"address,omitempty"`
 
 	// primary is a boolean indicating whether the address is primary.
 	// +optional
@@ -469,15 +477,17 @@ type VPCInterfaceIPv4AddressCreateOptions struct {
 // VPCInterfaceIPv4RangeCreateOptions defines the IPv4 range for a VPC interface
 type VPCInterfaceIPv4RangeCreateOptions struct {
 	// range is the IPv4 range for the interface.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Range string `json:"range"`
+	Range string `json:"range,omitempty"`
 }
 
 // VLANInterface defines the VLAN interface configuration for an instance
 type VLANInterface struct {
 	// vlan_label is the label of the VLAN.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	VLANLabel string `json:"vlan_label"`
+	VLANLabel string `json:"vlan_label,omitempty"`
 
 	// ipam_address is the IP address to assign to the interface.
 	// +optional
@@ -589,8 +599,8 @@ type LinodeMachine struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec defines the specification of desired behavior for the LinodeMachine.
-	// +optional
-	Spec LinodeMachineSpec `json:"spec,omitempty"`
+	// +required
+	Spec LinodeMachineSpec `json:"spec,omitzero,omitempty"`
 
 	// status defines the observed state of LinodeMachine.
 	// +optional

api/v1alpha2/linodemachinetemplate_types.go

@@ -24,7 +24,7 @@ import (
 type LinodeMachineTemplateSpec struct {
 	// template defines the specification for a LinodeMachine.
 	// +required
-	Template LinodeMachineTemplateResource `json:"template"`
+	Template LinodeMachineTemplateResource `json:"template,omitempty,omitzero"`
 }
 
 // LinodeMachineTemplateStatus defines the observed state of LinodeMachineTemplate
@@ -52,7 +52,7 @@ type LinodeMachineTemplateStatus struct {
 type LinodeMachineTemplateResource struct {
 	// spec is the specification of the desired behavior of the machine.
 	// +required
-	Spec LinodeMachineSpec `json:"spec"`
+	Spec LinodeMachineSpec `json:"spec,omitempty,omitzero"`
 }
 
 // +kubebuilder:object:root=true
@@ -70,7 +70,7 @@ type LinodeMachineTemplate struct {
 
 	// spec is the desired state of the LinodeMachineTemplate.
 	// +optional
-	Spec LinodeMachineTemplateSpec `json:"spec,omitempty"`
+	Spec LinodeMachineTemplateSpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the LinodeMachineTemplate.
 	// +optional

api/v1alpha2/linodeobjectstoragebucket_types.go

@@ -38,8 +38,9 @@ type LinodeObjectStorageBucketSpec struct {
 
 	// region is the ID of the Object Storage region for the bucket.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Region string `json:"region"`
+	Region string `json:"region,omitempty"`
 
 	// acl sets the Access Control Level of the bucket using a canned ACL string
 	// +optional
@@ -114,8 +115,8 @@ type LinodeObjectStorageBucket struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of the LinodeObjectStorageBucket.
-	// +optional
-	Spec LinodeObjectStorageBucketSpec `json:"spec,omitempty"`
+	// +required
+	Spec LinodeObjectStorageBucketSpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the LinodeObjectStorageBucket.
 	// +optional

api/v1alpha2/linodeobjectstoragekey_types.go

@@ -29,16 +29,20 @@ const (
 
 type BucketAccessRef struct {
 	// bucketName is the name of the bucket to grant access to.
+	// +kubebuilder:validation:MinLength=3
+	// +kubebuilder:validation:MaxLength=63
 	// +required
-	BucketName string `json:"bucketName"`
+	BucketName string `json:"bucketName,omitempty"`
 
 	// permissions is the permissions to grant to the bucket.
+	// +kubebuilder:validation:Enum=read_only;read_write
 	// +required
-	Permissions string `json:"permissions"`
+	Permissions string `json:"permissions,omitempty"`
 
 	// region is the region of the bucket.
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Region string `json:"region"`
+	Region string `json:"region,omitempty"`
 }
 
 type GeneratedSecret struct {
@@ -69,17 +73,17 @@ type LinodeObjectStorageKeySpec struct {
 	// +kubebuilder:validation:MinItems=1
 	// +required
 	// +listType=atomic
-	BucketAccess []BucketAccessRef `json:"bucketAccess"`
+	BucketAccess []BucketAccessRef `json:"bucketAccess,omitempty"`
 
 	// credentialsRef is a reference to a Secret that contains the credentials to use for generating access keys.
-	// If not supplied then the credentials of the controller will be used.
+	// If not supplied, then the credentials of the controller will be used.
 	// +optional
 	CredentialsRef *corev1.SecretReference `json:"credentialsRef,omitempty"`
 
 	// keyGeneration may be modified to trigger a rotation of the access key.
 	// +kubebuilder:default=0
-	// +required
-	KeyGeneration int `json:"keyGeneration"`
+	// +optional
+	KeyGeneration *int `json:"keyGeneration,omitempty"`
 
 	// generatedSecret configures the Secret to generate containing access key details.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
@@ -151,8 +155,8 @@ type LinodeObjectStorageKey struct {
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of the LinodeObjectStorageKey.
-	// +optional
-	Spec LinodeObjectStorageKeySpec `json:"spec,omitempty"`
+	// +required
+	Spec LinodeObjectStorageKeySpec `json:"spec,omitzero,omitempty"`
 
 	// status is the observed state of the LinodeObjectStorageKey.
 	// +optional