enable optionalorrequired linter

Signed-off-by: sivchari <[email protected]>

Author: sivchari

.golangci-kal.yml

@@ -25,14 +25,14 @@ linters-settings:
           - "nofloats" # Ensure floats are not used.
           - "requiredfields" # Required fields should not be pointers, and should not have `omitempty`.
           - "statussubresource" # All root objects that have a `status` field should have a status subresource.
+          - "optionalorrequired" # Every field should be marked as `+optional` or `+required`.
 
           # Per discussion in July 2024, we are keeping phase fields for now.
           # See https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685929508
           # and https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685919394.
           # - "nophase" # Phase fields are discouraged by the Kube API conventions, use conditions instead.
 
           # Linters below this line are disabled, pending conversation on how and when to enable them.
-          # - "optionalorrequired" # Every field should be marked as `+optional` or `+required`.
           disable:
           - "*" # We will manually enable new linters after understanding the impact. Disable all by default.
         lintersConfig:
@@ -87,3 +87,12 @@ issues:
     text: "field (XPreserveUnknownFields|XPreserveUnknownFields|XValidations|XMetadata|XIntOrString) json tag does not match pattern"
     linters:
       - kal
+  # The following rules are disabled until we migrate to the new API.
+  - path: "bootstrap/kubeadm/api/v1beta1/kubeadm_types.go"
+    text: "field Token is marked as required, should not be a pointer"
+    linters:
+      - kal
+  - path: "api/v1beta1/clusterclass_types.go"
+    text: "field Ref is marked as required, should not be a pointer"
+    linters:
+      - kal

api/v1beta1/cluster_types.go

