feat: support OSDisk.DiffDiskPlacement

api/v1beta1/azuremachine_validation.go

@@ -19,6 +19,8 @@ package v1beta1
 import (
 	"encoding/base64"
 	"fmt"
+	"slices"
+	"strings"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
 	"github.com/google/uuid"
@@ -248,6 +250,26 @@ func ValidateOSDisk(osDisk OSDisk, fieldPath *field.Path) field.ErrorList {
 			"diskEncryptionSet is not supported when diffDiskSettings.option is 'Local'",
 		))
 	}
+	if osDisk.DiffDiskSettings != nil && osDisk.DiffDiskSettings.Placement != nil {
+		if osDisk.DiffDiskSettings.Option != string(armcompute.DiffDiskOptionsLocal) {
+			allErrs = append(allErrs, field.Invalid(
+				fieldPath.Child("diffDiskSettings"),
+				osDisk.DiffDiskSettings,
+				"placement is only supported when diffDiskSettings.option is 'Local'",
+			))
+		}
+		if !slices.Contains(PossibleDiffDiskPlacementValues(), *osDisk.DiffDiskSettings.Placement) {
+			options := make([]string, len(PossibleDiffDiskPlacementValues()))
+			for i, value := range PossibleDiffDiskPlacementValues() {
+				options[i] = string(value)
+			}
+			allErrs = append(allErrs, field.Invalid(
+				fieldPath.Child("diffDiskSettings").Child("placement"),
+				osDisk.DiffDiskSettings.Placement,
+				"placement must be one of "+strings.Join(options, ","),
+			))
+		}
+	}
 
 	return allErrs
 }

api/v1beta1/azuremachine_validation_test.go

@@ -109,6 +109,53 @@ func TestAzureMachine_ValidateOSDisk(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:    "valid resourceDisk placement spec with option local",
+			wantErr: false,
+			osDisk: OSDisk{
+				DiskSizeGB:  ptr.To[int32](30),
+				CachingType: "None",
+				OSType:      "blah",
+				DiffDiskSettings: &DiffDiskSettings{
+					Option:    string(armcompute.DiffDiskOptionsLocal),
+					Placement: ptr.To(DiffDiskPlacementResourceDisk),
+				},
+				ManagedDisk: &ManagedDiskParameters{
+					StorageAccountType: "Standard_LRS",
+				},
+			},
+		},
+		{
+			name:    "valid resourceDisk placement spec requires option local",
+			wantErr: true,
+			osDisk: OSDisk{
+				DiskSizeGB:  ptr.To[int32](30),
+				CachingType: "None",
+				OSType:      "blah",
+				DiffDiskSettings: &DiffDiskSettings{
+					Placement: ptr.To(DiffDiskPlacementResourceDisk),
+				},
+				ManagedDisk: &ManagedDiskParameters{
+					StorageAccountType: "Standard_LRS",
+				},
+			},
+		},
+		{
+			name:    "invalid resourceDisk placement spec",
+			wantErr: true,
+			osDisk: OSDisk{
+				DiskSizeGB:  ptr.To[int32](30),
+				CachingType: "None",
+				OSType:      "blah",
+				DiffDiskSettings: &DiffDiskSettings{
+					Option:    string(armcompute.DiffDiskOptionsLocal),
+					Placement: ptr.To(DiffDiskPlacement("invalidDisk")),
+				},
+				ManagedDisk: &ManagedDiskParameters{
+					StorageAccountType: "Standard_LRS",
+				},
+			},
+		},
 		{
 			name:    "byoc encryption with ephemeral os disk spec",
 			wantErr: true,

api/v1beta1/types.go

@@ -687,12 +687,45 @@ type DiskEncryptionSetParameters struct {
 	ID string `json:"id,omitempty"`
 }
 
+// DiffDiskPlacement - Specifies the ephemeral disk placement for operating system disk. This property can be used by user
+// in the request to choose the location i.e, cache disk, resource disk or nvme disk space for
+// Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS
+// disk size requirements for Windows VM at
+// https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at
+// https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.
+type DiffDiskPlacement string
+
+const (
+	// DiffDiskPlacementCacheDisk places the OsDisk on cache disk.
+	DiffDiskPlacementCacheDisk DiffDiskPlacement = "CacheDisk"
+
+	// DiffDiskPlacementNvmeDisk places the OsDisk on NVMe disk.
+	DiffDiskPlacementNvmeDisk DiffDiskPlacement = "NvmeDisk"
+
+	// DiffDiskPlacementResourceDisk places the OsDisk on temp disk.
+	DiffDiskPlacementResourceDisk DiffDiskPlacement = "ResourceDisk"
+)
+
+// PossibleDiffDiskPlacementValues returns the possible values for the DiffDiskPlacement const type.
+func PossibleDiffDiskPlacementValues() []DiffDiskPlacement {
+	return []DiffDiskPlacement{
+		DiffDiskPlacementCacheDisk,
+		DiffDiskPlacementNvmeDisk,
+		DiffDiskPlacementResourceDisk,
+	}
+}
+
 // DiffDiskSettings describe ephemeral disk settings for the os disk.
 type DiffDiskSettings struct {
 	// Option enables ephemeral OS when set to "Local"
 	// See https://learn.microsoft.com/azure/virtual-machines/ephemeral-os-disks for full details
 	// +kubebuilder:validation:Enum=Local
 	Option string `json:"option"`
+
+	// Placement specifies the ephemeral disk placement for operating system disk. If placement is specified, Option must be set to "Local".
+	// +kubebuilder:validation:Enum=CacheDisk;NvmeDisk;ResourceDisk
+	// +optional
+	Placement *DiffDiskPlacement `json:"placement,omitempty"`
 }
 
 // SubnetRole defines the unique role of a subnet.

azure/converters/spotinstances_test.go

@@ -93,6 +93,21 @@ func TestGetSpotVMOptions(t *testing.T) {
 				billingProfile:        nil,
 			},
 		},
