api/v1beta1: add Ignition field to AWSMachineSpec

This commit adds new Ignition block to AWSMachineSpec struct, which
will allow different way of handling user data. If either bootstrap data
has format defined as Ignition or user explicitly specify to use
Ignition as a bootstrap format, machine controller will handle things
accordingly.

Co-authored-by: Dongsu Park <[email protected]>
Signed-off-by: Mateusz Gozdek <[email protected]>

Author: 2 people

api/v1alpha3/awsmachine_conversion.go

@@ -40,6 +40,8 @@ func (r *AWSMachine) ConvertTo(dstRaw conversion.Hub) error {
 
 	restoreSpec(&restored.Spec, &dst.Spec)
 
+	dst.Spec.Ignition = restored.Spec.Ignition
+
 	return nil
 }
 
@@ -100,6 +102,7 @@ func (r *AWSMachineTemplate) ConvertTo(dstRaw conversion.Hub) error {
 	}
 
 	dst.Spec.Template.ObjectMeta = restored.Spec.Template.ObjectMeta
+	dst.Spec.Template.Spec.Ignition = restored.Spec.Template.Spec.Ignition
 
 	restoreSpec(&restored.Spec.Template.Spec, &dst.Spec.Template.Spec)
 

api/v1alpha3/zz_generated.conversion.go

