Add support for placement groups (#13)

Author: Tomy2e

api/v1alpha1/scalewaymachine_types.go

@@ -10,6 +10,7 @@ const MachineFinalizer = "scalewaycluster.infrastructure.cluster.x-k8s.io/sm-pro
 // ScalewayMachineSpec defines the desired state of ScalewayMachine.
 // +kubebuilder:validation:XValidation:rule="has(self.rootVolume) == has(oldSelf.rootVolume)",message="rootVolume cannot be added or removed"
 // +kubebuilder:validation:XValidation:rule="has(self.publicNetwork) == has(oldSelf.publicNetwork)",message="publicNetwork cannot be added or removed"
+// +kubebuilder:validation:XValidation:rule="has(self.placementGroup) == has(oldSelf.placementGroup)",message="placementGroup cannot be added or removed"
 type ScalewayMachineSpec struct {
 	// ProviderID must match the provider ID as seen on the node object corresponding to this machine.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
@@ -34,6 +35,11 @@ type ScalewayMachineSpec struct {
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
 	// +optional
 	PublicNetwork *PublicNetworkSpec `json:"publicNetwork,omitempty"`
+
+	// PlacementGroup allows attaching a Placement Group to the instance.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
+	// +optional
+	PlacementGroup *PlacementGroupSpec `json:"placementGroup,omitempty"`
 }
 
 // RootVolumeSpec defines the characteristics of the system (root) volume.
@@ -66,6 +72,14 @@ type PublicNetworkSpec struct {
 	EnableIPv6 *bool `json:"enableIPv6,omitempty"`
 }
 
+// +kubebuilder:validation:XValidation:rule="(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0) == 1",message="exactly one of id or name must be set"
+type PlacementGroupSpec struct {
+	// ID of the placement group.
+	ID *string `json:"id,omitempty"`
+	// Name of the placement group.
+	Name *string `json:"name,omitempty"`
+}
+
 // ImageSpec contains an ID, Name or Label to use to create the instance.
 // +kubebuilder:validation:XValidation:rule="(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0) + (has(self.label) ? 1 : 0) == 1",message="exactly one of id, name or label must be set"
 type ImageSpec struct {

api/v1alpha1/zz_generated.deepcopy.go

@@ -82,6 +82,22 @@ spec:
                 - message: exactly one of id, name or label must be set
                   rule: '(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0) + (has(self.label)
                     ? 1 : 0) == 1'
+              placementGroup:
+                description: PlacementGroup allows attaching a Placement Group to
+                  the instance.
+                properties:
+                  id:
+                    description: ID of the placement group.
+                    type: string
+                  name:
+                    description: Name of the placement group.
+                    type: string
+                type: object
+                x-kubernetes-validations:
+                - message: Value is immutable
+                  rule: self == oldSelf
+                - message: exactly one of id or name must be set
+                  rule: '(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0) == 1'
               providerID:
                 description: ProviderID must match the provider ID as seen on the
                   node object corresponding to this machine.
@@ -141,6 +157,8 @@ spec:
               rule: has(self.rootVolume) == has(oldSelf.rootVolume)
             - message: publicNetwork cannot be added or removed
               rule: has(self.publicNetwork) == has(oldSelf.publicNetwork)
+            - message: placementGroup cannot be added or removed
+              rule: has(self.placementGroup) == has(oldSelf.placementGroup)
           status:
             description: ScalewayMachineStatus defines the observed state of ScalewayMachine.
             properties:

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

@@ -83,6 +83,23 @@ spec:
                         - message: exactly one of id, name or label must be set
                           rule: '(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0)
                             + (has(self.label) ? 1 : 0) == 1'
+                      placementGroup:
+                        description: PlacementGroup allows attaching a Placement Group
+                          to the instance.
+                        properties:
+                          id:
+                            description: ID of the placement group.
+                            type: string
+                          name:
+                            description: Name of the placement group.
+                            type: string
+                        type: object
+                        x-kubernetes-validations:
+                        - message: Value is immutable
+                          rule: self == oldSelf
+                        - message: exactly one of id or name must be set
+                          rule: '(has(self.id) ? 1 : 0) + (has(self.name) ? 1 : 0)
+                            == 1'
                       providerID:
                         description: ProviderID must match the provider ID as seen
                           on the node object corresponding to this machine.
@@ -144,6 +161,8 @@ spec:
                       rule: has(self.rootVolume) == has(oldSelf.rootVolume)
                     - message: publicNetwork cannot be added or removed
                       rule: has(self.publicNetwork) == has(oldSelf.publicNetwork)
+                    - message: placementGroup cannot be added or removed
+                      rule: has(self.placementGroup) == has(oldSelf.placementGroup)
                 required:
                 - spec
                 type: object

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

@@ -79,7 +79,7 @@ The `image` field must contain one of the following:
     # some fields were omitted...
   ```
 
-  Make sure this image exists in the zones when you plan to deploy your nodes.
+  Make sure this image exists in the zones where you plan to deploy your nodes.
   You can list images by name with this command:
 
   ```bash
@@ -169,3 +169,52 @@ Private Network (`network.privateNetwork.enabled`) in the `ScalewayCluster`.
   connectivity, make sure a Public Gateway advertises its default route in the
   Private Network as nodes will not be able to access the control-plane Load Balancer
   without public connectivity.
+
+## Placement Group
+
+It is possible to attach an existing Placement group to the Instance server that will be created.
+
+> [!WARNING]
+> A Placement group can be attached to at most 20 Instance servers.
+
+Placement groups allow you to define if you want certain Instances to run on
+different physical hypervisors for maximum availability or as physically close
+together as possible for minimum latency. For more information about Placement
+groups, please refer to the [Scaleway documentation](https://www.scaleway.com/en/docs/instances/how-to/use-placement-groups/).
+
+The `placementGroup` field must contain one of the following:
+
+- A Placement group ID:
+
+  ```yaml
+  apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1
+  kind: ScalewayMachine
+  metadata:
+    name: my-machine
+    namespace: default
+  spec:
+    placementGroup:
+      id: 11111111-1111-1111-1111-111111111111
+    # some fields were omitted...
+  ```
+
+- A Placement group name:
+
+  ```yaml
+  apiVersion: infrastructure.cluster.x-k8s.io/v1alpha1
+  kind: ScalewayMachine
+  metadata:
+    name: my-machine
+    namespace: default
+  spec:
+    placementGroup:
+      name: my-placement-group
+    # some fields were omitted...
+  ```
+
+  Make sure this Placement group exists in the zones where you plan to deploy your nodes.
+  You can list Placement groups by name with this command:
+
+  ```bash
+  scw instance placement-group list name=${IMAGE_NAME} zone=${SCW_ZONE}
+  ```

docs/scalewaymachine.md

@@ -50,6 +50,7 @@ func (c *Client) CreateServer(
 	ctx context.Context,
 	zone scw.Zone,
 	name, commercialType, imageID string,
+	placementGroupID *string,
 	rootVolumeSize scw.Size,
 	rootVolumeType instance.VolumeVolumeType,
 	publicIPs, tags []string,
@@ -72,6 +73,7 @@ func (c *Client) CreateServer(
 		CommercialType:    commercialType,
 		DynamicIPRequired: scw.BoolPtr(false),
 		Image:             &imageID,
+		PlacementGroup:    placementGroupID,
 		Volumes: map[string]*instance.VolumeServerTemplate{
 			"0": {
 				Size:       &rootVolumeSize,
@@ -368,3 +370,32 @@ func (c *Client) DeleteServer(ctx context.Context, zone scw.Zone, serverID strin
 
 	return nil
 }
+
+func (c *Client) FindPlacementGroup(ctx context.Context, zone scw.Zone, name string) (*instance.PlacementGroup, error) {
+	if err := c.validateZone(c.instance, zone); err != nil {
+		return nil, err
+	}
+
+	resp, err := c.instance.ListPlacementGroups(&instance.ListPlacementGroupsRequest{
+		Zone:    zone,
+		Name:    &name,
+		Project: &c.projectID,
+	}, scw.WithContext(ctx), scw.WithAllPages())
+	if err != nil {
+		return nil, newCallError("ListPlacementGroups", err)
+	}
+
+	// Filter out all placement groups that have the wrong name.
+	placementGroups := slices.DeleteFunc(resp.PlacementGroups, func(pg *instance.PlacementGroup) bool {
+		return pg.Name != name
+	})
+
+	switch len(placementGroups) {
+	case 0:
+		return nil, ErrNoItemFound
+	case 1:
+		return placementGroups[0], nil
+	default:
+		return nil, fmt.Errorf("%w: found %d placement groups with name %s", ErrTooManyItemsFound, len(placementGroups), name)
+	}
+}

internal/service/scaleway/client/instance.go

@@ -256,13 +256,30 @@ func (s *Service) ensureServer(ctx context.Context) (*instance.Server, error) {
 		}
 	}
 
+	// If user has specified a placement group, get its ID.
+	var placementGroupID *string
+	if s.ScalewayMachine.Spec.PlacementGroup != nil {
+		switch pgref := s.ScalewayMachine.Spec.PlacementGroup; {
+		case pgref.ID != nil:
+			placementGroupID = pgref.ID
+		case pgref.Name != nil:
+			placementGroup, err := s.ScalewayClient.FindPlacementGroup(ctx, zone, *pgref.Name)
+			if err != nil {
+				return nil, fmt.Errorf("failed to find placement group: %w", err)
+			}
+
+			placementGroupID = &placementGroup.ID
+		}
+	}
+
 	// Finally, create the server.
 	server, err := s.ScalewayClient.CreateServer(
 		ctx,
 		zone,
 		s.ResourceName(),
 		s.ScalewayMachine.Spec.CommercialType,
 		imageID,
+		placementGroupID,
 		s.RootVolumeSize(),
 		volumeType,
 		publicIPs,