fix deprecated warnings and restrict KAL linter exclusions to v1alpha2 APIs

Author: eljohnson92

.golangci-kal.yml

@@ -15,19 +15,26 @@ linters:
         type: "module"
         description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
         settings:
-          linters:
-            # TODO: remove linters from this list as we add support from them
-            disable:
-              # integers linter will force type change from int to int32/int64, we are going to wait for v1beta1 to enable this
-              - "integers"
-              # optionalfields requires changing fields to pointers in a way that might be hard to support in a backwards compatible way
-              - "optionalfields"
-          lintersConfig: { }
+          linters: {}
+          lintersConfig:
+            optionalfields:
+              pointers:
+                preference: WhenRequired
   exclusions:
     rules:
       - path-except: "^api/"
         linters:
           - kubeapilinter
+      # integers linter will force type change from int to int32/int64, we are going to wait for v1beta1 to enable this
+      - path: "api/v1alpha2/*"
+        text: "integers"
+        linters:
+          - kubeapilinter
+      # optionalfields requires changing fields to pointers in a way that might be hard to support in a backwards compatible way
+      - path: "api/v1alpha2/*"
+        text: "optionalfields"
+        linters:
+          - kubeapilinter
 issues:
   max-issues-per-linter: 0
   max-same-issues: 0

api/v1alpha2/linodemachine_types.go