@@ -18,6 +18,7 @@ package v1alpha4
 
 import (
 	apiconversion "k8s.io/apimachinery/pkg/conversion"
+	"sigs.k8s.io/cluster-api-provider-aws/api/v1beta1"
 	infrav1 "sigs.k8s.io/cluster-api-provider-aws/api/v1beta1"
 	utilconversion "sigs.k8s.io/cluster-api/util/conversion"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
@@ -26,14 +27,31 @@ import (
 // ConvertTo converts the v1alpha4 AWSMachine receiver to a v1beta1 AWSMachine.
 func (src *AWSMachine) ConvertTo(dstRaw conversion.Hub) error {
 	dst := dstRaw.(*infrav1.AWSMachine)
-	return Convert_v1alpha4_AWSMachine_To_v1beta1_AWSMachine(src, dst, nil)
+	if err := Convert_v1alpha4_AWSMachine_To_v1beta1_AWSMachine(src, dst, nil); err != nil {
+		return err
+	}
+
+	// Manually restore data.
+	restored := &v1beta1.AWSMachine{}
+	if ok, err := utilconversion.UnmarshalData(src, restored); err != nil || !ok {
+		return err
+	}
+
+	dst.Spec.Ignition = restored.Spec.Ignition
+
+	return nil
 }
 
 // ConvertFrom converts the v1beta1 AWSMachine to a v1alpha4 AWSMachine.
 func (dst *AWSMachine) ConvertFrom(srcRaw conversion.Hub) error {
 	src := srcRaw.(*infrav1.AWSMachine)
 
-	return Convert_v1beta1_AWSMachine_To_v1alpha4_AWSMachine(src, dst, nil)
+	if err := Convert_v1beta1_AWSMachine_To_v1alpha4_AWSMachine(src, dst, nil); err != nil {
+		return err
+	}
+
+	// Preserve Hub data on down-conversion except for metadata.
+	return utilconversion.MarshalData(src, dst)
 }
 
 // ConvertTo converts the v1alpha4 AWSMachineList receiver to a v1beta1 AWSMachineList.
@@ -64,6 +82,7 @@ func (r *AWSMachineTemplate) ConvertTo(dstRaw conversion.Hub) error {
 	}
 
 	dst.Spec.Template.ObjectMeta = restored.Spec.Template.ObjectMeta
+	dst.Spec.Template.Spec.Ignition = restored.Spec.Template.Spec.Ignition
 
 	return nil
 }
@@ -100,3 +119,7 @@ func (dst *AWSMachineTemplateList) ConvertFrom(srcRaw conversion.Hub) error {
 func Convert_v1beta1_AWSMachineTemplateResource_To_v1alpha4_AWSMachineTemplateResource(in *infrav1.AWSMachineTemplateResource, out *AWSMachineTemplateResource, s apiconversion.Scope) error {
 	return autoConvert_v1beta1_AWSMachineTemplateResource_To_v1alpha4_AWSMachineTemplateResource(in, out, s)
 }
+
+func Convert_v1beta1_AWSMachineSpec_To_v1alpha4_AWSMachineSpec(in *v1beta1.AWSMachineSpec, out *AWSMachineSpec, s apiconversion.Scope) error {
+	return autoConvert_v1beta1_AWSMachineSpec_To_v1alpha4_AWSMachineSpec(in, out, s)
+}

api/v1alpha4/awsmachine_conversion.go

@@ -27,6 +27,9 @@ const (
 	// MachineFinalizer allows ReconcileAWSMachine to clean up AWS resources associated with AWSMachine before
 	// removing it from the apiserver.
 	MachineFinalizer = "awsmachine.infrastructure.cluster.x-k8s.io"
+
+	// DefaultIgnitionVersion represents default Ignition version generated for machine userdata.
+	DefaultIgnitionVersion = "2.3"
 )
 
 // SecretBackend defines variants for backend secret storage.
@@ -142,6 +145,10 @@ type AWSMachineSpec struct {
 	// +optional
 	CloudInit CloudInit `json:"cloudInit,omitempty"`
 
+	// Ignition defined options related to the bootstrapping systems where Ignition is used.
+	// +optional
+	Ignition *Ignition `json:"ignition,omitempty"`
+
 	// SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.
 	// +optional
 	SpotMarketOptions *SpotMarketOptions `json:"spotMarketOptions,omitempty"`
@@ -179,6 +186,16 @@ type CloudInit struct {
 	SecureSecretsBackend SecretBackend `json:"secureSecretsBackend,omitempty"`
 }
 
+// Ignition defines options related to the bootstrapping systems where Ignition is used.
+type Ignition struct {
+	// Version defines which version of Ignition will be used to generate bootstrap data.
+	//
+	// +optional
+	// +kubebuilder:default="2.3"
+	// +kubebuilder:validation:Enum="2.3"
+	Version string `json:"version,omitempty"`
+}
+
 // AWSMachineStatus defines the observed state of AWSMachine.
 type AWSMachineStatus struct {
 	// Ready is true when the provider resource is ready.

api/v1beta1/awsmachine_types.go

@@ -50,6 +50,7 @@ func (r *AWSMachine) ValidateCreate() error {
 	var allErrs field.ErrorList
 
 	allErrs = append(allErrs, r.validateCloudInitSecret()...)
+	allErrs = append(allErrs, r.validateIgnitionAndCloudInit()...)
 	allErrs = append(allErrs, r.validateRootVolume()...)
 	allErrs = append(allErrs, r.validateNonRootVolumes()...)
 	allErrs = append(allErrs, r.validateSSHKeyName()...)
@@ -140,6 +141,31 @@ func (r *AWSMachine) validateCloudInitSecret() field.ErrorList {
 	return allErrs
 }
 
+func (r *AWSMachine) cloudInitConfigured() bool {
+	configured := false
+
+	configured = configured || r.Spec.CloudInit.SecretPrefix != ""
+	configured = configured || r.Spec.CloudInit.SecretCount != 0
+	configured = configured || r.Spec.CloudInit.SecureSecretsBackend != ""
+	configured = configured || r.Spec.CloudInit.InsecureSkipSecretsManager
+
+	return configured
+}
+
+func (r *AWSMachine) ignitionEnabled() bool {
+	return r.Spec.Ignition != nil
+}
+
+func (r *AWSMachine) validateIgnitionAndCloudInit() field.ErrorList {
+	var allErrs field.ErrorList
+
+	if r.ignitionEnabled() && r.cloudInitConfigured() {
+		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "cloudInit"), "cannot be set if spec.ignition is set"))
+	}
+
+	return allErrs
+}
+
 func (r *AWSMachine) validateRootVolume() field.ErrorList {
 	var allErrs field.ErrorList
 
@@ -200,9 +226,17 @@ func (r *AWSMachine) ValidateDelete() error {
 // Default implements webhook.Defaulter such that an empty CloudInit will be defined with a default
 // SecureSecretsBackend as SecretBackendSecretsManager iff InsecureSkipSecretsManager is unset.
 func (r *AWSMachine) Default() {
-	if !r.Spec.CloudInit.InsecureSkipSecretsManager && r.Spec.CloudInit.SecureSecretsBackend == "" {
+	if !r.Spec.CloudInit.InsecureSkipSecretsManager && r.Spec.CloudInit.SecureSecretsBackend == "" && !r.ignitionEnabled() {
 		r.Spec.CloudInit.SecureSecretsBackend = SecretBackendSecretsManager
 	}
+
+	if r.ignitionEnabled() && r.Spec.Ignition.Version == "" {
+		if r.Spec.Ignition == nil {
+			r.Spec.Ignition = &Ignition{}
+		}
+
+		r.Spec.Ignition.Version = DefaultIgnitionVersion
+	}
 }
 
 func (r *AWSMachine) validateAdditionalSecurityGroups() field.ErrorList {

api/v1beta1/awsmachine_webhook.go

@@ -113,6 +113,12 @@ func (r *AWSMachineTemplate) ValidateCreate() error {
 	allErrs = append(allErrs, r.validateRootVolume()...)
 	allErrs = append(allErrs, r.validateNonRootVolumes()...)
 
+	cloudInitConfigured := spec.CloudInit.SecureSecretsBackend != "" || spec.CloudInit.InsecureSkipSecretsManager
+	if cloudInitConfigured && spec.Ignition != nil {
+		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "template", "spec", "cloudInit"),
+			"cannot be set if spec.template.spec.ignition is set"))
+	}
+
 	return aggregateObjErrors(r.GroupVersionKind().GroupKind(), r.Name, allErrs)
 }
 

api/v1beta1/awsmachinetemplate_webhook.go

@@ -1085,6 +1085,18 @@ spec:
                 description: IAMInstanceProfile is a name of an IAM instance profile
                   to assign to the instance
                 type: string
+              ignition:
+                description: Ignition defined options related to the bootstrapping
+                  systems where Ignition is used.
+                properties:
+                  version:
+                    default: "2.3"
+                    description: Version defines which version of Ignition will be
+                      used to generate bootstrap data.
+                    enum:
+                    - "2.3"
+                    type: string
+                type: object
               imageLookupBaseOS:
                 description: ImageLookupBaseOS is the name of the base operating system
                   to use for image lookup the AMI is not set.

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

@@ -891,6 +891,18 @@ spec:
                         description: IAMInstanceProfile is a name of an IAM instance
                           profile to assign to the instance
                         type: string
+                      ignition:
+                        description: Ignition defined options related to the bootstrapping
+                          systems where Ignition is used.
+                        properties:
+                          version:
+                            default: "2.3"
+                            description: Version defines which version of Ignition
+                              will be used to generate bootstrap data.
+                            enum:
+                            - "2.3"
+                            type: string
+                        type: object
                       imageLookupBaseOS:
                         description: ImageLookupBaseOS is the name of the base operating
                           system to use for image lookup the AMI is not set.