Add PlacementGroupName and PlacementGroupPartition to AWSLaunchTemplate

This change adds support for specifying placement group configuration
in AWSMachinePool launch templates.

New fields added to AWSLaunchTemplate:
- PlacementGroupName: specifies the name of the placement group in
  which to launch instances
- PlacementGroupPartition: specifies the partition number within a
  partition placement group (valid values: 1-7)

This enables users to target specific partitions when using partition
placement groups with MachinePool resources, providing higher levels
of availability by ensuring instances in different partitions do not
share underlying hardware.

Relates-to: #4870

Author: justinmir

exp/api/v1beta2/types.go

@@ -134,6 +134,18 @@ type AWSLaunchTemplate struct {
 	// +optional
 	PrivateDNSName *infrav1.PrivateDNSName `json:"privateDnsName,omitempty"`
 
+	// PlacementGroupName specifies the name of the placement group in which to launch the instance.
+	// +optional
+	PlacementGroupName string `json:"placementGroupName,omitempty"`
+
+	// PlacementGroupPartition is the partition number within the placement group in which to launch the instance.
+	// This value is only valid if the placement group, referred in `PlacementGroupName`, was created with
+	// strategy set to partition.
+	// +kubebuilder:validation:Minimum:=1
+	// +kubebuilder:validation:Maximum:=7
+	// +optional
+	PlacementGroupPartition int64 `json:"placementGroupPartition,omitempty"`
+
 	// CapacityReservationID specifies the target Capacity Reservation into which the instance should be launched.
 	// +optional
 	CapacityReservationID *string `json:"capacityReservationId,omitempty"`

pkg/cloud/services/ec2/launchtemplate.go

@@ -674,6 +674,7 @@ func (s *Service) createLaunchTemplateData(scope scope.LaunchTemplateScope, imag
 	data.InstanceMarketOptions = instanceMarketOptions
 	data.PrivateDnsNameOptions = getLaunchTemplatePrivateDNSNameOptionsRequest(scope.GetLaunchTemplate().PrivateDNSName)
 	data.CapacityReservationSpecification = getLaunchTemplateCapacityReservationSpecification(scope.GetLaunchTemplate())
+	data.Placement = getLaunchTemplatePlacementRequest(scope.GetLaunchTemplate())
 
 	blockDeviceMappings := []types.LaunchTemplateBlockDeviceMappingRequest{}
 
@@ -724,6 +725,30 @@ func getLaunchTemplateCapacityReservationSpecification(awsLaunchTemplate *expinf
 	return spec
 }
 
+func getLaunchTemplatePlacementRequest(awsLaunchTemplate *expinfrav1.AWSLaunchTemplate) *types.LaunchTemplatePlacementRequest {
+	if awsLaunchTemplate == nil {
+		return nil
+	}
+	if awsLaunchTemplate.PlacementGroupName == "" && awsLaunchTemplate.PlacementGroupPartition == 0 {
+		return nil
+	}
+
+	// PlacementGroupPartition without PlacementGroupName is invalid
+	if awsLaunchTemplate.PlacementGroupName == "" && awsLaunchTemplate.PlacementGroupPartition != 0 {
+		return nil
+	}
+
+	placement := &types.LaunchTemplatePlacementRequest{
+		GroupName: aws.String(awsLaunchTemplate.PlacementGroupName),
+	}
+
+	if awsLaunchTemplate.PlacementGroupPartition != 0 {
+		placement.PartitionNumber = utils.ToInt32Pointer(&awsLaunchTemplate.PlacementGroupPartition)
+	}
+
+	return placement
+}
+
 func volumeToLaunchTemplateBlockDeviceMappingRequest(v *infrav1.Volume) *types.LaunchTemplateBlockDeviceMappingRequest {
 	ltEbsDevice := &types.LaunchTemplateEbsBlockDeviceRequest{
 		DeleteOnTermination: aws.Bool(true),

pkg/cloud/services/ec2/launchtemplate_test.go

@@ -1444,6 +1444,7 @@ var LaunchTemplateVersionIgnoreUnexported = cmpopts.IgnoreUnexported(
 	ec2types.LaunchTemplateIamInstanceProfileSpecificationRequest{},
 	ec2types.LaunchTemplateSpotMarketOptionsRequest{},
 	ec2types.LaunchTemplateInstanceMarketOptionsRequest{},
+	ec2types.LaunchTemplatePlacementRequest{},
 	ec2types.Tag{},
 	ec2types.LaunchTemplateTagSpecificationRequest{},
 	ec2types.RequestLaunchTemplateData{},
@@ -1642,6 +1643,116 @@ func TestCreateLaunchTemplateVersion(t *testing.T) {
 					})
 			},
 		},
+		{
+			name:                 "Should successfully create launch template version with placement group name",
+			awsResourceReference: []infrav1.AWSResourceReference{{ID: aws.String("1")}},
+			mpScopeUpdater: func(mps *scope.MachinePoolScope) {
+				spec := mps.AWSMachinePool.Spec
+				spec.AWSLaunchTemplate.PlacementGroupName = "my-placement-group"
+				spec.AWSLaunchTemplate.SpotMarketOptions = nil
+				mps.AWSMachinePool.Spec = spec
+			},
+			expect: func(m *mocks.MockEC2APIMockRecorder) {
+				sgMap := make(map[infrav1.SecurityGroupRole]infrav1.SecurityGroup)
+				sgMap[infrav1.SecurityGroupNode] = infrav1.SecurityGroup{ID: "1"}
+				sgMap[infrav1.SecurityGroupLB] = infrav1.SecurityGroup{ID: "2"}
+
+				expectedInput := &ec2.CreateLaunchTemplateVersionInput{
+					LaunchTemplateData: &ec2types.RequestLaunchTemplateData{
+						InstanceType: ec2types.InstanceTypeT3Large,
+						IamInstanceProfile: &ec2types.LaunchTemplateIamInstanceProfileSpecificationRequest{
+							Name: aws.String("instance-profile"),
+						},
+						KeyName:          aws.String("default"),
+						UserData:         ptr.To[string](base64.StdEncoding.EncodeToString(userData)),
+						SecurityGroupIds: []string{"nodeSG", "lbSG", "1"},
+						ImageId:          aws.String("imageID"),
+						Placement: &ec2types.LaunchTemplatePlacementRequest{
+							GroupName: aws.String("my-placement-group"),
+						},
+						TagSpecifications: []ec2types.LaunchTemplateTagSpecificationRequest{
+							{
+								ResourceType: ec2types.ResourceTypeInstance,
+								Tags:         defaultEC2AndDataTags("aws-mp-name", "cluster-name", userDataSecretKey, testBootstrapDataHash),
+							},
+							{
+								ResourceType: ec2types.ResourceTypeVolume,
+								Tags:         defaultEC2Tags("aws-mp-name", "cluster-name"),
+							},
+						},
+					},
+					LaunchTemplateId: aws.String("launch-template-id"),
+				}
+				m.CreateLaunchTemplateVersion(context.TODO(), gomock.AssignableToTypeOf(expectedInput)).Return(&ec2.CreateLaunchTemplateVersionOutput{
+					LaunchTemplateVersion: &ec2types.LaunchTemplateVersion{
+						LaunchTemplateId: aws.String("launch-template-id"),
+					},
+				}, nil).Do(
+					func(ctx context.Context, arg *ec2.CreateLaunchTemplateVersionInput, requestOptions ...ec2.Options) {
+						// formatting added to match tags slice during cmp.Equal()
+						formatTagsInput(arg)
+						if !cmp.Equal(expectedInput, arg, LaunchTemplateVersionIgnoreUnexported) {
+							t.Fatalf("mismatch in input expected: %+v, but got %+v, diff: %s", expectedInput, arg, cmp.Diff(expectedInput, arg, LaunchTemplateVersionIgnoreUnexported))
+						}
+					})
+			},
+		},
+		{
+			name:                 "Should successfully create launch template version with placement group name and partition",
+			awsResourceReference: []infrav1.AWSResourceReference{{ID: aws.String("1")}},
+			mpScopeUpdater: func(mps *scope.MachinePoolScope) {
+				spec := mps.AWSMachinePool.Spec
+				spec.AWSLaunchTemplate.PlacementGroupName = "my-partition-placement-group"
+				spec.AWSLaunchTemplate.PlacementGroupPartition = 3
+				spec.AWSLaunchTemplate.SpotMarketOptions = nil
+				mps.AWSMachinePool.Spec = spec
+			},
+			expect: func(m *mocks.MockEC2APIMockRecorder) {
+				sgMap := make(map[infrav1.SecurityGroupRole]infrav1.SecurityGroup)
+				sgMap[infrav1.SecurityGroupNode] = infrav1.SecurityGroup{ID: "1"}
+				sgMap[infrav1.SecurityGroupLB] = infrav1.SecurityGroup{ID: "2"}
+
+				expectedInput := &ec2.CreateLaunchTemplateVersionInput{
+					LaunchTemplateData: &ec2types.RequestLaunchTemplateData{
+						InstanceType: ec2types.InstanceTypeT3Large,
+						IamInstanceProfile: &ec2types.LaunchTemplateIamInstanceProfileSpecificationRequest{
+							Name: aws.String("instance-profile"),
+						},
+						KeyName:          aws.String("default"),
+						UserData:         ptr.To[string](base64.StdEncoding.EncodeToString(userData)),
+						SecurityGroupIds: []string{"nodeSG", "lbSG", "1"},
+						ImageId:          aws.String("imageID"),
+						Placement: &ec2types.LaunchTemplatePlacementRequest{
+							GroupName:       aws.String("my-partition-placement-group"),
+							PartitionNumber: aws.Int32(3),
+						},
+						TagSpecifications: []ec2types.LaunchTemplateTagSpecificationRequest{
+							{
+								ResourceType: ec2types.ResourceTypeInstance,
+								Tags:         defaultEC2AndDataTags("aws-mp-name", "cluster-name", userDataSecretKey, testBootstrapDataHash),
+							},
+							{
+								ResourceType: ec2types.ResourceTypeVolume,
+								Tags:         defaultEC2Tags("aws-mp-name", "cluster-name"),
+							},
+						},
+					},
+					LaunchTemplateId: aws.String("launch-template-id"),
+				}
+				m.CreateLaunchTemplateVersion(context.TODO(), gomock.AssignableToTypeOf(expectedInput)).Return(&ec2.CreateLaunchTemplateVersionOutput{
+					LaunchTemplateVersion: &ec2types.LaunchTemplateVersion{
+						LaunchTemplateId: aws.String("launch-template-id"),
+					},
+				}, nil).Do(
+					func(ctx context.Context, arg *ec2.CreateLaunchTemplateVersionInput, requestOptions ...ec2.Options) {
+						// formatting added to match tags slice during cmp.Equal()
+						formatTagsInput(arg)
+						if !cmp.Equal(expectedInput, arg, LaunchTemplateVersionIgnoreUnexported) {
+							t.Fatalf("mismatch in input expected: %+v, but got %+v, diff: %s", expectedInput, arg, cmp.Diff(expectedInput, arg, LaunchTemplateVersionIgnoreUnexported))
+						}
+					})
+			},
+		},
 		{
 			name:                 "Should return error if AWS failed during launch template version creation",
 			awsResourceReference: []infrav1.AWSResourceReference{{ID: aws.String("1")}},
@@ -2192,3 +2303,57 @@ func TestDeleteLaunchTemplateVersion(t *testing.T) {
 		})
 	}
 }
