allow skipping of setting interfaces and linodeInterfaces via InterfaceGeneration on LinodeMachines, only update instanceConfig if configuring kernel or network helpers

Author: AshleyDumaine

api/v1alpha2/linodemachine_types.go

@@ -128,6 +128,13 @@ type LinodeMachineSpec struct {
 	// For more information, see https://techdocs.akamai.com/cloud-computing/docs/automatically-configure-networking
 	// Defaults to true.
 	NetworkHelper *bool `json:"networkHelper,omitempty"`
+
+	// InterfaceGeneration is the generation of the interface to use for the cluster's
+	// nodes in interface / linodeInterface are not specified for a LinodeMachine.
+	// If not set, defaults to "legacy_config".
+	// +kubebuilder:validation:Enum=legacy_config;linode
+	// +kubebuilder:default=legacy_config
+	InterfaceGeneration linodego.InterfaceGeneration `json:"interfaceGeneration,omitempty"`
 }
 
 // IPv6CreateOptions defines the IPv6 options for the instance.

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

@@ -228,6 +228,16 @@ spec:
               instanceID:
                 description: InstanceID is the Linode instance ID for this machine.
                 type: integer
+              interfaceGeneration:
+                default: legacy_config
+                description: |-
+                  InterfaceGeneration is the generation of the interface to use for the cluster's
+                  nodes in interface / linodeInterface are not specified for a LinodeMachine.
+                  If not set, defaults to "legacy_config".
+                enum:
+                - legacy_config
+                - linode
+                type: string
               interfaces:
                 items:
                   description: InstanceConfigInterfaceCreateOptions defines network

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

@@ -219,6 +219,16 @@ spec:
                         description: InstanceID is the Linode instance ID for this
                           machine.
                         type: integer
+                      interfaceGeneration:
+                        default: legacy_config
+                        description: |-
+                          InterfaceGeneration is the generation of the interface to use for the cluster's
+                          nodes in interface / linodeInterface are not specified for a LinodeMachine.
+                          If not set, defaults to "legacy_config".
+                        enum:
+                        - legacy_config
+                        - linode
+                        type: string
                       interfaces:
                         items:
                           description: InstanceConfigInterfaceCreateOptions defines

docs/src/reference/out.md

