Merge pull request #3221 from Nordix/lentzi90/kal-requiredfields

🌱 Enable requiredfields linter

Author: k8s-ci-robot

.golangci-kal.yml

@@ -31,7 +31,7 @@ linters:
             # - "optionalfields" # Ensure that all fields marked as optional adhere to being pointers and
             # having the omitempty value in their json tag where appropriate.
             - "optionalorrequired" # Every field should be marked as optional or required.
-            # - "requiredfields" # Required fields should not be pointers, and should not have omitempty.
+            - "requiredfields" # Required fields should have omitempty/omitzero, and should only be pointers when the zero value is valid.
             # - "ssatags" # Ensure array fields have the appropriate listType markers.
             - "statusoptional" # Ensure all first children within status should be optional.
             - "statussubresource" # All root objects that have a status field should have a status subresource.

api/v1beta2/identity_types.go

@@ -32,12 +32,12 @@ type OpenStackIdentityReference struct {
 	// The Secret may optionally contain a key named `cacert` containing a PEM-encoded CA certificate.
 	// +required
 	// +kubebuilder:validation:MinLength=1
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// cloudName specifies the name of the entry in the clouds.yaml file to use.
 	// +required
 	// +kubebuilder:validation:MinLength=1
-	CloudName string `json:"cloudName"`
+	CloudName string `json:"cloudName,omitempty"`
 
 	// region specifies an OpenStack region to use. If specified, it overrides
 	// any value in clouds.yaml. If specified for an OpenStackMachine, its

api/v1beta2/openstackcluster_types.go

@@ -156,7 +156,7 @@ type OpenStackClusterSpec struct {
 	// to be used when reconciling this cluster. It is also to reconcile
 	// machines unless overridden in the machine spec.
 	// +required
-	IdentityRef OpenStackIdentityReference `json:"identityRef"`
+	IdentityRef OpenStackIdentityReference `json:"identityRef,omitzero"`
 }
 
 type APIServer struct {
@@ -348,8 +348,8 @@ type ManagedSecurityGroups struct {
 
 	// allowAllInClusterTraffic allows all ingress and egress traffic between cluster nodes when set to true.
 	// +kubebuilder:default=false
-	// +required
-	AllowAllInClusterTraffic bool `json:"allowAllInClusterTraffic"`
+	// +optional
+	AllowAllInClusterTraffic bool `json:"allowAllInClusterTraffic,omitempty"`
 }
 
 var _ IdentityRefProvider = &OpenStackCluster{}

api/v1beta2/openstackclustertemplate_types.go

@@ -24,14 +24,14 @@ import (
 type OpenStackClusterTemplateResource struct {
 	// spec is the desired state of the OpenStackCluster.
 	// +required
-	Spec OpenStackClusterSpec `json:"spec"`
+	Spec OpenStackClusterSpec `json:"spec,omitzero"`
 }
 
 // OpenStackClusterTemplateSpec defines the desired state of OpenStackClusterTemplate.
 type OpenStackClusterTemplateSpec struct {
 	// template is the OpenStackClusterTemplate resource data.
 	// +required
-	Template OpenStackClusterTemplateResource `json:"template"`
+	Template OpenStackClusterTemplateResource `json:"template,omitzero"`
 }
 
 // +genclient

api/v1beta2/openstackmachine_types.go

@@ -53,7 +53,7 @@ type SchedulerHintAdditionalValue struct {
 	// Valid values are Bool, String, and Number.
 	// +required
 	// +unionDiscriminator
-	Type SchedulerHintValueType `json:"type"`
+	Type SchedulerHintValueType `json:"type,omitempty"`
 
 	// bool is the boolean value of the scheduler hint, used when Type is "Bool".
 	// This field is required if type is 'Bool', and must not be set otherwise.
@@ -83,12 +83,12 @@ type SchedulerHintAdditionalProperty struct {
 	// It is a unique identifier for the property.
 	// +kubebuilder:validation:MinLength:=1
 	// +required
-	Name string `json:"name"`
+	Name string `json:"name,omitempty"`
 
 	// value is the value of the scheduler hint property, which can be of various types
 	// (e.g., bool, string, int). The type is indicated by the Value.Type field.
 	// +required
-	Value SchedulerHintAdditionalValue `json:"value"`
+	Value SchedulerHintAdditionalValue `json:"value,omitzero"`
 }
 
 // OpenStackMachineSpec defines the desired state of OpenStackMachine.
@@ -99,12 +99,12 @@ type OpenStackMachineSpec struct {
 
 	// flavor is the flavor to use for this machine.
 	// +required
-	Flavor FlavorParam `json:"flavor"`
+	Flavor FlavorParam `json:"flavor,omitzero"`
 
 	// image is the image to use for the server instance.
 	// If the rootVolume is specified, this will be used when creating the root volume.
 	// +required
-	Image ImageParam `json:"image"`
+	Image ImageParam `json:"image,omitzero"`
 
 	// sshKeyName is the name of the SSH key to inject in the instance.
 	// +optional
@@ -179,13 +179,15 @@ type OpenStackMachineSpec struct {
 type ServerMetadata struct {
 	// key is the server metadata key
 	// +kubebuilder:validation:MaxLength:=255
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Key string `json:"key"`
+	Key string `json:"key,omitempty"`
 
 	// value is the server metadata value
 	// +kubebuilder:validation:MaxLength:=255
+	// +kubebuilder:validation:MinLength=1
 	// +required
-	Value string `json:"value"`
+	Value string `json:"value,omitempty"`
 }
 
 // MachineInitialization contains information about the initialization status of the machine.

api/v1beta2/openstackmachinetemplate_types.go

@@ -25,7 +25,7 @@ import (
 type OpenStackMachineTemplateSpec struct {
 	// template is the OpenStackMachineTemplate resource data.
 	// +required
-	Template OpenStackMachineTemplateResource `json:"template"`
+	Template OpenStackMachineTemplateResource `json:"template,omitzero"`
 }
 
 // OpenStackMachineTemplateStatus defines the observed state of OpenStackMachineTemplate.

api/v1beta2/types.go

@@ -28,13 +28,14 @@ import (
 type OpenStackMachineTemplateResource struct {
 	// spec is the specification of the desired behavior of the machine.
 	// +required
-	Spec OpenStackMachineSpec `json:"spec"`
+	Spec OpenStackMachineSpec `json:"spec,omitzero"`
 }
 
 type ResourceReference struct {
 	// name is the name of the referenced resource
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 }
 
 // ImageParam describes a glance image. It can be specified by ID, filter, or a
@@ -116,7 +117,7 @@ type ExternalRouterIPParam struct {
 	FixedIP string `json:"fixedIP,omitempty"`
 	// subnet is the subnet in which the FixedIP is used for the Gateway of this router.
 	// +required
-	Subnet SubnetParam `json:"subnet"`
+	Subnet SubnetParam `json:"subnet,omitzero"`
 }
 
 // NeutronTag represents a tag on a Neutron resource.
@@ -340,7 +341,8 @@ type SubnetSpec struct {
 	// cidr is representing the IP address range used to create the subnet, e.g. 10.0.0.0/24.
 	// This field is required when defining a subnet.
 	// +required
-	CIDR string `json:"cidr"`
+	// +kubebuilder:validation:MinLength=1
+	CIDR string `json:"cidr,omitempty"`
 
 	// dnsNameservers holds a list of DNS server addresses that will be provided when creating
 	// the subnet. These addresses need to have the same IP version as CIDR.
@@ -357,11 +359,13 @@ type SubnetSpec struct {
 type AllocationPool struct {
 	// start represents the start of the AllocationPool, that is the lowest IP of the pool.
 	// +required
-	Start string `json:"start"`
+	// +kubebuilder:validation:MinLength=1
+	Start string `json:"start,omitempty"`
 
 	// end represents the end of the AlloctionPool, that is the highest IP of the pool.
 	// +required
-	End string `json:"end"`
+	// +kubebuilder:validation:MinLength=1
+	End string `json:"end,omitempty"`
 }
 
 type PortOpts struct {
@@ -470,15 +474,17 @@ type ResolvedPortSpecFields struct {
 type ResolvedPortSpec struct {
 	// name is the name of the port.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 
 	// description is a human-readable description for the port.
 	// +optional
 	Description string `json:"description"`
 
 	// networkID is the ID of the network the port will be created in.
 	// +required
-	NetworkID string `json:"networkID"`
+	// +kubebuilder:validation:MinLength=1
+	NetworkID string `json:"networkID,omitempty"`
 
 	// tags applied to the port (and corresponding trunk, if a trunk is configured.)
 	// +listType=set
@@ -505,7 +511,8 @@ type ResolvedPortSpec struct {
 type PortStatus struct {
 	// id is the unique identifier of the port.
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 }
 
 type BindingProfile struct {
@@ -553,7 +560,8 @@ type AddressPair struct {
 	// the configuration of Neutron, it may be supported to specify a CIDR
 	// instead of a specific IP address.
 	// +required
-	IPAddress string `json:"ipAddress"`
+	// +kubebuilder:validation:MinLength=1
+	IPAddress string `json:"ipAddress,omitempty"`
 
 	// macAddress is the MAC address of the allowed address pair. If not
 	// specified, the MAC address will be the MAC address of the port.
@@ -595,7 +603,7 @@ type RootVolume struct {
 	// sizeGiB is the size of the block device in gibibytes (GiB).
 	// +required
 	// +kubebuilder:validation:Minimum:=1
-	SizeGiB int32 `json:"sizeGiB"`
+	SizeGiB int32 `json:"sizeGiB,omitempty"`
 
 	BlockDeviceVolume `json:",inline"`
 }
@@ -610,7 +618,8 @@ type BlockDeviceStorage struct {
 	// This can be either "Volume" or "Local".
 	// +unionDiscriminator
 	// +required
-	Type BlockDeviceType `json:"type"`
+	// +kubebuilder:validation:Enum=Local;Volume
+	Type BlockDeviceType `json:"type,omitempty"`
 
 	// volume contains additional storage options for a volume block device.
 	// +optional
@@ -676,17 +685,18 @@ type AdditionalBlockDevice struct {
 	// metadata API or the config drive.
 	// Name cannot be 'root', which is reserved for the root volume.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 
 	// sizeGiB is the size of the block device in gibibytes (GiB).
 	// +required
 	// +kubebuilder:validation:Minimum:=1
-	SizeGiB int32 `json:"sizeGiB"`
+	SizeGiB int32 `json:"sizeGiB,omitempty"`
 
 	// storage specifies the storage type of the block device and
 	// additional storage options.
 	// +required
-	Storage BlockDeviceStorage `json:"storage"`
+	Storage BlockDeviceStorage `json:"storage,omitzero"`
 }
 
 // ServerGroupParam specifies an OpenStack server group. It may be specified by ID or filter, but not both.
@@ -733,10 +743,12 @@ const (
 type NetworkStatus struct {
 	// name is the name of the network.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 	// id is the unique identifier of the network.
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 
 	// tags is a list of tags on the network.
 	// +optional
@@ -756,14 +768,17 @@ type NetworkStatusWithSubnets struct {
 type Subnet struct {
 	// name is the name of the subnet.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 	// id is the unique identifier of the subnet.
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 
 	// cidr is the CIDR of the subnet.
 	// +required
-	CIDR string `json:"cidr"`
+	// +kubebuilder:validation:MinLength=1
+	CIDR string `json:"cidr,omitempty"`
 
 	// tags is a list of tags on the subnet.
 	// +optional
@@ -774,10 +789,12 @@ type Subnet struct {
 type Router struct {
 	// name is the name of the router.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 	// id is the unique identifier of the router.
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 	// tags is a list of tags on the router.
 	// +optional
 	Tags []string `json:"tags,omitempty"`
@@ -790,16 +807,20 @@ type Router struct {
 type LoadBalancer struct {
 	// name is the name of the load balancer.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 	// id is the unique identifier of the load balancer.
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 	// ip is the IP address of the load balancer.
 	// +required
-	IP string `json:"ip"`
+	// +kubebuilder:validation:MinLength=1
+	IP string `json:"ip,omitempty"`
 	// internalIP is the internal IP address of the load balancer.
 	// +required
-	InternalIP string `json:"internalIP"`
+	// +kubebuilder:validation:MinLength=1
+	InternalIP string `json:"internalIP,omitempty"`
 	// allowedCIDRs is a list of CIDRs that are allowed to access the load balancer.
 	// +optional
 	AllowedCIDRs []string `json:"allowedCIDRs,omitempty"`
@@ -819,11 +840,13 @@ type LoadBalancer struct {
 type SecurityGroupStatus struct {
 	// name of the security group
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 
 	// id of the security group
 	// +required
-	ID string `json:"id"`
+	// +kubebuilder:validation:MinLength=1
+	ID string `json:"id,omitempty"`
 }
 
 // SecurityGroupRuleSpec represent the basic information of the associated OpenStack
@@ -835,7 +858,8 @@ type SecurityGroupRuleSpec struct {
 	// name of the security group rule.
 	// It's used to identify the rule so it can be patched and will not be sent to the OpenStack API.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 
 	// description of the security group rule.
 	// +optional
@@ -847,7 +871,7 @@ type SecurityGroupRuleSpec struct {
 	// instance. An egress rule is applied to traffic leaving the instance.
 	// +required
 	// +kubebuilder:validation:Enum=ingress;egress
-	Direction string `json:"direction"`
+	Direction string `json:"direction,omitempty"`
 
 	// etherType must be IPv4 or IPv6, and addresses represented in CIDR must match the
 	// ingress or egress rules.
@@ -971,7 +995,7 @@ type APIServerLoadBalancer struct {
 	//
 	// +required
 	// +kubebuilder:default:=true
-	Enabled *bool `json:"enabled"`
+	Enabled *bool `json:"enabled,omitempty"`
 
 	// additionalPorts adds additional tcp ports to the load balancer.
 	// +optional
@@ -1082,13 +1106,16 @@ type ValueSpec struct {
 	// name is the name of the key-value pair.
 	// This is just for identifying the pair and will not be sent to the OpenStack API.
 	// +required
-	Name string `json:"name"`
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name,omitempty"`
 	// key is the key in the key-value pair.
 	// +required
-	Key string `json:"key"`
+	// +kubebuilder:validation:MinLength=1
+	Key string `json:"key,omitempty"`
 	// value is the value in the key-value pair.
 	// +required
-	Value string `json:"value"`
+	// +kubebuilder:validation:MinLength=1
+	Value string `json:"value,omitempty"`
 }
 
 // JoinTags joins a slice of tags into a comma separated list of tags.