update v1beta2 with CapacityReservationPreference

BraeTroutman · BraeTroutman · commit a2d76a72634f · 2025-08-08T12:00:54.000-04:00
update all the API types that map to EC2 RunInstance operations,
allowing for the specification of CapacityReservationPreference
as well as validations to ensure that these values play well
with AWS specifications for use of CapacityReservationPreference with
CapacityReservationID
diff --git a/api/v1beta1/awscluster_conversion.go b/api/v1beta1/awscluster_conversion.go
@@ -65,6 +65,7 @@ func (src *AWSCluster) ConvertTo(dstRaw conversion.Hub) error {
 		dst.Status.Bastion.MarketType = restored.Status.Bastion.MarketType
 		dst.Status.Bastion.HostAffinity = restored.Status.Bastion.HostAffinity
 		dst.Status.Bastion.HostID = restored.Status.Bastion.HostID
+		dst.Status.Bastion.CapacityReservationPreference = restored.Status.Bastion.CapacityReservationPreference
 	}
 	dst.Spec.Partition = restored.Spec.Partition
 
diff --git a/api/v1beta1/awsmachine_conversion.go b/api/v1beta1/awsmachine_conversion.go
@@ -46,6 +46,7 @@ func (src *AWSMachine) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.MarketType = restored.Spec.MarketType
 	dst.Spec.HostID = restored.Spec.HostID
 	dst.Spec.HostAffinity = restored.Spec.HostAffinity