+
+func TestGetLaunchTemplatePlacementRequest(t *testing.T) {
+	testCases := []struct {
+		name     string
+		input    *expinfrav1.AWSLaunchTemplate
+		expected *ec2types.LaunchTemplatePlacementRequest
+	}{
+		{
+			name:     "nil launch template returns nil",
+			input:    nil,
+			expected: nil,
+		},
+		{
+			name:     "empty placement group name and partition returns nil",
+			input:    &expinfrav1.AWSLaunchTemplate{},
+			expected: nil,
+		},
+		{
+			name: "placement group partition without name returns nil",
+			input: &expinfrav1.AWSLaunchTemplate{
+				PlacementGroupPartition: 3,
+			},
+			expected: nil,
+		},
+		{
+			name: "placement group name only returns group name",
+			input: &expinfrav1.AWSLaunchTemplate{
+				PlacementGroupName: "my-placement-group",
+			},
+			expected: &ec2types.LaunchTemplatePlacementRequest{
+				GroupName: aws.String("my-placement-group"),
+			},
+		},
+		{
+			name: "placement group name with partition returns both",
+			input: &expinfrav1.AWSLaunchTemplate{
+				PlacementGroupName:      "my-partition-pg",
+				PlacementGroupPartition: 5,
+			},
+			expected: &ec2types.LaunchTemplatePlacementRequest{
+				GroupName:       aws.String("my-partition-pg"),
+				PartitionNumber: aws.Int32(5),
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			g := NewWithT(t)
+			result := getLaunchTemplatePlacementRequest(tc.input)
+			g.Expect(result).To(Equal(tc.expected))
+		})
+	}
+}