Correct comments and documentation for the 'retain' field in VPCSubnetCreateOptions to ensure consistency in terminology. Refactor VPC fetching logic in LinodeVPCReconciler to improve code clarity and reduce redundancy by introducing a helper function for VPC retrieval.

Author: komer3

api/v1alpha2/linodevpc_types.go

@@ -64,7 +64,7 @@ type VPCSubnetCreateOptions struct {
 	// +optional
 	SubnetID int `json:"subnetID,omitempty"`
 	// Retain allows you to keep the Subnet after the LinodeVPC object is deleted.
-	// This is only applicable when the parent VPC has RetainVPC set to true.
+	// This is only applicable when the parent VPC has retain set to true.
 	// +optional
 	// +kubebuilder:default=false
 	Retain bool `json:"retain,omitempty"`

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

@@ -94,7 +94,7 @@ spec:
                       default: false
                       description: |-
                         Retain allows you to keep the Subnet after the LinodeVPC object is deleted.
-                        This is only applicable when the parent VPC has RetainVPC set to true.
+                        This is only applicable when the parent VPC has retain set to true.
                       type: boolean
                     subnetID:
                       description: SubnetID is subnet id for the subnet

docs/src/reference/out.md

@@ -1238,6 +1238,6 @@ _Appears in:_
 | `label` _string_ |  |  | MaxLength: 63 <br />MinLength: 3 <br /> |
 | `ipv4` _string_ |  |  |  |
 | `subnetID` _integer_ | SubnetID is subnet id for the subnet |  |  |
-| `retain` _boolean_ | Retain allows you to keep the Subnet after the LinodeVPC object is deleted.<br />This is only applicable when the parent VPC has RetainVPC set to true. | false |  |
+| `retain` _boolean_ | Retain allows you to keep the Subnet after the LinodeVPC object is deleted.<br />This is only applicable when the parent VPC has retain set to true. | false |  |
 
 

internal/controller/linodevpc_controller.go

@@ -370,15 +370,8 @@ func (r *LinodeVPCReconciler) handleRetainedVPC(ctx context.Context, logger logr
 }
 
 func (r *LinodeVPCReconciler) handleRetainedSubnets(ctx context.Context, logger logr.Logger, vpcScope *scope.VPCScope) error {
-	if vpcScope.LinodeVPC.Spec.VPCID == nil {
-		return nil
-	}
-
-	vpc, err := vpcScope.LinodeClient.GetVPC(ctx, *vpcScope.LinodeVPC.Spec.VPCID)
+	vpc, err := getVPC(ctx, vpcScope)
 	if err != nil {
-		if util.IgnoreLinodeAPIError(err, http.StatusNotFound) == nil {
-			return nil
-		}
 		logger.Error(err, "Failed to fetch VPC for subnet deletion")
 		if vpcScope.LinodeVPC.ObjectMeta.DeletionTimestamp.Add(reconciler.DefaultTimeout(r.ReconcileTimeout, reconciler.DefaultVPCControllerReconcileTimeout)).After(time.Now()) {
 			logger.Info("re-queuing VPC deletion due to fetch error for subnet deletion")
@@ -438,16 +431,8 @@ func (r *LinodeVPCReconciler) handleRetainedSubnets(ctx context.Context, logger
 }
 
 func (r *LinodeVPCReconciler) deleteVPCResources(ctx context.Context, logger logr.Logger, vpcScope *scope.VPCScope) error {
-	if vpcScope.LinodeVPC.Spec.VPCID == nil {
-		logger.Info("VPC ID is missing, nothing to do")
-		return nil
-	}
-
-	vpc, err := vpcScope.LinodeClient.GetVPC(ctx, *vpcScope.LinodeVPC.Spec.VPCID)
+	vpc, err := getVPC(ctx, vpcScope)
 	if err != nil {
-		if util.IgnoreLinodeAPIError(err, http.StatusNotFound) == nil {
-			return nil
-		}
 		logger.Error(err, "Failed to fetch VPC")
 		if vpcScope.LinodeVPC.ObjectMeta.DeletionTimestamp.Add(reconciler.DefaultTimeout(r.ReconcileTimeout, reconciler.DefaultVPCControllerReconcileTimeout)).After(time.Now()) {
 			logger.Info("re-queuing VPC deletion due to fetch error")

internal/controller/linodevpc_controller_helpers.go

@@ -19,6 +19,7 @@ package controller
 import (
 	"context"
 	"errors"
+	"net/http"
 
 	"github.com/go-logr/logr"
 	"github.com/linode/linodego"
@@ -128,3 +129,22 @@ func linodeVPCSpecToVPCCreateConfig(vpcSpec infrav1alpha2.LinodeVPCSpec) *linode
 		Subnets:     subnets,
 	}
 }
+
+// getVPC fetches a VPC and handles not-found errors.
+// It returns the VPC if found.
+// It returns nil, nil if the VPC is not found.
+// It returns nil and an error for other API errors.
+func getVPC(ctx context.Context, vpcScope *scope.VPCScope) (*linodego.VPC, error) {
+	if vpcScope.LinodeVPC.Spec.VPCID == nil {
+		return nil, nil
+	}
+
+	vpc, err := vpcScope.LinodeClient.GetVPC(ctx, *vpcScope.LinodeVPC.Spec.VPCID)
+	if err != nil {
+		if util.IgnoreLinodeAPIError(err, http.StatusNotFound) == nil {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return vpc, nil
+}