feat: Support AWS PlacementGroups (#1219)

This allows for specifying PlacementGroup name allowing for
different strategies (configured in the pre-created PlacementGroup),
including `Partition` which provides increased resilience to
underlying hardware failure.

Author: jimmidyson

api/v1alpha1/aws_node_types.go

@@ -38,10 +38,22 @@ type AWSGenericNodeSpec struct {
 
 	// +kubebuilder:validation:Optional
 	AdditionalSecurityGroups AdditionalSecurityGroup `json:"additionalSecurityGroups,omitempty"`
+
+	// PlacementGroup specifies the placement group in which to launch the instance.
+	// +kubebuilder:validation:Optional
+	PlacementGroup *PlacementGroup `json:"placementGroupName,omitempty"`
 }
 
 type AdditionalSecurityGroup []SecurityGroup
 
+type PlacementGroup struct {
+	// Name is the name of the placement group.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=255
+	Name string `json:"name"`
+}
+
 type SecurityGroup struct {
 	// ID is the id of the security group
 	// +kubebuilder:validation:Optional

api/v1alpha1/crds/caren.nutanix.com_awsclusterconfigs.yaml

@@ -390,6 +390,17 @@ spec:
                         instanceType:
                           default: m5.xlarge
                           type: string
+                        placementGroupName:
+                          description: PlacementGroup specifies the placement group in which to launch the instance.
+                          properties:
+                            name:
+                              description: Name is the name of the placement group.
+                              maxLength: 255
+                              minLength: 1
+                              type: string
+                          required:
+                            - name
+                          type: object
                       type: object
                     nodeRegistration:
                       default: {}

api/v1alpha1/crds/caren.nutanix.com_awsworkernodeconfigs.yaml

@@ -89,6 +89,18 @@ spec:
                     default: m5.2xlarge
                     description: The AWS instance type to use for the cluster Machines.
                     type: string
+                  placementGroupName:
+                    description: PlacementGroup specifies the placement group in which
+                      to launch the instance.
+                    properties:
+                      name:
+                        description: Name is the name of the placement group.
+                        maxLength: 255
+                        minLength: 1
+                        type: string
+                    required:
+                    - name
+                    type: object
                 type: object
               nodeRegistration:
                 default: {}

api/v1alpha1/zz_generated.deepcopy.go

@@ -14,6 +14,7 @@ import (
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/iaminstanceprofile"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/instancetype"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/network"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/placementgroup"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/region"
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/aws/mutation/securitygroups"
 	genericmutation "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/generic/mutation"
@@ -30,6 +31,7 @@ func MetaPatchHandler(mgr manager.Manager) handlers.Named {
 		instancetype.NewControlPlanePatch(),
 		ami.NewControlPlanePatch(),
 		securitygroups.NewControlPlanePatch(),
+		placementgroup.NewControlPlanePatch(),
 	}
 	patchHandlers = append(patchHandlers, genericmutation.MetaMutators(mgr)...)
 	patchHandlers = append(patchHandlers, genericmutation.ControlPlaneMetaMutators()...)
@@ -48,6 +50,7 @@ func MetaWorkerPatchHandler(mgr manager.Manager) handlers.Named {
 		instancetype.NewWorkerPatch(),
 		ami.NewWorkerPatch(),
 		securitygroups.NewWorkerPatch(),
+		placementgroup.NewWorkerPatch(),
 	}
 	patchHandlers = append(patchHandlers, genericmutation.WorkerMetaMutators()...)
 

pkg/handlers/aws/mutation/metapatch_handler.go

@@ -0,0 +1,106 @@
+// Copyright 2023 Nutanix. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package placementgroup
+
+import (
+	"context"
+
+	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
+	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	capav1 "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/external/sigs.k8s.io/cluster-api-provider-aws/v2/api/v1beta2"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/handlers/mutation"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/patches"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/patches/selectors"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/variables"
+)
+
+const (
+	// VariableName is the external patch variable name.
+	VariableName = "placementGroup"
+)
+
+type awsPlacementGroupControlPlanePatchHandler struct {
+	variableName      string
+	variableFieldPath []string
+}
+
+func NewControlPlanePatch() *awsPlacementGroupControlPlanePatchHandler {
+	return newAWSPlacementGroupControlPlanePatchHandler(
+		v1alpha1.ClusterConfigVariableName,
+		v1alpha1.ControlPlaneConfigVariableName,
+		v1alpha1.AWSVariableName,
+		VariableName,
+	)
+}
+
+func newAWSPlacementGroupControlPlanePatchHandler(
+	variableName string,
+	variableFieldPath ...string,
+) *awsPlacementGroupControlPlanePatchHandler {
+	return &awsPlacementGroupControlPlanePatchHandler{
+		variableName:      variableName,
+		variableFieldPath: variableFieldPath,
+	}
+}
+
+func (h *awsPlacementGroupControlPlanePatchHandler) Mutate(
+	ctx context.Context,
+	obj *unstructured.Unstructured,
+	vars map[string]apiextensionsv1.JSON,
+	holderRef runtimehooksv1.HolderReference,
+	_ client.ObjectKey,
+	_ mutation.ClusterGetter,
+) error {
+	log := ctrl.LoggerFrom(ctx).WithValues(
+		"holderRef", holderRef,
+	)
+
+	placementGroupVar, err := variables.Get[v1alpha1.PlacementGroup](
+		vars,
+		h.variableName,
+		h.variableFieldPath...,
+	)
+	if err != nil {
+		if variables.IsNotFoundError(err) {
+			log.V(5).Info("AWS placement group variable for control-plane not defined")
+			return nil
+		}
+		return err
+	}
+
+	log = log.WithValues(
+		"variableName",
+		h.variableName,
+		"variableFieldPath",
+		h.variableFieldPath,
+		"variableValue",
+		placementGroupVar,
+	)
+
+	return patches.MutateIfApplicable(
+		obj,
+		vars,
+		&holderRef,
+		selectors.InfrastructureControlPlaneMachines(
+			"v1beta2",
+			"AWSMachineTemplate",
+		),
+		log,
+		func(obj *capav1.AWSMachineTemplate) error {
+			log.WithValues(
+				"patchedObjectKind", obj.GetObjectKind().GroupVersionKind().String(),
+				"patchedObjectName", client.ObjectKeyFromObject(obj),
+			).Info("setting placement group in control plane AWSMachineTemplate spec")
+
+			obj.Spec.Template.Spec.PlacementGroupName = placementGroupVar.Name
+
+			return nil
+		},
+	)
+}

pkg/handlers/aws/mutation/placementgroup/inject_control_plane.go

@@ -0,0 +1,61 @@
+// Copyright 2023 Nutanix. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package placementgroup
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	"github.com/onsi/gomega"
+	runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
+
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/handlers/mutation"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/common/pkg/testutils/capitest"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/internal/test/request"
+	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/test/helpers"
+)
+
+var _ = Describe("Generate PlacementGroup patches for ControlPlane", func() {
+	patchGenerator := func() mutation.GeneratePatches {
+		return mutation.NewMetaGeneratePatchesHandler(
+			"",
+			helpers.TestEnv.Client,
+			NewControlPlanePatch(),
+		).(mutation.GeneratePatches)
+	}
+
+	testDefs := []capitest.PatchTestDef{
+		{
+			Name: "unset variable",
+		},
+		{
+			Name: "placement group for controlplane set",
+			Vars: []runtimehooksv1.Variable{
+				capitest.VariableWithValue(
+					v1alpha1.ClusterConfigVariableName,
+					v1alpha1.PlacementGroup{Name: "pg-1234"},
+					v1alpha1.ControlPlaneConfigVariableName,
+					v1alpha1.AWSVariableName,
+					VariableName,
+				),
+			},
+			RequestItem: request.NewCPAWSMachineTemplateRequestItem("1234"),
+			ExpectedPatchMatchers: []capitest.JSONPatchMatcher{{
+				Operation:    "add",
+				Path:         "/spec/template/spec/placementGroupName",
+				ValueMatcher: gomega.Equal("pg-1234"),
+			}},
+		},
+	}
+
+	// create test node for each case
+	for _, tt := range testDefs {
+		It(tt.Name, func() {
+			capitest.AssertGeneratePatches(
+				GinkgoT(),
+				patchGenerator,
+				&tt,
+			)
+		})
+	}
+})

pkg/handlers/aws/mutation/placementgroup/inject_control_plane_test.go

@@ -0,0 +1,16 @@
+// Copyright 2023 Nutanix. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package placementgroup
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestInstanceTypePatch(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "PlacementGroup patches for ControlPlane and Workers suite")
+}