Add MaxLength markers to API fields

Signed-off-by: Stefan Büringer buringerst@vmware.com

Author: sbueringer

.golangci-kal.yml

@@ -78,10 +78,6 @@ issues:
     text: "maxlength"
     linters:
       - kal
-  - path: "api/v1beta1/*"
-    text: "must have a maximum length, add (kubebuilder:validation:MaxLength|kubebuilder:validation:items:MaxLength) marker"
-    linters:
-      - kal
   # controller-gen does not allow to add MaxItems to Schemaless fields
   - path: "api/v1beta1/*"
     text: "maxlength: field (AllOf|OneOf|AnyOf) must have a maximum items, add kubebuilder:validation:MaxItems marker"

api/v1beta1/cluster_types.go

@@ -541,6 +541,8 @@ 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.
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=253
 	Class string `json:"class"`
 
 	// classNamespace is the namespace of the ClusterClass object to create the topology.
@@ -553,6 +555,7 @@ type Topology struct {
 	ClassNamespace string `json:"classNamespace,omitempty"`
 
 	// version is the Kubernetes version of the cluster.
+	// +kubebuilder:validation:MaxLength=256
 	Version string `json:"version"`
 
 	// rolloutAfter performs a rollout of the entire cluster one component at a time,
@@ -669,17 +672,20 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	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.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// failureDomain is the failure domain the machines will be created in.
 	// Must match a key in the FailureDomains map stored on the cluster object.
 	// +optional
+	// +kubebuilder:validation:MaxLength=256
 	FailureDomain *string `json:"failureDomain,omitempty"`
 
 	// replicas is the number of worker nodes belonging to this set.
@@ -772,18 +778,21 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	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.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// failureDomains is the list of failure domains the machine pool will be created in.
 	// Must match a key in the FailureDomains map stored on the cluster object.
 	// +optional
 	// +kubebuilder:validation:MaxItems=100
+	// +kubebuilder:validation:items:MaxLength=256
 	FailureDomains []string `json:"failureDomains,omitempty"`
 
 	// nodeDrainTimeout is the total amount of time that the controller will spend on draining a node.
@@ -826,13 +835,15 @@ type MachinePoolTopology struct {
 // Variable definition in the ClusterClass `status` variables.
 type ClusterVariable struct {
 	// name of the variable.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// definitionFrom specifies where the definition of this Variable is from.
 	//
 	// Deprecated: This field is deprecated, must not be set anymore and is going to be removed in the next apiVersion.
 	//
 	// +optional
+	// +kubebuilder:validation:MaxLength=256
 	DefinitionFrom string `json:"definitionFrom,omitempty"`
 
 	// value of the variable.
@@ -897,6 +908,7 @@ type ClusterNetwork struct {
 
 	// serviceDomain is the domain name for services.
 	// +optional
+	// +kubebuilder:validation:MaxLength=253
 	ServiceDomain string `json:"serviceDomain,omitempty"`
 }
 
@@ -908,6 +920,7 @@ type ClusterNetwork struct {
 type NetworkRanges struct {
 	// cidrBlocks is a list of CIDR blocks.
 	// +kubebuilder:validation:MaxItems=100
+	// +kubebuilder:validation:items:MaxLength=256
 	CIDRBlocks []string `json:"cidrBlocks"`
 }
 
@@ -943,11 +956,13 @@ type ClusterStatus struct {
 	// Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md for more details.
 	//
 	// +optional
+	// +kubebuilder:validation:MaxLength=10240
 	FailureMessage *string `json:"failureMessage,omitempty"`
 
 	// phase represents the current phase of cluster actuation.
 	// E.g. Pending, Running, Terminating, Failed etc.
 	// +optional
+	// +kubebuilder:validation:MaxLength=50
 	Phase string `json:"phase,omitempty"`
 
 	// infrastructureReady is the state of the infrastructure provider.
@@ -1073,6 +1088,7 @@ 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.
+	// +kubebuilder:validation:MaxLength=512
 	Host string `json:"host"`
 
 	// port is the port on which the API server is serving.

api/v1beta1/clusterclass_types.go

@@ -214,6 +214,7 @@ type ControlPlaneClassNamingStrategy struct {
 	// * `.cluster.name`: The name of the cluster object.
 	// * `.random`: A random alphanumeric string, without vowels, of length 5.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Template *string `json:"template,omitempty"`
 }
 
@@ -227,6 +228,7 @@ type InfrastructureNamingStrategy struct {
 	// * `.cluster.name`: The name of the cluster object.
 	// * `.random`: A random alphanumeric string, without vowels, of length 5.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Template *string `json:"template,omitempty"`
 }
 
@@ -255,6 +257,7 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	Class string `json:"class"`
 
 	// template is a local struct containing a collection of templates for creation of
@@ -269,6 +272,7 @@ type MachineDeploymentClass struct {
 	// Must match a key in the FailureDomains map stored on the cluster object.
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachineDeploymentClass.
 	// +optional
+	// +kubebuilder:validation:MaxLength=256
 	FailureDomain *string `json:"failureDomain,omitempty"`
 
 	// namingStrategy allows changing the naming pattern used when creating the MachineDeployment.
@@ -350,6 +354,7 @@ type MachineDeploymentClassNamingStrategy struct {
 	// * `.random`: A random alphanumeric string, without vowels, of length 5.
 	// * `.machineDeployment.topologyName`: The name of the MachineDeployment topology (Cluster.spec.topology.workers.machineDeployments[].name).
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Template *string `json:"template,omitempty"`
 }
 
@@ -377,6 +382,7 @@ type MachineHealthCheckClass struct {
 	// (b) there are at most 5 unhealthy machines
 	// +optional
 	// +kubebuilder:validation:Pattern=^\[[0-9]+-[0-9]+\]$
+	// +kubebuilder:validation:MaxLength=32
 	UnhealthyRange *string `json:"unhealthyRange,omitempty"`
 
 	// nodeStartupTimeout allows to set the maximum time for MachineHealthCheck
@@ -410,6 +416,7 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	Class string `json:"class"`
 
 	// template is a local struct containing a collection of templates for creation of
@@ -421,6 +428,7 @@ type MachinePoolClass struct {
 	// NOTE: This value can be overridden while defining a Cluster.Topology using this MachinePoolClass.
 	// +optional
 	// +kubebuilder:validation:MaxItems=100
+	// +kubebuilder:validation:items:MaxLength=256
 	FailureDomains []string `json:"failureDomains,omitempty"`
 
 	// namingStrategy allows changing the naming pattern used when creating the MachinePool.
@@ -483,6 +491,7 @@ type MachinePoolClassNamingStrategy struct {
 	// * `.random`: A random alphanumeric string, without vowels, of length 5.
 	// * `.machinePool.topologyName`: The name of the MachinePool topology (Cluster.spec.topology.workers.machinePools[].name).
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Template *string `json:"template,omitempty"`
 }
 
@@ -495,6 +504,7 @@ func (m MachineHealthCheckClass) IsZero() bool {
 // be configured in the Cluster topology and used in patches.
 type ClusterClassVariable struct {
 	// name of the variable.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// required specifies if the variable is required.
@@ -549,6 +559,7 @@ type VariableSchema struct {
 // which are not supported in CAPI have been removed.
 type JSONSchemaProps struct {
 	// description is a human-readable description of this variable.
+	// +kubebuilder:validation:MaxLength=512
 	Description string `json:"description,omitempty"`
 
 	// example is an example for this variable.
@@ -557,6 +568,7 @@ type JSONSchemaProps struct {
 	// type is the type of the variable.
 	// Valid values are: object, array, string, integer, number or boolean.
 	// +optional
+	// +kubebuilder:validation:MaxLength=16
 	Type string `json:"type,omitempty"`
 
 	// properties specifies fields of an object.
@@ -593,6 +605,7 @@ type JSONSchemaProps struct {
 	// NOTE: Can only be set if type is object.
 	// +optional
 	// +kubebuilder:validation:MaxItems=1000
+	// +kubebuilder:validation:items:MaxLength=256
 	Required []string `json:"required,omitempty"`
 
 	// items specifies fields of an array.
@@ -624,6 +637,7 @@ type JSONSchemaProps struct {
 	// https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apiserver/validation/formats.go
 	// NOTE: Can only be set if type is string.
 	// +optional
+	// +kubebuilder:validation:MaxLength=32
 	Format string `json:"format,omitempty"`
 
 	// maxLength is the max length of a string variable.
@@ -639,6 +653,7 @@ type JSONSchemaProps struct {
 	// pattern is the regex which a string variable must match.
 	// NOTE: Can only be set if type is string.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Pattern string `json:"pattern,omitempty"`
 
 	// maximum is the maximum of an integer or number variable.
@@ -809,12 +824,14 @@ type ValidationRule struct {
 	// skipped if an old value could not be found.
 	//
 	// +required
+	// +kubebuilder:validation:MaxLength=512
 	Rule string `json:"rule"`
 	// message represents the message displayed when validation fails. The message is required if the Rule contains
 	// line breaks. The message must not contain line breaks.
 	// If unset, the message is "failed rule: {Rule}".
 	// e.g. "must be a URL with the host matching spec.host"
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	Message string `json:"message,omitempty"`
 	// messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails.
 	// Since messageExpression is used as a failure message, it must evaluate to a string.
@@ -826,6 +843,7 @@ type ValidationRule struct {
 	// Example:
 	// "x must be less than max ("+string(self.max)+")"
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	MessageExpression string `json:"messageExpression,omitempty"`
 	// reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule.
 	// The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate".
@@ -846,6 +864,7 @@ type ValidationRule struct {
 	// For field name which contains special characters, use `['specialName']` to refer the field name.
 	// e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']`
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	FieldPath string `json:"fieldPath,omitempty"`
 }
 
@@ -871,9 +890,11 @@ const (
 // ClusterClassPatch defines a patch which is applied to customize the referenced templates.
 type ClusterClassPatch struct {
 	// name of the patch.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// description is a human-readable description of this patch.
+	// +kubebuilder:validation:MaxLength=512
 	Description string `json:"description,omitempty"`
 
 	// enabledIf is a Go template to be used to calculate if a patch should be enabled.
@@ -882,6 +903,7 @@ type ClusterClassPatch struct {
 	// be disabled.
 	// If EnabledIf is not set, the patch will be enabled per default.
 	// +optional
+	// +kubebuilder:validation:MaxLength=256
 	EnabledIf *string `json:"enabledIf,omitempty"`
 
 	// definitions define inline patches.
@@ -916,9 +938,11 @@ type PatchDefinition struct {
 // Note: The results of selection based on the individual fields are ANDed.
 type PatchSelector struct {
 	// apiVersion filters templates by apiVersion.
+	// +kubebuilder:validation:MaxLength=512
 	APIVersion string `json:"apiVersion"`
 
 	// kind filters templates by kind.
+	// +kubebuilder:validation:MaxLength=256
 	Kind string `json:"kind"`
 
 	// matchResources selects templates based on where they are referenced.
@@ -956,6 +980,7 @@ type PatchSelectorMatchMachineDeploymentClass struct {
 	// names selects templates by class names.
 	// +optional
 	// +kubebuilder:validation:MaxItems=100
+	// +kubebuilder:validation:items:MaxLength=256
 	Names []string `json:"names,omitempty"`
 }
 
@@ -965,20 +990,23 @@ type PatchSelectorMatchMachinePoolClass struct {
 	// names selects templates by class names.
 	// +optional
 	// +kubebuilder:validation:MaxItems=100
+	// +kubebuilder:validation:items:MaxLength=256
 	Names []string `json:"names,omitempty"`
 }
 
 // JSONPatch defines a JSON patch.
 type JSONPatch struct {
 	// op defines the operation of the patch.
 	// Note: Only `add`, `replace` and `remove` are supported.
+	// +kubebuilder:validation:MaxLength=8
 	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
+	// +kubebuilder:validation:MaxLength=512
 	Path string `json:"path"`
 
 	// value defines the value of the patch.
@@ -1004,12 +1032,14 @@ type JSONPatchValue struct {
 	// variable is the variable to be used as value.
 	// Variable can be one of the variables defined in .spec.variables or a builtin variable.
 	// +optional
+	// +kubebuilder:validation:MaxLength=256
 	Variable *string `json:"variable,omitempty"`
 
 	// template is the Go template to be used to calculate the value.
 	// A template can reference variables defined in .spec.variables and builtin variables.
 	// Note: The template must evaluate to a valid YAML or JSON value.
 	// +optional
+	// +kubebuilder:validation:MaxLength=10240
 	Template *string `json:"template,omitempty"`
 }
 
@@ -1018,14 +1048,17 @@ type JSONPatchValue struct {
 type ExternalPatchDefinition struct {
 	// generateExtension references an extension which is called to generate patches.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	GenerateExtension *string `json:"generateExtension,omitempty"`
 
 	// validateExtension references an extension which is called to validate the topology.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	ValidateExtension *string `json:"validateExtension,omitempty"`
 
 	// discoverVariablesExtension references an extension which is called to discover variables.
 	// +optional
+	// +kubebuilder:validation:MaxLength=512
 	DiscoverVariablesExtension *string `json:"discoverVariablesExtension,omitempty"`
 
 	// settings defines key value pairs to be passed to the extensions.
@@ -1079,6 +1112,7 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	Name string `json:"name"`
 
 	// definitionsConflict specifies whether or not there are conflicting definitions for a single variable name.
@@ -1095,6 +1129,7 @@ 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.
+	// +kubebuilder:validation:MaxLength=256
 	From string `json:"from"`
 
 	// required specifies if the variable is required.