+	dst.Spec.CapacityReservationPreference = restored.Spec.CapacityReservationPreference
 	dst.Spec.NetworkInterfaceType = restored.Spec.NetworkInterfaceType
 	if restored.Spec.ElasticIPPool != nil {
 		if dst.Spec.ElasticIPPool == nil {
@@ -112,6 +113,7 @@ func (r *AWSMachineTemplate) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.Template.Spec.MarketType = restored.Spec.Template.Spec.MarketType
 	dst.Spec.Template.Spec.HostID = restored.Spec.Template.Spec.HostID
 	dst.Spec.Template.Spec.HostAffinity = restored.Spec.Template.Spec.HostAffinity
+	dst.Spec.Template.Spec.CapacityReservationPreference = restored.Spec.Template.Spec.CapacityReservationPreference
 	dst.Spec.Template.Spec.NetworkInterfaceType = restored.Spec.Template.Spec.NetworkInterfaceType
 	if restored.Spec.Template.Spec.ElasticIPPool != nil {
 		if dst.Spec.Template.Spec.ElasticIPPool == nil {
diff --git a/api/v1beta1/zz_generated.conversion.go b/api/v1beta1/zz_generated.conversion.go
diff --git a/api/v1beta2/awsmachine_types.go b/api/v1beta2/awsmachine_types.go
@@ -245,6 +245,13 @@ type AWSMachineSpec struct {
 	// +optional
 	// +kubebuilder:validation:Enum:=default;host
 	HostAffinity *string `json:"hostAffinity,omitempty"`
+
+	// CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+	// "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+	// "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+	// "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+	// +optional
+	CapacityReservationPreference CapacityReservationPreference `json:"capacityReservationPreference,omitempty"`
 }
 
 // CloudInit defines options related to the bootstrapping systems where
diff --git a/api/v1beta2/awsmachine_webhook.go b/api/v1beta2/awsmachine_webhook.go
@@ -79,6 +79,7 @@ func (*awsMachineWebhook) ValidateCreate(_ context.Context, obj runtime.Object)
 	allErrs = append(allErrs, r.Spec.AdditionalTags.Validate()...)
 	allErrs = append(allErrs, r.validateNetworkElasticIPPool()...)
 	allErrs = append(allErrs, r.validateInstanceMarketType()...)
+	allErrs = append(allErrs, r.validateCapacityReservation()...)
 
 	return nil, aggregateObjErrors(r.GroupVersionKind().GroupKind(), r.Name, allErrs)
 }
@@ -380,6 +381,14 @@ func (r *AWSMachine) validateNetworkElasticIPPool() field.ErrorList {
 	return allErrs
 }
 
+func (r *AWSMachine) validateCapacityReservation() field.ErrorList {
+	var allErrs field.ErrorList
+	if r.Spec.CapacityReservationID != nil && r.Spec.CapacityReservationPreference != CapacityReservationPreferenceOnly && r.Spec.CapacityReservationPreference != "" {
+		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "capacityReservationPreference"), "when a reservation ID is specified, capacityReservationPreference may only be `capacity-reservations-only` or empty"))
+	}
+	return allErrs
+}
+
 func (r *AWSMachine) validateInstanceMarketType() field.ErrorList {
 	var allErrs field.ErrorList
 	if r.Spec.MarketType == MarketTypeCapacityBlock && r.Spec.SpotMarketOptions != nil {
diff --git a/api/v1beta2/awsmachine_webhook_test.go b/api/v1beta2/awsmachine_webhook_test.go
@@ -261,6 +261,38 @@ func TestAWSMachineCreate(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			name: "invalid case, CapacityReservationId is set and CapacityReservationPreference is not `capacity-reservation-only`",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType:                  "test",
+					CapacityReservationID:         aws.String("cr-12345678901234567"),
+					CapacityReservationPreference: CapacityReservationPreferenceNone,
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "valid CapacityReservationId is set and CapacityReservationPreference is not specified",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType:          "test",
+					CapacityReservationID: aws.String("cr-12345678901234567"),
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "valid CapacityReservationId is set and CapacityReservationPreference is `capacity-reservation-only`",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType:                  "test",
+					CapacityReservationID:         aws.String("cr-12345678901234567"),
+					CapacityReservationPreference: CapacityReservationPreferenceOnly,
+				},
+			},
+			wantErr: false,
+		},
 		{
 			name: "empty instance type not allowed",
 			machine: &AWSMachine{
diff --git a/api/v1beta2/types.go b/api/v1beta2/types.go
@@ -285,8 +285,31 @@ type Instance struct {
 	// HostID specifies the dedicated host on which the instance should be started.
 	// +optional
 	HostID *string `json:"hostID,omitempty"`
+
+	// CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+	// "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+	// "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+	// "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+	// +optional
+	CapacityReservationPreference CapacityReservationPreference `json:"capacityReservationPreference,omitempty"`
 }
 
+// CapacityReservationPreference describes the preferred use of capacity reservations
+// of an instance
+// +kubebuilder:validation:Enum:=None;CapacityReservationsOnly;Open
+type CapacityReservationPreference string
+
+const (
+	// CapacityReservationPreferenceNone is a CapacityReservationPreference enum value
+	CapacityReservationPreferenceNone CapacityReservationPreference = "None"
+
+	// CapacityReservationPreferenceOnly is a CapacityReservationPreference enum value
+	CapacityReservationPreferenceOnly CapacityReservationPreference = "CapacityReservationsOnly"
+
+	// CapacityReservationPreferenceOpen is a CapacityReservationPreference enum value
+	CapacityReservationPreferenceOpen CapacityReservationPreference = "Open"
+)
+
 // MarketType describes the market type of an Instance
 // +kubebuilder:validation:Enum:=OnDemand;Spot;CapacityBlock
 type MarketType string
diff --git a/config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanes.yaml b/config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanes.yaml
@@ -1214,6 +1214,17 @@ spec:
                     description: CapacityReservationID specifies the target Capacity
                       Reservation into which the instance should be launched.
                     type: string
+                  capacityReservationPreference:
+                    description: |-
+                      CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                      "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                      "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                      "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                    enum:
+                    - None
+                    - CapacityReservationsOnly
+                    - Open
+                    type: string
                   ebsOptimized:
                     description: Indicates whether the instance is optimized for Amazon
                       EBS I/O.
@@ -3410,6 +3421,17 @@ spec:
                     description: CapacityReservationID specifies the target Capacity
                       Reservation into which the instance should be launched.
                     type: string
+                  capacityReservationPreference:
+                    description: |-
+                      CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                      "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                      "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                      "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                    enum:
+                    - None
+                    - CapacityReservationsOnly
+                    - Open
+                    type: string
                   ebsOptimized:
                     description: Indicates whether the instance is optimized for Amazon
                       EBS I/O.
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_awsclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_awsclusters.yaml
@@ -2197,6 +2197,17 @@ spec:
                     description: CapacityReservationID specifies the target Capacity
                       Reservation into which the instance should be launched.
                     type: string
+                  capacityReservationPreference:
+                    description: |-
+                      CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                      "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                      "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                      "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                    enum:
+                    - None
+                    - CapacityReservationsOnly
+                    - Open
+                    type: string
                   ebsOptimized:
                     description: Indicates whether the instance is optimized for Amazon
                       EBS I/O.
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinepools.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinepools.yaml
@@ -644,6 +644,17 @@ spec:
                     description: CapacityReservationID specifies the target Capacity
                       Reservation into which the instance should be launched.
                     type: string
+                  capacityReservationPreference:
+                    description: |-
+                      CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                      "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                      "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                      "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                    enum:
+                    - None
+                    - CapacityReservationsOnly
+                    - Open
+                    type: string
                   iamInstanceProfile:
                     description: |-
                       The name or the Amazon Resource Name (ARN) of the instance profile associated
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachines.yaml
@@ -641,6 +641,17 @@ spec:
                 description: CapacityReservationID specifies the target Capacity Reservation
                   into which the instance should be launched.
                 type: string
+              capacityReservationPreference:
+                description: |-
+                  CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                  "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                  "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                  "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                enum:
+                - None
+                - CapacityReservationsOnly
+                - Open
+                type: string
               cloudInit:
                 description: |-
                   CloudInit defines options related to the bootstrapping systems where
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinetemplates.yaml
@@ -560,6 +560,17 @@ spec:
                         description: CapacityReservationID specifies the target Capacity
                           Reservation into which the instance should be launched.
                         type: string
+                      capacityReservationPreference:
+                        description: |-
+                          CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                          "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                          "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                          "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                        enum:
+                        - None
+                        - CapacityReservationsOnly
+                        - Open
+                        type: string
                       cloudInit:
                         description: |-
                           CloudInit defines options related to the bootstrapping systems where
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmanagedmachinepools.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_awsmanagedmachinepools.yaml
@@ -653,6 +653,17 @@ spec:
                     description: CapacityReservationID specifies the target Capacity
                       Reservation into which the instance should be launched.
                     type: string
+                  capacityReservationPreference:
+                    description: |-
+                      CapacityReservationPreference specifies the preference for use of Capacity Reservations by the instance. Valid values include:
+                      "Open" (default): The instance may make make use of open Capacity Reservations that match its AZ and InstanceType
+                      "None": The instance may not make use of any Capacity Reservations. This is to conserve open reservations for desired workloads
+                      "CapacityReservationsOnly": The instance will only run if matched or targeted to a Capacity Reservation
+                    enum:
+                    - None
+                    - CapacityReservationsOnly
+                    - Open
+                    type: string
                   iamInstanceProfile:
                     description: |-
                       The name or the Amazon Resource Name (ARN) of the instance profile associated
diff --git a/exp/api/v1beta1/conversion.go b/exp/api/v1beta1/conversion.go
@@ -72,6 +72,10 @@ func (src *AWSMachinePool) ConvertTo(dstRaw conversion.Hub) error {
 		dst.Spec.AWSLaunchTemplate.MarketType = restored.Spec.AWSLaunchTemplate.MarketType
 	}
 
+	if preference := restored.Spec.AWSLaunchTemplate.CapacityReservationPreference; preference != "" {
+		dst.Spec.AWSLaunchTemplate.CapacityReservationPreference = preference
+	}
+
 	dst.Spec.DefaultInstanceWarmup = restored.Spec.DefaultInstanceWarmup
 	dst.Spec.AWSLaunchTemplate.NonRootVolumes = restored.Spec.AWSLaunchTemplate.NonRootVolumes
 	return nil
@@ -130,6 +134,10 @@ func (src *AWSManagedMachinePool) ConvertTo(dstRaw conversion.Hub) error {
 		if restored.Spec.AWSLaunchTemplate.MarketType != "" {
 			dst.Spec.AWSLaunchTemplate.MarketType = restored.Spec.AWSLaunchTemplate.MarketType
 		}
+
+		if preference := restored.Spec.AWSLaunchTemplate.CapacityReservationPreference; preference != "" {
+			dst.Spec.AWSLaunchTemplate.CapacityReservationPreference = preference
+		}
 	}
 	if restored.Spec.AvailabilityZoneSubnetType != nil {
 		dst.Spec.AvailabilityZoneSubnetType = restored.Spec.AvailabilityZoneSubnetType
diff --git a/exp/api/v1beta1/zz_generated.conversion.go b/exp/api/v1beta1/zz_generated.conversion.go
diff --git a/exp/api/v1beta2/awsmachinepool_webhook.go b/exp/api/v1beta2/awsmachinepool_webhook.go
@@ -211,6 +211,7 @@ func (*AWSMachinePoolWebhook) ValidateCreate(_ context.Context, obj runtime.Obje
 	allErrs = append(allErrs, r.validateSpotInstances()...)
 	allErrs = append(allErrs, r.validateRefreshPreferences()...)
 	allErrs = append(allErrs, r.validateInstanceMarketType()...)
+	allErrs = append(allErrs, r.validateCapacityReservation()...)
 	allErrs = append(allErrs, r.validateLifecycleHooks()...)
 	allErrs = append(allErrs, r.validateIgnition()...)
 
@@ -225,6 +226,16 @@ func (*AWSMachinePoolWebhook) ValidateCreate(_ context.Context, obj runtime.Obje
 	)
 }
 
+func (r *AWSMachinePool) validateCapacityReservation() field.ErrorList {
+	var allErrs field.ErrorList
+	if r.Spec.AWSLaunchTemplate.CapacityReservationID != nil &&
+		r.Spec.AWSLaunchTemplate.CapacityReservationPreference != infrav1.CapacityReservationPreferenceOnly &&
+		r.Spec.AWSLaunchTemplate.CapacityReservationPreference != "" {
+		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "capacityReservationPreference"), "when a reservation ID is specified, capacityReservationPreference may only be `capacity-reservations-only` or empty"))
+	}
+	return allErrs
+}
+
 func (r *AWSMachinePool) validateInstanceMarketType() field.ErrorList {
 	var allErrs field.ErrorList
 	if r.Spec.AWSLaunchTemplate.MarketType == infrav1.MarketTypeCapacityBlock && r.Spec.AWSLaunchTemplate.SpotMarketOptions != nil {
diff --git a/exp/api/v1beta2/awsmachinepool_webhook_test.go b/exp/api/v1beta2/awsmachinepool_webhook_test.go
@@ -303,7 +303,18 @@ func TestAWSMachinePoolValidateCreate(t *testing.T) {
 			},
 			wantErrToContain: ptr.To("cannot be set to when CapacityReservationID is specified"),
 		},
-
+		{
+			name: "with CapacityReservationPreference of `none` and CapacityReservationID is specified",
+			pool: &AWSMachinePool{
+				Spec: AWSMachinePoolSpec{
+					AWSLaunchTemplate: AWSLaunchTemplate{
+						CapacityReservationID:         aws.String("cr-123"),
+						CapacityReservationPreference: infrav1.CapacityReservationPreferenceNone,
+					},
+				},
+			},
+			wantErrToContain: ptr.To("when a reservation ID is specified, capacityReservationPreference may only be `capacity-reservations-only` or empty"),
+		},
 		{
 			name: "invalid, MarketType set to MarketTypeCapacityBlock and spotMarketOptions are specified",
 			pool: &AWSMachinePool{
diff --git a/exp/api/v1beta2/types.go b/exp/api/v1beta2/types.go
diff --git a/pkg/cloud/services/ec2/instances.go b/pkg/cloud/services/ec2/instances.go
diff --git a/pkg/cloud/services/ec2/instances_test.go b/pkg/cloud/services/ec2/instances_test.go
diff --git a/pkg/cloud/services/ec2/launchtemplate.go b/pkg/cloud/services/ec2/launchtemplate.go
diff --git a/pkg/cloud/services/ec2/launchtemplate_test.go b/pkg/cloud/services/ec2/launchtemplate_test.go

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ func (src *AWSCluster) ConvertTo(dstRaw conversion.Hub) error {`
`65`	`65`	`dst.Status.Bastion.MarketType = restored.Status.Bastion.MarketType`
`66`	`66`	`dst.Status.Bastion.HostAffinity = restored.Status.Bastion.HostAffinity`
`67`	`67`	`dst.Status.Bastion.HostID = restored.Status.Bastion.HostID`
	`68`	`+ dst.Status.Bastion.CapacityReservationPreference = restored.Status.Bastion.CapacityReservationPreference`
`68`	`69`	`}`
`69`	`70`	`dst.Spec.Partition = restored.Spec.Partition`
`70`	`71`