+		{
+			name: "spot with ResourceDisk",
+			spot: &infrav1.SpotVMOptions{
+				MaxPrice: nil,
+			},
+			diffDiskSettings: &infrav1.DiffDiskSettings{
+				Option:    string(armcompute.DiffDiskOptionsLocal),
+				Placement: ptr.To(infrav1.DiffDiskPlacementResourceDisk),
+			},
+			want: resultParams{
+				vmPriorityTypes:       ptr.To(armcompute.VirtualMachinePriorityTypesSpot),
+				vmEvictionPolicyTypes: nil,
+				billingProfile:        nil,
+			},
+		},
 		{
 			name: "spot with eviction policy",
 			spot: &infrav1.SpotVMOptions{

azure/services/scalesets/spec.go

@@ -391,6 +391,10 @@ func (s *ScaleSetSpec) generateStorageProfile(ctx context.Context) (*armcompute.
 		storageProfile.OSDisk.DiffDiskSettings = &armcompute.DiffDiskSettings{
 			Option: ptr.To(armcompute.DiffDiskOptions(s.OSDisk.DiffDiskSettings.Option)),
 		}
+
+		if s.OSDisk.DiffDiskSettings.Placement != nil {
+			storageProfile.OSDisk.DiffDiskSettings.Placement = ptr.To(armcompute.DiffDiskPlacement(*s.OSDisk.DiffDiskSettings.Placement))
+		}
 	}
 
 	if s.OSDisk.ManagedDisk != nil {

azure/services/scalesets/spec_test.go

@@ -39,6 +39,7 @@ var (
 	customNetworkingSpec, customNetworkingVMSS                                         = getCustomNetworkingVMSS()
 	spotVMSpec, spotVMVMSS                                                             = getSpotVMVMSS()
 	ephemeralSpec, ephemeralVMSS                                                       = getEPHVMSSS()
+	resourceDiskSpec, resourceDiskVMSS                                                 = getResourceDiskVMSS()
 	evictionSpec, evictionVMSS                                                         = getEvictionPolicyVMSS()
 	maxPriceSpec, maxPriceVMSS                                                         = getMaxPriceVMSS()
 	encryptionSpec, encryptionVMSS                                                     = getEncryptionVMSS()
@@ -233,6 +234,32 @@ func getEPHVMSSS() (ScaleSetSpec, armcompute.VirtualMachineScaleSet) {
 	return spec, vmss
 }
 
+func getResourceDiskVMSS() (ScaleSetSpec, armcompute.VirtualMachineScaleSet) {
+	spec := newDefaultVMSSSpec()
+	spec.Size = vmSizeEPH
+	spec.SKU = resourceskus.SKU{
+		Capabilities: []*armcompute.ResourceSKUCapabilities{
+			{
+				Name:  ptr.To(resourceskus.EphemeralOSDisk),
+				Value: ptr.To("True"),
+			},
+		},
+	}
+	spec.SpotVMOptions = &infrav1.SpotVMOptions{}
+	spec.OSDisk.DiffDiskSettings = &infrav1.DiffDiskSettings{
+		Option:    string(armcompute.DiffDiskOptionsLocal),
+		Placement: ptr.To(infrav1.DiffDiskPlacementResourceDisk),
+	}
+	vmss := newDefaultVMSS(vmSizeEPH)
+	vmss.Properties.VirtualMachineProfile.StorageProfile.OSDisk.DiffDiskSettings = &armcompute.DiffDiskSettings{
+		Option:    ptr.To(armcompute.DiffDiskOptionsLocal),
+		Placement: ptr.To(armcompute.DiffDiskPlacementResourceDisk),
+	}
+	vmss.Properties.VirtualMachineProfile.Priority = ptr.To(armcompute.VirtualMachinePriorityTypesSpot)
+
+	return spec, vmss
+}
+
 func getEvictionPolicyVMSS() (ScaleSetSpec, armcompute.VirtualMachineScaleSet) {
 	spec := newDefaultVMSSSpec()
 	spec.Size = vmSizeEPH
@@ -586,6 +613,13 @@ func TestScaleSetParameters(t *testing.T) {
 			expected:      ephemeralVMSS,
 			expectedError: "",
 		},
+		{
+			name:          "spot vm and ephemeral disk with resourceDisk placement vmss",
+			spec:          resourceDiskSpec,
+			existing:      nil,
+			expected:      resourceDiskVMSS,
+			expectedError: "",
+		},
 		{
 			name:          "spot vm and eviction policy vmss",
 			spec:          evictionSpec,

azure/services/virtualmachines/spec.go

@@ -183,6 +183,7 @@ func (s *VMSpec) generateStorageProfile() (*armcompute.StorageProfile, error) {
 	if !MemoryCapability {
 		return nil, azure.WithTerminalError(errors.New("VM memory should be bigger or equal to at least 2Gi"))
 	}
+
 	// enable ephemeral OS
 	if s.OSDisk.DiffDiskSettings != nil {
 		if !s.SKU.HasCapability(resourceskus.EphemeralOSDisk) {
@@ -192,6 +193,10 @@ func (s *VMSpec) generateStorageProfile() (*armcompute.StorageProfile, error) {
 		storageProfile.OSDisk.DiffDiskSettings = &armcompute.DiffDiskSettings{
 			Option: ptr.To(armcompute.DiffDiskOptions(s.OSDisk.DiffDiskSettings.Option)),
 		}
+
+		if s.OSDisk.DiffDiskSettings.Placement != nil {
+			storageProfile.OSDisk.DiffDiskSettings.Placement = ptr.To(armcompute.DiffDiskPlacement(*s.OSDisk.DiffDiskSettings.Placement))
+		}
 	}
 
 	if s.OSDisk.ManagedDisk != nil {

azure/services/virtualmachines/spec_test.go

@@ -461,6 +461,35 @@ func TestParameters(t *testing.T) {
 			},
 			expectedError: "",
 		},
+		{
+			name: "can create a vm with DiffDiskPlacement ResourceDisk",
+			spec: &VMSpec{
+				Name:       "my-vm",
+				Role:       infrav1.Node,
+				NICIDs:     []string{"my-nic"},
+				SSHKeyData: "fakesshpublickey",
+				Size:       "Standard_D2v3",
+				OSDisk: infrav1.OSDisk{
+					OSType:     "Linux",
+					DiskSizeGB: ptr.To[int32](128),
+					ManagedDisk: &infrav1.ManagedDiskParameters{
+						StorageAccountType: string(armcompute.StorageAccountTypesPremiumLRS),
+					},
+					DiffDiskSettings: &infrav1.DiffDiskSettings{
+						Option:    string(armcompute.DiffDiskOptionsLocal),
+						Placement: ptr.To(infrav1.DiffDiskPlacementResourceDisk),
+					},
+				},
+				Image: &infrav1.Image{ID: ptr.To("fake-image-id")},
+				SKU:   validSKUWithEphemeralOS,
+			},
+			existing: nil,
+			expect: func(g *WithT, result interface{}) {
+				g.Expect(result).To(BeAssignableToTypeOf(armcompute.VirtualMachine{}))
+				g.Expect(result.(armcompute.VirtualMachine).Properties.StorageProfile.OSDisk.DiffDiskSettings.Placement).To(Equal(ptr.To(armcompute.DiffDiskPlacementResourceDisk)))
+			},
+			expectedError: "",
+		},
 		{
 			name: "can create a trusted launch vm",
 			spec: &VMSpec{

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

@@ -578,6 +578,15 @@ spec:
                             enum:
                             - Local
                             type: string
+                          placement:
+                            description: Placement specifies the ephemeral disk placement
+                              for operating system disk. If placement is specified,
+                              Option must be set to "Local".
+                            enum:
+                            - CacheDisk
+                            - NvmeDisk
+                            - ResourceDisk
+                            type: string
                         required:
                         - option
                         type: object

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

@@ -498,6 +498,15 @@ spec:
                         enum:
                         - Local
                         type: string
+                      placement:
+                        description: Placement specifies the ephemeral disk placement
+                          for operating system disk. If placement is specified, Option
+                          must be set to "Local".
+                        enum:
+                        - CacheDisk
+                        - NvmeDisk
+                        - ResourceDisk
+                        type: string
                     required:
                     - option
                     type: object

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

@@ -513,6 +513,15 @@ spec:
                                 enum:
                                 - Local
                                 type: string
+                              placement:
+                                description: Placement specifies the ephemeral disk
+                                  placement for operating system disk. If placement
+                                  is specified, Option must be set to "Local".
+                                enum:
+                                - CacheDisk
+                                - NvmeDisk
+                                - ResourceDisk
+                                type: string
                             required:
                             - option
                             type: object

exp/api/v1beta1/azuremachinepool_default.go

@@ -42,6 +42,7 @@ func (amp *AzureMachinePool) SetDefaults(client client.Client) error {
 	}
 	amp.SetDiagnosticsDefaults()
 	amp.SetNetworkInterfacesDefaults()
+	amp.SetOSDiskDefaults()
 
 	return kerrors.NewAggregate(errs)
 }
@@ -159,3 +160,13 @@ func (amp *AzureMachinePool) SetNetworkInterfacesDefaults() {
 		}
 	}
 }
+
+// SetOSDiskDefaults sets the defaults for the OSDisk.
+func (amp *AzureMachinePool) SetOSDiskDefaults() {
+	if amp.Spec.Template.OSDisk.OSType == "" {
+		amp.Spec.Template.OSDisk.OSType = "Linux"
+	}
+	if amp.Spec.Template.OSDisk.CachingType == "" {
+		amp.Spec.Template.OSDisk.CachingType = "None"
+	}
+}

exp/api/v1beta1/azuremachinepool_default_test.go

@@ -413,6 +413,10 @@ func hardcodedAzureMachinePoolWithSSHKey(sshPublicKey string) *AzureMachinePool
 		Spec: AzureMachinePoolSpec{
 			Template: AzureMachinePoolMachineTemplate{
 				SSHPublicKey: sshPublicKey,
+				OSDisk: infrav1.OSDisk{
+					CachingType: "None",
+					OSType:      "Linux",
+				},
 			},
 		},
 		ObjectMeta: metav1.ObjectMeta{