[improvement] : store subnet id in linodeVPC and remove GetVPC call (#…

…548)

* store subnet id in linodeVPC and remove GetVPC call from linodemachine_controller

* address review comments

* change subnetId to subnetID

api/v1alpha1/conversion.go

@@ -96,3 +96,7 @@ func Convert_v1alpha2_LinodeClusterSpec_To_v1alpha1_LinodeClusterSpec(in *infras
 	// VLAN is not supported in v1alpha1
 	return autoConvert_v1alpha2_LinodeClusterSpec_To_v1alpha1_LinodeClusterSpec(in, out, scope)
 }
+
+func Convert_v1alpha2_VPCSubnetCreateOptions_To_v1alpha1_VPCSubnetCreateOptions(in *infrastructurev1alpha2.VPCSubnetCreateOptions, out *VPCSubnetCreateOptions, scope conversion.Scope) error {
+	return autoConvert_v1alpha2_VPCSubnetCreateOptions_To_v1alpha1_VPCSubnetCreateOptions(in, out, scope)
+}

api/v1alpha2/linodevpc_types.go

@@ -36,7 +36,6 @@ type LinodeVPCSpec struct {
 	Description string `json:"description,omitempty"`
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
 	Region string `json:"region"`
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
 	// +optional
 	Subnets []VPCSubnetCreateOptions `json:"subnets,omitempty"`
 
@@ -54,6 +53,9 @@ type VPCSubnetCreateOptions struct {
 	Label string `json:"label,omitempty"`
 	// +optional
 	IPv4 string `json:"ipv4,omitempty"`
+	// SubnetID is subnet id for the subnet
+	// +optional
+	SubnetID int `json:"subnetID,omitempty"`
 }
 
 // LinodeVPCStatus defines the observed state of LinodeVPC

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

@@ -254,11 +254,11 @@ spec:
                       maxLength: 63
                       minLength: 3
                       type: string
+                    subnetID:
+                      description: SubnetID is subnet id for the subnet
+                      type: integer
                   type: object
                 type: array
-                x-kubernetes-validations:
-                - message: Value is immutable
-                  rule: self == oldSelf
               vpcID:
                 type: integer
             required:

controller/linodemachine_controller_helpers.go

@@ -26,7 +26,6 @@ import (
 	"net/http"
 	"net/netip"
 	"slices"
-	"sort"
 	"time"
 
 	"github.com/go-logr/logr"
@@ -403,29 +402,17 @@ func getVPCInterfaceConfig(ctx context.Context, machineScope *scope.MachineScope
 		return nil, errors.New("vpc is not available")
 	}
 
-	var subnetID int
-	vpc, err := machineScope.LinodeClient.GetVPC(ctx, *linodeVPC.Spec.VPCID)
-	if err != nil {
-		logger.Error(err, "Failed to fetch LinodeVPC")
-
-		return nil, err
-	}
-	if vpc == nil {
-		logger.Error(nil, "Failed to fetch VPC")
-
-		return nil, errors.New("failed to fetch VPC")
-	}
-	if len(vpc.Subnets) == 0 {
+	if len(linodeVPC.Spec.Subnets) == 0 {
 		logger.Error(nil, "Failed to find subnet")
 
 		return nil, errors.New("failed to find subnet")
 	}
-	// Place node into the least busy subnet
-	sort.Slice(vpc.Subnets, func(i, j int) bool {
-		return len(vpc.Subnets[i].Linodes) > len(vpc.Subnets[j].Linodes)
-	})
 
-	subnetID = vpc.Subnets[0].ID
+	subnetID := linodeVPC.Spec.Subnets[0].SubnetID
+	if subnetID == 0 {
+		return nil, errors.New("failed to find subnet as subnet id set is 0")
+	}
+
 	for i, netInterface := range interfaces {
 		if netInterface.Purpose == linodego.InterfacePurposeVPC {
 			interfaces[i].SubnetID = &subnetID

controller/linodemachine_controller_test.go

@@ -1783,9 +1783,15 @@ var _ = Describe("machine in VPC", Label("machine", "VPC"), Ordered, func() {
 				UID:       "5123122",
 			},
 			Spec: infrav1alpha2.LinodeVPCSpec{
-				VPCID:   ptr.To(1),
-				Region:  "us-ord",
-				Subnets: []infrav1alpha2.VPCSubnetCreateOptions{},
+				VPCID:  ptr.To(1),
+				Region: "us-ord",
+				Subnets: []infrav1alpha2.VPCSubnetCreateOptions{
+					{
+						IPv4:     "10.0.0.0/8",
+						SubnetID: 1,
+						Label:    "test",
+					},
+				},
 			},
 			Status: infrav1alpha2.LinodeVPCStatus{
 				Ready: true,
@@ -1849,9 +1855,6 @@ var _ = Describe("machine in VPC", Label("machine", "VPC"), Ordered, func() {
 			Return([]linodego.VPC{}, nil)
 		mockLinodeClient.EXPECT().
 			CreateVPC(ctx, gomock.Any()).
-			Return(&linodego.VPC{ID: 1}, nil)
-		mockLinodeClient.EXPECT().
-			GetVPC(ctx, gomock.Any()).
 			Return(&linodego.VPC{ID: 1, Subnets: []linodego.VPCSubnet{{
 				ID:    1,
 				Label: "test",
@@ -1927,9 +1930,6 @@ var _ = Describe("machine in VPC", Label("machine", "VPC"), Ordered, func() {
 			Return([]linodego.VPC{}, nil)
 		mockLinodeClient.EXPECT().
 			CreateVPC(ctx, gomock.Any()).
-			Return(&linodego.VPC{ID: 1}, nil)
-		mockLinodeClient.EXPECT().
-			GetVPC(ctx, gomock.Any()).
 			Return(&linodego.VPC{ID: 1, Subnets: []linodego.VPCSubnet{{
 				ID:    1,
 				Label: "test",

controller/linodevpc_controller_helpers.go

@@ -57,6 +57,7 @@ func reconcileVPC(ctx context.Context, vpcScope *scope.VPCScope, logger logr.Log
 	} else if len(vpcs) != 0 {
 		// Labels are unique
 		vpcScope.LinodeVPC.Spec.VPCID = &vpcs[0].ID
+		updateVPCSpecSubnets(vpcScope, &vpcs[0])
 
 		return nil
 	}
@@ -75,10 +76,23 @@ func reconcileVPC(ctx context.Context, vpcScope *scope.VPCScope, logger logr.Log
 	}
 
 	vpcScope.LinodeVPC.Spec.VPCID = &vpc.ID
+	updateVPCSpecSubnets(vpcScope, vpc)
 
 	return nil
 }
 
+// updateVPCSpecSubnets updates Subnets in linodeVPC spec and adds linode specific ID to them
+func updateVPCSpecSubnets(vpcScope *scope.VPCScope, vpc *linodego.VPC) {
+	for i, specSubnet := range vpcScope.LinodeVPC.Spec.Subnets {
+		for _, vpcSubnet := range vpc.Subnets {
+			if specSubnet.Label == vpcSubnet.Label {
+				vpcScope.LinodeVPC.Spec.Subnets[i].SubnetID = vpcSubnet.ID
+				break
+			}
+		}
+	}
+}
+
 func linodeVPCSpecToVPCCreateConfig(vpcSpec infrav1alpha2.LinodeVPCSpec) *linodego.VPCCreateOptions {
 	var buf bytes.Buffer
 	enc := gob.NewEncoder(&buf)