@@ -519,6 +519,7 @@ type ClusterAvailabilityGate struct {
 // Topology encapsulates the information of the managed resources.
 type Topology struct {
 	// class is the name of the ClusterClass object to create the topology.
+	// +required
 	Class string `json:"class"`
 
 	// classNamespace is the namespace of the ClusterClass object to create the topology.
@@ -531,6 +532,7 @@ type Topology struct {
 	ClassNamespace string `json:"classNamespace,omitempty"`
 
 	// version is the Kubernetes version of the cluster.
+	// +required
 	Version string `json:"version"`
 
 	// rolloutAfter performs a rollout of the entire cluster one component at a time,
@@ -644,12 +646,14 @@ type MachineDeploymentTopology struct {
 	// class is the name of the MachineDeploymentClass used to create the set of worker nodes.
 	// This should match one of the deployment classes defined in the ClusterClass object
 	// mentioned in the `Cluster.Spec.Class` field.
+	// +required
 	Class string `json:"class"`
 
 	// name is the unique identifier for this MachineDeploymentTopology.
 	// The value is used with other unique identifiers to create a MachineDeployment's Name
 	// (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length,
 	// the values are hashed together.
+	// +required
 	Name string `json:"name"`
 
 	// failureDomain is the failure domain the machines will be created in.
@@ -747,12 +751,14 @@ type MachinePoolTopology struct {
 	// class is the name of the MachinePoolClass used to create the pool of worker nodes.
 	// This should match one of the deployment classes defined in the ClusterClass object
 	// mentioned in the `Cluster.Spec.Class` field.
+	// +required
 	Class string `json:"class"`
 
 	// name is the unique identifier for this MachinePoolTopology.
 	// The value is used with other unique identifiers to create a MachinePool's Name
 	// (e.g. cluster's name, etc). In case the name is greater than the allowed maximum length,
 	// the values are hashed together.
+	// +required
 	Name string `json:"name"`
 
 	// failureDomains is the list of failure domains the machine pool will be created in.
@@ -800,6 +806,7 @@ type MachinePoolTopology struct {
 // Variable definition in the ClusterClass `status` variables.
 type ClusterVariable struct {
 	// name of the variable.
+	// +required
 	Name string `json:"name"`
 
 	// definitionFrom specifies where the definition of this Variable is from.
@@ -816,6 +823,7 @@ type ClusterVariable struct {
 	// hard-coded schema for apiextensionsv1.JSON which cannot be produced by another type via controller-tools,
 	// 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"`
 }
 
@@ -878,6 +886,7 @@ type ClusterNetwork struct {
 // NetworkRanges represents ranges of network addresses.
 type NetworkRanges struct {
 	// cidrBlocks is a list of CIDR blocks.
+	// +required
 	CIDRBlocks []string `json:"cidrBlocks"`
 }
 
@@ -1043,9 +1052,11 @@ func (c *ClusterStatus) GetTypedPhase() ClusterPhase {
 // APIEndpoint represents a reachable Kubernetes API endpoint.
 type APIEndpoint struct {
 	// host is the hostname on which the API server is serving.
+	// +required
 	Host string `json:"host"`
 
 	// port is the port on which the API server is serving.
+	// +required
 	Port int32 `json:"port"`
 }
 
@@ -1080,11 +1091,14 @@ type Cluster struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of Cluster.
+	// +optional
 	Spec ClusterSpec `json:"spec,omitempty"`
 	// status is the observed state of Cluster.
+	// +optional
 	Status ClusterStatus `json:"status,omitempty"`
 }
 
@@ -1218,8 +1232,10 @@ type ClusterList struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard list's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#lists-and-simple-kinds
+	// +optional
 	metav1.ListMeta `json:"metadata,omitempty"`
 	// items is the list of Clusters.
+	// +optional
 	Items []Cluster `json:"items"`
 }
 

api/v1beta1/clusterclass_types.go

@@ -75,11 +75,14 @@ type ClusterClass struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard object's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is the desired state of ClusterClass.
+	// +optional
 	Spec ClusterClassSpec `json:"spec,omitempty"`
 	// status is the observed state of ClusterClass.
+	// +optional
 	Status ClusterClassStatus `json:"status,omitempty"`
 }
 
@@ -251,10 +254,12 @@ type MachineDeploymentClass struct {
 	// class denotes a type of worker node present in the cluster,
 	// this name MUST be unique within a ClusterClass and can be referenced
 	// in the Cluster to create a managed MachineDeployment.
+	// +required
 	Class string `json:"class"`
 
 	// template is a local struct containing a collection of templates for creation of
 	// MachineDeployment objects representing a set of worker nodes.
+	// +required
 	Template MachineDeploymentClassTemplate `json:"template"`
 
 	// machineHealthCheck defines a MachineHealthCheck for this MachineDeploymentClass.
@@ -296,6 +301,7 @@ type MachineDeploymentClass struct {
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.
+	// +optional
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 
 	// readinessGates specifies additional conditions to include when evaluating Machine Ready condition.
@@ -315,6 +321,7 @@ type MachineDeploymentClass struct {
 	// strategy is the deployment strategy to use to replace existing machines with
 	// new ones.
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.
+	// +optional
 	Strategy *MachineDeploymentStrategy `json:"strategy,omitempty"`
 }
 
@@ -328,10 +335,12 @@ type MachineDeploymentClassTemplate struct {
 
 	// bootstrap contains the bootstrap template reference to be used
 	// for the creation of worker Machines.
+	// +required
 	Bootstrap LocalObjectTemplate `json:"bootstrap"`
 
 	// infrastructure contains the infrastructure template reference to be used
 	// for the creation of worker Machines.
+	// +required
 	Infrastructure LocalObjectTemplate `json:"infrastructure"`
 }
 
@@ -405,10 +414,12 @@ type MachinePoolClass struct {
 	// class denotes a type of machine pool present in the cluster,
 	// this name MUST be unique within a ClusterClass and can be referenced
 	// in the Cluster to create a managed MachinePool.
+	// +required
 	Class string `json:"class"`
 
 	// template is a local struct containing a collection of templates for creation of
 	// MachinePools objects representing a pool of worker nodes.
+	// +required
 	Template MachinePoolClassTemplate `json:"template"`
 
 	// failureDomains is the list of failure domains the MachinePool should be attached to.
@@ -446,6 +457,7 @@ type MachinePoolClass struct {
 	// Defaults to 0 (machine will be considered available as soon as it
 	// is ready)
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.
+	// +optional
 	MinReadySeconds *int32 `json:"minReadySeconds,omitempty"`
 }
 
@@ -459,10 +471,12 @@ type MachinePoolClassTemplate struct {
 
 	// bootstrap contains the bootstrap template reference to be used
 	// for the creation of the Machines in the MachinePool.
+	// +required
 	Bootstrap LocalObjectTemplate `json:"bootstrap"`
 
 	// infrastructure contains the infrastructure template reference to be used
 	// for the creation of the MachinePool.
+	// +required
 	Infrastructure LocalObjectTemplate `json:"infrastructure"`
 }
 
@@ -489,12 +503,14 @@ func (m MachineHealthCheckClass) IsZero() bool {
 // be configured in the Cluster topology and used in patches.
 type ClusterClassVariable struct {
 	// name of the variable.
+	// +required
 	Name string `json:"name"`
 
 	// required specifies if the variable is required.
 	// Note: this applies to the variable as a whole and thus the
 	// top-level object defined in the schema. If nested fields are
 	// required, this will be specified inside the schema.
+	// +required
 	Required bool `json:"required"`
 
 	// metadata is the metadata of a variable.
@@ -507,6 +523,7 @@ type ClusterClassVariable struct {
 	Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
 
 	// schema defines the schema of the variable.
+	// +required
 	Schema VariableSchema `json:"schema"`
 }
 
@@ -533,6 +550,7 @@ type VariableSchema struct {
 	// openAPIV3Schema defines the schema of a variable via OpenAPI v3
 	// schema. The schema is a subset of the schema used in
 	// Kubernetes CRDs.
+	// +required
 	OpenAPIV3Schema JSONSchemaProps `json:"openAPIV3Schema"`
 }
 
@@ -543,9 +561,11 @@ type VariableSchema struct {
 // which are not supported in CAPI have been removed.
 type JSONSchemaProps struct {
 	// description is a human-readable description of this variable.
+	// +optional
 	Description string `json:"description,omitempty"`
 
 	// example is an example for this variable.
+	// +optional
 	Example *apiextensionsv1.JSON `json:"example,omitempty"`
 
 	// type is the type of the variable.
@@ -862,9 +882,11 @@ const (
 // ClusterClassPatch defines a patch which is applied to customize the referenced templates.
 type ClusterClassPatch struct {
 	// name of the patch.
+	// +required
 	Name string `json:"name"`
 
 	// description is a human-readable description of this patch.
+	// +optional
 	Description string `json:"description,omitempty"`
 
 	// enabledIf is a Go template to be used to calculate if a patch should be enabled.
@@ -890,11 +912,13 @@ type ClusterClassPatch struct {
 // PatchDefinition defines a patch which is applied to customize the referenced templates.
 type PatchDefinition struct {
 	// selector defines on which templates the patch should be applied.
+	// +required
 	Selector PatchSelector `json:"selector"`
 
 	// jsonPatches defines the patches which should be applied on the templates
 	// matching the selector.
 	// Note: Patches will be applied in the order of the array.
+	// +required
 	JSONPatches []JSONPatch `json:"jsonPatches"`
 }
 
@@ -905,12 +929,15 @@ type PatchDefinition struct {
 // Note: The results of selection based on the individual fields are ANDed.
 type PatchSelector struct {
 	// apiVersion filters templates by apiVersion.
+	// +required
 	APIVersion string `json:"apiVersion"`
 
 	// kind filters templates by kind.
+	// +required
 	Kind string `json:"kind"`
 
 	// matchResources selects templates based on where they are referenced.
+	// +required
 	MatchResources PatchSelectorMatch `json:"matchResources"`
 }
 
@@ -959,13 +986,15 @@ type PatchSelectorMatchMachinePoolClass struct {
 type JSONPatch struct {
 	// op defines the operation of the patch.
 	// Note: Only `add`, `replace` and `remove` are supported.
+	// +required
 	Op string `json:"op"`
 
 	// path defines the path of the patch.
 	// Note: Only the spec of a template can be patched, thus the path has to start with /spec/.
 	// Note: For now the only allowed array modifications are `append` and `prepend`, i.e.:
 	// * for op: `add`: only index 0 (prepend) and - (append) are allowed
 	// * for op: `replace` or `remove`: no indexes are allowed
+	// +required
 	Path string `json:"path"`
 
 	// value defines the value of the patch.
@@ -1026,6 +1055,7 @@ type ExternalPatchDefinition struct {
 type LocalObjectTemplate struct {
 	// ref is a required reference to a custom resource
 	// offered by a provider.
+	// +required
 	Ref *corev1.ObjectReference `json:"ref"`
 }
 
@@ -1065,13 +1095,15 @@ type ClusterClassV1Beta2Status struct {
 // ClusterClassStatusVariable defines a variable which appears in the status of a ClusterClass.
 type ClusterClassStatusVariable struct {
 	// name is the name of the variable.
+	// +required
 	Name string `json:"name"`
 
 	// definitionsConflict specifies whether or not there are conflicting definitions for a single variable name.
 	// +optional
 	DefinitionsConflict bool `json:"definitionsConflict"`
 
 	// definitions is a list of definitions for a variable.
+	// +required
 	Definitions []ClusterClassStatusVariableDefinition `json:"definitions"`
 }
 
@@ -1080,12 +1112,14 @@ type ClusterClassStatusVariableDefinition struct {
 	// from specifies the origin of the variable definition.
 	// This will be `inline` for variables defined in the ClusterClass or the name of a patch defined in the ClusterClass
 	// for variables discovered from a DiscoverVariables runtime extensions.
+	// +required
 	From string `json:"from"`
 
 	// required specifies if the variable is required.
 	// Note: this applies to the variable as a whole and thus the
 	// top-level object defined in the schema. If nested fields are
 	// required, this will be specified inside the schema.
+	// +required
 	Required bool `json:"required"`
 
 	// metadata is the metadata of a variable.
@@ -1098,6 +1132,7 @@ type ClusterClassStatusVariableDefinition struct {
 	Metadata ClusterClassVariableMetadata `json:"metadata,omitempty"`
 
 	// schema defines the schema of the variable.
+	// +required
 	Schema VariableSchema `json:"schema"`
 }
 
@@ -1136,8 +1171,10 @@ type ClusterClassList struct {
 	metav1.TypeMeta `json:",inline"`
 	// metadata is the standard list's metadata.
 	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#lists-and-simple-kinds
+	// +optional
 	metav1.ListMeta `json:"metadata,omitempty"`
 	// items is the list of ClusterClasses.
+	// +optional
 	Items []ClusterClass `json:"items"`
 }
 

api/v1beta1/common_types.go

@@ -284,9 +284,11 @@ const (
 // MachineAddress contains information for the node's address.
 type MachineAddress struct {
 	// type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.
+	// +required
 	Type MachineAddressType `json:"type"`
 
 	// address is the machine address.
+	// +required
 	Address string `json:"address"`
 }