@@ -528,7 +528,9 @@ type LinodeMachineStatus struct {
 	Addresses []clusterv1.MachineAddress `json:"addresses,omitempty"`
 
 	// cloudinitMetadataSupport determines whether to use cloud-init or not.
-	// Deprecated: Stackscript no longer in use, so this field is not used.
+	//
+	// Deprecated: stackscript are no longer in use, so this field is not used.
+	//
 	// +kubebuilder:deprecatedversion:warning="CloudinitMetadataSupport is deprecated"
 	// +optional
 	// +kubebuilder:default=true

api/v1alpha2/linodeobjectstoragekey_types.go

@@ -91,14 +91,18 @@ type LinodeObjectStorageKeySpec struct {
 	GeneratedSecret `json:"generatedSecret"`
 
 	// secretType instructs the controller what type of secret to generate containing access key details.
-	// Deprecated: Use generatedSecret.type.
+	//
+	// Deprecated: secretType is no longer supported, Use generatedSecret.type.
+	//
 	// +kubebuilder:validation:Enum=Opaque;addons.cluster.x-k8s.io/resource-set
 	// +kubebuilder:deprecatedversion:warning="secretType deprecated by generatedSecret.type"
 	// +optional
 	SecretType corev1.SecretType `json:"secretType,omitempty"`
 
 	// secretDataFormat instructs the controller how to format the data stored in the secret containing access key details.
-	// Deprecated: Use generatedSecret.format.
+	//
+	// Deprecated: secretDataFormat is no longer supported, please use generatedSecret.format.
+	//
 	// +kubebuilder:deprecatedversion:warning="secretDataFormat deprecated by generatedSecret.format"
 	// +optional
 	SecretDataFormat map[string]string `json:"secretDataFormat,omitempty"`

config/crd/bases/infrastructure.cluster.x-k8s.io_linodemachines.yaml

@@ -941,7 +941,8 @@ spec:
                 default: true
                 description: |-
                   cloudinitMetadataSupport determines whether to use cloud-init or not.
-                  Deprecated: Stackscript no longer in use, so this field is not used.
+
+                  Deprecated: stackscript are no longer in use, so this field is not used.
                 type: boolean
               conditions:
                 description: conditions define the current service state of the LinodeMachine.

config/crd/bases/infrastructure.cluster.x-k8s.io_linodeobjectstoragekeys.yaml

@@ -145,12 +145,14 @@ spec:
                   type: string
                 description: |-
                   secretDataFormat instructs the controller how to format the data stored in the secret containing access key details.
-                  Deprecated: Use generatedSecret.format.
+
+                  Deprecated: secretDataFormat is no longer supported, please use generatedSecret.format.
                 type: object
               secretType:
                 description: |-
                   secretType instructs the controller what type of secret to generate containing access key details.
-                  Deprecated: Use generatedSecret.type.
+
+                  Deprecated: secretType is no longer supported, Use generatedSecret.type.
                 enum:
                 - Opaque
                 - addons.cluster.x-k8s.io/resource-set

docs/src/reference/out.md

@@ -723,7 +723,7 @@ _Appears in:_
 | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#condition-v1-meta) array_ | conditions define the current service state of the LinodeMachine. |  |  |
 | `ready` _boolean_ | ready is true when the provider resource is ready. | false |  |
 | `addresses` _MachineAddress array_ | addresses contains the Linode instance associated addresses. |  |  |
-| `cloudinitMetadataSupport` _boolean_ | cloudinitMetadataSupport determines whether to use cloud-init or not.<br />Deprecated: Stackscript no longer in use, so this field is not used. | true |  |
+| `cloudinitMetadataSupport` _boolean_ | cloudinitMetadataSupport determines whether to use cloud-init or not.<br />Deprecated: stackscript are no longer in use, so this field is not used. | true |  |
 | `instanceState` _[InstanceStatus](#instancestatus)_ | instanceState is the state of the Linode instance for this machine. |  |  |
 | `failureReason` _string_ | failureReason will be set in the event that there is a terminal problem<br />reconciling the Machine and will contain a succinct value suitable<br />for machine interpretation.<br />This field should not be set for transitive errors that a controller<br />faces that are expected to be fixed automatically over<br />time (like service outages), but instead indicate that something is<br />fundamentally wrong with the Machine's spec or the configuration of<br />the controller, and that manual intervention is required. Examples<br />of terminal errors would be invalid combinations of settings in the<br />spec, values that are unsupported by the controller, or the<br />responsible controller itself being critically misconfigured.<br />Any transient errors that occur during the reconciliation of Machines<br />can be added as events to the Machine object and/or logged in the<br />controller's output. |  |  |
 | `failureMessage` _string_ | failureMessage will be set in the event that there is a terminal problem<br />reconciling the Machine and will contain a more verbose string suitable<br />for logging and human consumption.<br />This field should not be set for transitive errors that a controller<br />faces that are expected to be fixed automatically over<br />time (like service outages), but instead indicate that something is<br />fundamentally wrong with the Machine's spec or the configuration of<br />the controller, and that manual intervention is required. Examples<br />of terminal errors would be invalid combinations of settings in the<br />spec, values that are unsupported by the controller, or the<br />responsible controller itself being critically misconfigured.<br />Any transient errors that occur during the reconciliation of Machines<br />can be added as events to the Machine object and/or logged in the<br />controller's output. |  |  |
@@ -982,8 +982,8 @@ _Appears in:_
 | `credentialsRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#secretreference-v1-core)_ | credentialsRef is a reference to a Secret that contains the credentials to use for generating access keys.<br />If not supplied, then the credentials of the controller will be used. |  |  |
 | `keyGeneration` _integer_ | keyGeneration may be modified to trigger a rotation of the access key. | 0 |  |
 | `generatedSecret` _[GeneratedSecret](#generatedsecret)_ | generatedSecret configures the Secret to generate containing access key details. |  |  |
-| `secretType` _[SecretType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#secrettype-v1-core)_ | secretType instructs the controller what type of secret to generate containing access key details.<br />Deprecated: Use generatedSecret.type. |  | Enum: [Opaque addons.cluster.x-k8s.io/resource-set] <br /> |
-| `secretDataFormat` _object (keys:string, values:string)_ | secretDataFormat instructs the controller how to format the data stored in the secret containing access key details.<br />Deprecated: Use generatedSecret.format. |  |  |
+| `secretType` _[SecretType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#secrettype-v1-core)_ | secretType instructs the controller what type of secret to generate containing access key details.<br />Deprecated: secretType is no longer supported, Use generatedSecret.type. |  | Enum: [Opaque addons.cluster.x-k8s.io/resource-set] <br /> |
+| `secretDataFormat` _object (keys:string, values:string)_ | secretDataFormat instructs the controller how to format the data stored in the secret containing access key details.<br />Deprecated: secretDataFormat is no longer supported, please use generatedSecret.format. |  |  |
 
 
 #### LinodeObjectStorageKeyStatus