@@ -679,6 +679,7 @@ _Appears in:_
 | `vpcID` _integer_ | VPCID is the ID of an existing VPC in Linode. This allows using a VPC that is not managed by CAPL. |  |  |
 | `ipv6Options` _[IPv6CreateOptions](#ipv6createoptions)_ | IPv6Options defines the IPv6 options for the instance.<br />If not specified, IPv6 ranges won't be allocated to instance. |  |  |
 | `networkHelper` _boolean_ | NetworkHelper is an option usually enabled on account level. It helps configure networking automatically for instances.<br />You can use this to enable/disable the network helper for a specific instance.<br />For more information, see https://techdocs.akamai.com/cloud-computing/docs/automatically-configure-networking<br />Defaults to true. |  |  |
+| `interfaceGeneration` _[InterfaceGeneration](#interfacegeneration)_ | InterfaceGeneration is the generation of the interface to use for the cluster's<br />nodes in interface / linodeInterface are not specified for a LinodeMachine.<br />If not set, defaults to "legacy_config". | legacy_config | Enum: [legacy_config linode] <br /> |
 
 
 #### LinodeMachineStatus

internal/controller/linodemachine_controller.go

@@ -274,7 +274,7 @@ func (r *LinodeMachineReconciler) reconcileCreate(
 	}
 
 	if machineScope.LinodeMachine.Spec.FirewallRef != nil {
-		if !reconciler.ConditionTrue(machineScope.LinodeMachine, string(ConditionPreflightLinodeFirewallReady)) && machineScope.LinodeMachine.Spec.ProviderID == nil {
+		if !reconciler.ConditionTrue(machineScope.LinodeMachine, ConditionPreflightLinodeFirewallReady) && machineScope.LinodeMachine.Spec.ProviderID == nil {
 			res, err := r.reconcilePreflightLinodeFirewallCheck(ctx, logger, machineScope)
 			if err != nil || !res.IsZero() {
 				conditions.Set(machineScope.LinodeMachine, metav1.Condition{
@@ -553,6 +553,10 @@ func (r *LinodeMachineReconciler) reconcilePreflightMetadataSupportConfigure(ctx
 }
 
 func (r *LinodeMachineReconciler) reconcilePreflightCreate(ctx context.Context, logger logr.Logger, machineScope *scope.MachineScope) (ctrl.Result, error) {
+	// default to legacy interface generation if not set for now
+	if machineScope.LinodeMachine.Spec.InterfaceGeneration == "" {
+		machineScope.LinodeMachine.Spec.InterfaceGeneration = linodego.GenerationLegacyConfig
+	}
 	// get the bootstrap data for the Linode instance and set it for create config
 	createOpts, err := newCreateConfig(ctx, machineScope, r.GzipCompressionEnabled, logger)
 	if err != nil {
@@ -619,7 +623,7 @@ func (r *LinodeMachineReconciler) reconcilePreflightConfigure(ctx context.Contex
 		return ctrl.Result{RequeueAfter: reconciler.DefaultMachineControllerWaitForRunningDelay}, nil
 	}
 
-	configData := &linodego.InstanceConfigUpdateOptions{}
+	configData := linodego.InstanceConfigUpdateOptions{}
 	if machineScope.LinodeMachine.Spec.Configuration != nil && machineScope.LinodeMachine.Spec.Configuration.Kernel != "" {
 		configData.Kernel = machineScope.LinodeMachine.Spec.Configuration.Kernel
 	}
@@ -632,14 +636,14 @@ func (r *LinodeMachineReconciler) reconcilePreflightConfigure(ctx context.Contex
 	}
 
 	// only update the instance configuration if there are changes
-	if configData != nil {
+	if configData.Kernel != "" || configData.Helpers != nil {
 		instanceConfig, err := getDefaultInstanceConfig(ctx, machineScope, instanceID)
 		if err != nil {
 			logger.Error(err, "Failed to get default instance configuration")
 			return retryIfTransient(err, logger)
 		}
-		if _, err := machineScope.LinodeClient.UpdateInstanceConfig(ctx, instanceID, instanceConfig.ID, *configData); err != nil {
-			logger.Error(err, "Failed to update default instance configuration", "configuration", *configData)
+		if _, err := machineScope.LinodeClient.UpdateInstanceConfig(ctx, instanceID, instanceConfig.ID, configData); err != nil {
+			logger.Error(err, "Failed to update default instance configuration", "configuration", configData)
 			return retryIfTransient(err, logger)
 		}
 	}

internal/controller/linodemachine_controller_helpers.go

@@ -84,7 +84,7 @@ func fillCreateConfig(createConfig *linodego.InstanceCreateOptions, machineScope
 	if machineScope.LinodeMachine.Spec.PrivateIP != nil {
 		createConfig.PrivateIP = *machineScope.LinodeMachine.Spec.PrivateIP
 	} else {
-		if machineScope.LinodeMachine.Spec.LinodeInterfaces == nil {
+		if machineScope.LinodeMachine.Spec.LinodeInterfaces == nil && machineScope.LinodeMachine.Spec.InterfaceGeneration == linodego.GenerationLegacyConfig {
 			// Supported only for legacy network interfaces.
 			createConfig.PrivateIP = true
 		} else {
@@ -177,7 +177,7 @@ func configureVPCInterface(ctx context.Context, machineScope *scope.MachineScope
 // addVPCInterfaceFromDirectID handles adding a VPC interface from a direct ID
 func addVPCInterfaceFromDirectID(ctx context.Context, machineScope *scope.MachineScope, createConfig *linodego.InstanceCreateOptions, logger logr.Logger, vpcID int) error {
 	switch {
-	case createConfig.LinodeInterfaces != nil:
+	case createConfig.LinodeInterfaces != nil || (createConfig.LinodeInterfaces == nil && machineScope.LinodeMachine.Spec.InterfaceGeneration == linodego.GenerationLinode):
 		iface, err := getVPCLinodeInterfaceConfigFromDirectID(ctx, machineScope, createConfig.LinodeInterfaces, logger, vpcID)
 		if err != nil {
 			logger.Error(err, "Failed to get VPC linode interface config from direct ID")
@@ -207,7 +207,7 @@ func addVPCInterfaceFromDirectID(ctx context.Context, machineScope *scope.Machin
 // addVPCInterfaceFromReference handles adding a VPC interface from a reference
 func addVPCInterfaceFromReference(ctx context.Context, machineScope *scope.MachineScope, createConfig *linodego.InstanceCreateOptions, logger logr.Logger, vpcRef *corev1.ObjectReference) error {
 	switch {
-	case createConfig.LinodeInterfaces != nil:
+	case createConfig.LinodeInterfaces != nil || (createConfig.LinodeInterfaces == nil && machineScope.LinodeMachine.Spec.InterfaceGeneration == linodego.GenerationLinode):
 		iface, err := getVPCLinodeInterfaceConfig(ctx, machineScope, createConfig.LinodeInterfaces, logger, vpcRef)
 		if err != nil {
 			logger.Error(err, "Failed to get VPC interface config")
@@ -296,7 +296,7 @@ func buildInstanceAddrs(ctx context.Context, machineScope *scope.MachineScope, i
 func handleVlanIps(ctx context.Context, machineScope *scope.MachineScope, instanceID int) ([]clusterv1.MachineAddress, error) {
 	ips := []clusterv1.MachineAddress{}
 	switch {
-	case machineScope.LinodeMachine.Spec.LinodeInterfaces != nil:
+	case machineScope.LinodeMachine.Spec.LinodeInterfaces != nil || (machineScope.LinodeMachine.Spec.LinodeInterfaces == nil && machineScope.LinodeMachine.Spec.InterfaceGeneration == linodego.GenerationLinode):
 		ifaces, err := machineScope.LinodeClient.ListInterfaces(ctx, instanceID, &linodego.ListOptions{})
 		if err != nil || len(ifaces) == 0 {
 			return ips, fmt.Errorf("list interfaces: %w", err)
@@ -1060,7 +1060,7 @@ func linodeMachineSpecToInstanceCreateConfig(machineSpec infrav1alpha2.LinodeMac
 
 	if len(machineSpec.LinodeInterfaces) > 0 {
 		instCreateOpts.LinodeInterfaces = constructLinodeInterfaceCreateOpts(machineSpec.LinodeInterfaces)
-	} else {
+	} else if len(machineSpec.Interfaces) > 0 {
 		interfaces := make([]linodego.InstanceConfigInterfaceCreateOptions, len(machineSpec.Interfaces))
 		for idx, iface := range machineSpec.Interfaces {
 			interfaces[idx] = linodego.InstanceConfigInterfaceCreateOptions{
@@ -1439,7 +1439,7 @@ func getVPCRefFromScope(machineScope *scope.MachineScope) *corev1.ObjectReferenc
 // configureVlanInterface adds a VLAN interface to the configuration
 func configureVlanInterface(ctx context.Context, machineScope *scope.MachineScope, createConfig *linodego.InstanceCreateOptions, logger logr.Logger) error {
 	switch {
-	case createConfig.LinodeInterfaces != nil:
+	case createConfig.LinodeInterfaces != nil || (createConfig.LinodeInterfaces == nil && machineScope.LinodeMachine.Spec.InterfaceGeneration == linodego.GenerationLinode):
 		iface, err := getVlanLinodeInterfaceConfig(ctx, machineScope, createConfig.LinodeInterfaces, logger)
 		if err != nil {
 			logger.Error(err, "Failed to get VLAN interface config")
@@ -1501,10 +1501,8 @@ func configureFirewall(ctx context.Context, machineScope *scope.MachineScope, cr
 	createConfig.FirewallID = fwID
 
 	// If using LinodeInterfaces that needs to know about the firewall ID
-	if machineScope.LinodeMachine.Spec.LinodeInterfaces != nil {
-		for i := range createConfig.LinodeInterfaces {
-			createConfig.LinodeInterfaces[i].FirewallID = ptr.To(fwID)
-		}
+	for i := range createConfig.LinodeInterfaces {
+		createConfig.LinodeInterfaces[i].FirewallID = ptr.To(fwID)
 	}
 
 	return nil