[deprecation] Deprecate stackscript (#724)

* Deleted stackscript code
* Updated linodemachine controller helpers
* Updated linodemachine controller
* Updated tests

Author: Andrews2024

api/v1alpha2/linodemachine_types.go

@@ -172,6 +172,8 @@ 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.
+	// +kubebuilder:deprecatedversion:warning="CloudinitMetadataSupport is deprecated"
 	// +optional
 	// +kubebuilder:default=true
 	CloudinitMetadataSupport bool `json:"cloudinitMetadataSupport,omitempty"`

clients/clients.go

@@ -53,8 +53,6 @@ type LinodeInstanceClient interface {
 	DeleteInstance(ctx context.Context, linodeID int) error
 	GetRegion(ctx context.Context, regionID string) (*linodego.Region, error)
 	GetImage(ctx context.Context, imageID string) (*linodego.Image, error)
-	CreateStackscript(ctx context.Context, opts linodego.StackscriptCreateOptions) (*linodego.Stackscript, error)
-	ListStackscripts(ctx context.Context, opts *linodego.ListOptions) ([]linodego.Stackscript, error)
 	GetType(ctx context.Context, typeID string) (*linodego.LinodeType, error)
 }
 

cloud/services/stackscript.sh

@@ -456,8 +456,9 @@ spec:
                 type: array
               cloudinitMetadataSupport:
                 default: true
-                description: CloudinitMetadataSupport determines whether to use cloud-init
-                  or not.
+                description: |-
+                  CloudinitMetadataSupport determines whether to use cloud-init or not.
+                  Deprecated: Stackscript no longer in use, so this field is not used.
                 type: boolean
               conditions:
                 description: Conditions defines current service state of the LinodeMachine.

cloud/services/stackscripts.go

@@ -638,7 +638,7 @@ _Appears in:_
 | --- | --- | --- | --- |
 | `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. | true |  |
+| `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 |  |
 | `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 /><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 /><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 /><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 /><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. |  |  |

cloud/services/stackscripts_test.go

@@ -103,6 +103,5 @@ infrastructure Linode via one of the following services:
 | Service                                                                                       | Bootstrap Data Limit                                                                       |
 | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
 | [Metadata](https://techdocs.akamai.com/cloud-computing/docs/overview-of-the-metadata-service) | [65535 bytes](https://techdocs.akamai.com/linode-api/reference/post-linode-instance)       |
-| [Stackscripts](https://www.linode.com/products/stackscripts/)                                 | [65,535 characters](https://techdocs.akamai.com/linode-api/reference/post-linode-instance) |
 
 These data limits are bypassed when the Cluster Object Store feature is enabled.

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

@@ -12,7 +12,6 @@ Make sure to create the token with at least the following read/write permissions
   - VPCs
   - IPs
   - Object Storage
-  - Stackscripts
   - Firewalls
 - clusterctl is [installed](https://cluster-api.sigs.k8s.io/user/quick-start#installation)
 - Cluster API [management cluster](https://cluster-api.sigs.k8s.io/user/quick-start#install-andor-configure-a-kubernetes-cluster) is created
@@ -40,11 +39,6 @@ This project uses [linodego](https://github.com/linode/linodego) for Linode API
 Please refer to it for more details on environment variables used for client configuration.
 ```
 
-```admonish warning
-For Regions and Images that do not yet support Akamai's cloud-init datasource CAPL will automatically use a stackscript shim
-to provision the node. If you are using a custom image ensure the [cloud_init](https://www.linode.com/docs/api/images/#image-create) flag is set correctly on it
-```
-
 ## Setup management cluster
 A clusterAPI management cluster is a kubernetes cluster that is responsible for managing the lifecycle of other child k8s clusters provisioned using Cluster API (CAPI). It serves as a control plane for provisioning, scaling, upgrading and deleting child kubernetes clusters.
 

docs/src/reference/out.md

@@ -21,7 +21,6 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
-	"slices"
 	"strings"
 	"time"
 
@@ -530,27 +529,20 @@ func (r *LinodeMachineReconciler) reconcilePreflightLinodeFirewallCheck(ctx cont
 }
 
 func (r *LinodeMachineReconciler) reconcilePreflightMetadataSupportConfigure(ctx context.Context, logger logr.Logger, machineScope *scope.MachineScope) (ctrl.Result, error) {
-	region, err := machineScope.LinodeClient.GetRegion(ctx, machineScope.LinodeMachine.Spec.Region)
+	_, err := machineScope.LinodeClient.GetRegion(ctx, machineScope.LinodeMachine.Spec.Region)
 	if err != nil {
 		logger.Error(err, fmt.Sprintf("Failed to fetch region %s", machineScope.LinodeMachine.Spec.Region))
 		return retryIfTransient(err, logger)
 	}
-	regionMetadataSupport := slices.Contains(region.Capabilities, linodego.CapabilityMetadata)
 	imageName := reconciler.DefaultMachineControllerLinodeImage
 	if machineScope.LinodeMachine.Spec.Image != "" {
 		imageName = machineScope.LinodeMachine.Spec.Image
 	}
-	image, err := machineScope.LinodeClient.GetImage(ctx, imageName)
+	_, err = machineScope.LinodeClient.GetImage(ctx, imageName)
 	if err != nil {
 		logger.Error(err, fmt.Sprintf("Failed to fetch image %s", imageName))
 		return retryIfTransient(err, logger)
 	}
-	imageMetadataSupport := slices.Contains(image.Capabilities, "cloud-init")
-	machineScope.LinodeMachine.Status.CloudinitMetadataSupport = true
-	if !imageMetadataSupport || !regionMetadataSupport {
-		logger.Info("cloud-init metadata support not available", "imageMetadataSupport", imageMetadataSupport, "regionMetadataSupport", regionMetadataSupport)
-		machineScope.LinodeMachine.Status.CloudinitMetadataSupport = false
-	}
 	conditions.Set(machineScope.LinodeMachine, metav1.Condition{
 		Type:   ConditionPreflightMetadataSupportConfigured,
 		Status: metav1.ConditionTrue,

docs/src/topics/cluster-object-store.md

@@ -55,9 +55,8 @@ import (
 )
 
 const (
-	maxBootstrapDataBytesCloudInit   = 16384
-	maxBootstrapDataBytesStackscript = 65535
-	vlanIPFormat                     = "%s/11"
+	maxBootstrapDataBytesCloudInit = 16384
+	vlanIPFormat                   = "%s/11"
 )
 
 var (
@@ -606,24 +605,10 @@ func setUserData(ctx context.Context, machineScope *scope.MachineScope, createCo
 		return err
 	}
 
-	if machineScope.LinodeMachine.Status.CloudinitMetadataSupport {
-		createConfig.Metadata = &linodego.InstanceMetadataOptions{
-			UserData: b64.StdEncoding.EncodeToString(bootstrapData),
-		}
-	} else {
-		logger.Info("using StackScripts for bootstrapping")
-		// WARNING: label, region and type are currently supported as cloud-init variables,
-		// any changes to this could be potentially backwards incompatible and should be noted through a backwards incompatible version update
-		instanceData := fmt.Sprintf("label: %s\nregion: %s\ntype: %s", machineScope.LinodeMachine.Name, machineScope.LinodeMachine.Spec.Region, machineScope.LinodeMachine.Spec.Type)
-		createConfig.StackScriptData = map[string]string{
-			"instancedata": b64.StdEncoding.EncodeToString([]byte(instanceData)),
-			"userdata":     b64.StdEncoding.EncodeToString(bootstrapData),
-		}
-		createConfig.StackScriptID, err = services.EnsureStackscript(ctx, machineScope)
-		if err != nil {
-			return fmt.Errorf("ensure stackscript: %w", err)
-		}
+	createConfig.Metadata = &linodego.InstanceMetadataOptions{
+		UserData: b64.StdEncoding.EncodeToString(bootstrapData),
 	}
+
 	return nil
 }
 
@@ -639,12 +624,8 @@ func resolveBootstrapData(ctx context.Context, machineScope *scope.MachineScope,
 		limit      int
 	)
 
-	// Determine limits for delivery service, e.g. Metadata vs. Stackscript.
-	if machineScope.LinodeMachine.Status.CloudinitMetadataSupport {
-		limit = maxBootstrapDataBytesCloudInit
-	} else {
-		limit = maxBootstrapDataBytesStackscript
-	}
+	// Determine limits for delivery service
+	limit = maxBootstrapDataBytesCloudInit
 
 	// Determine the delivery mechanism for the bootstrap data based on limits. This informs the formatting of the
 	// bootstrap data.
@@ -653,7 +634,7 @@ func resolveBootstrapData(ctx context.Context, machineScope *scope.MachineScope,
 	case size < limit:
 		return bootstrapdata, nil
 	// Compromise case (Metadata): Use compression.
-	case machineScope.LinodeMachine.Status.CloudinitMetadataSupport && gzipCompressionEnabled:
+	case gzipCompressionEnabled:
 		if compressed, err = compressUserData(bootstrapdata); err != nil {
 			// Break and use the Cluster Object Store workaround on compression failure.
 			logger.Info(fmt.Sprintf("Failed to compress bootstrap data: %v. Using Cluster Object Store instead.", err))