Merge pull request #1328 from vr4manta/SPLAT-2000

SPLAT-2000: Added vSphere provisioning mode to data disks

Author: openshift-merge-bot[bot]

go.mod

@@ -11,7 +11,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/onsi/ginkgo/v2 v2.22.2
 	github.com/onsi/gomega v1.36.2
-	github.com/openshift/api v0.0.0-20250130171037-7bb8a0201a56
+	github.com/openshift/api v0.0.0-20250218131406-8b82294c5e3a
 	github.com/openshift/client-go v0.0.0-20250125113824-8e1f0b8fa9a7
 	github.com/openshift/cluster-api-actuator-pkg/testutils v0.0.0-20250122171707-86066d47a264
 	github.com/openshift/cluster-control-plane-machine-set-operator v0.0.0-20250128131205-c7b3d7b57a8e

go.sum

@@ -357,8 +357,8 @@ github.com/onsi/ginkgo/v2 v2.22.2 h1:/3X8Panh8/WwhU/3Ssa6rCKqPLuAkVY2I0RoyDLySlU
 github.com/onsi/ginkgo/v2 v2.22.2/go.mod h1:oeMosUL+8LtarXBHu/c0bx2D/K9zyQ6uX3cTyztHwsk=
 github.com/onsi/gomega v1.36.2 h1:koNYke6TVk6ZmnyHrCXba/T/MoLBXFjeC1PtvYgw0A8=
 github.com/onsi/gomega v1.36.2/go.mod h1:DdwyADRjrc825LhMEkD76cHR5+pUnjhUN8GlHlRPHzY=
-github.com/openshift/api v0.0.0-20250130171037-7bb8a0201a56 h1:fWNA66LNXugnaxTaRVHZLdW+vbwyk5vwTT9/x2YYiG8=
-github.com/openshift/api v0.0.0-20250130171037-7bb8a0201a56/go.mod h1:yk60tHAmHhtVpJQo3TwVYq2zpuP70iJIFDCmeKMIzPw=
+github.com/openshift/api v0.0.0-20250218131406-8b82294c5e3a h1:G26rXyn/CoUWkZW/nQS8dhOG9061GxeshAtuJDlwv7Q=
+github.com/openshift/api v0.0.0-20250218131406-8b82294c5e3a/go.mod h1:yk60tHAmHhtVpJQo3TwVYq2zpuP70iJIFDCmeKMIzPw=
 github.com/openshift/client-go v0.0.0-20250125113824-8e1f0b8fa9a7 h1:4iliLcvr1P9EUMZgIaSNEKNQQzBn+L6PSequlFOuB6Q=
 github.com/openshift/client-go v0.0.0-20250125113824-8e1f0b8fa9a7/go.mod h1:2tcufBE4Cu6RNgDCxcUJepa530kGo5GFVfR9BSnndhI=
 github.com/openshift/cluster-api-actuator-pkg/testutils v0.0.0-20250122171707-86066d47a264 h1:KoJiId8Ynajf/ZFodvmayFkDODIL7Vow3LmgR5+oVRg=

pkg/controller/vsphere/reconciler.go

@@ -1245,18 +1245,34 @@ func createDataDisks(s *machineScope, devices object.VirtualDeviceList) ([]types
 	for i, dataDisk := range s.providerSpec.DataDisks {
 		klog.V(2).InfoS("Adding disk", "name", dataDisk.Name, "spec", dataDisk)
 
+		backing := &types.VirtualDiskFlatVer2BackingInfo{
+			DiskMode: string(types.VirtualDiskModePersistent),
+			VirtualDeviceFileBackingInfo: types.VirtualDeviceFileBackingInfo{
+				FileName: "",
+			},
+		}
+
+		// Set provisioning type for the new data disk.
+		// Currently, if ThinProvisioned is not set, GOVC will set default to false.  We may want to change this behavior
+		// to match what template image OS disk has configured to make them match if not set.
+		switch dataDisk.ProvisioningMode {
+		case machinev1.ProvisioningModeThin:
+			backing.ThinProvisioned = types.NewBool(true)
+		case machinev1.ProvisioningModeThick:
+			backing.ThinProvisioned = types.NewBool(false)
+		case machinev1.ProvisioningModeEagerlyZeroed:
+			backing.ThinProvisioned = types.NewBool(false)
+			backing.EagerlyScrub = types.NewBool(true)
+		default:
+			klog.V(2).Infof("No provisioning type detected.  Leaving configuration empty.")
+		}
+
 		dev := &types.VirtualDisk{
 			VirtualDevice: types.VirtualDevice{
 				// Key needs to be unique and cannot match another new disk being added.  So we'll use the index as an
 				// input to NewKey.  NewKey() will always return same value since our new devices are not part of devices yet.
-				Key: devices.NewKey() - int32(i),
-				Backing: &types.VirtualDiskFlatVer2BackingInfo{
-					DiskMode:        string(types.VirtualDiskModePersistent),
-					ThinProvisioned: types.NewBool(true),
-					VirtualDeviceFileBackingInfo: types.VirtualDeviceFileBackingInfo{
-						FileName: "",
-					},
-				},
+				Key:           devices.NewKey() - int32(i),
+				Backing:       backing,
 				ControllerKey: controller.GetVirtualController().Key,
 			},
 			CapacityInKB: int64(dataDisk.SizeGiB) * 1024 * 1024,

pkg/webhooks/machine_webhook.go

@@ -131,6 +131,13 @@ var (
 
 	// vSphereDataDiskNamePattern is used to validate the name of a data disk
 	vSphereDataDiskNamePattern = regexp.MustCompile(`^[a-zA-Z0-9]([-_a-zA-Z0-9]*[a-zA-Z0-9])?$`)
+
+	// validProvisioningModes lists all valid data disk provisioning modes
+	validProvisioningModes = []machinev1beta1.ProvisioningMode{
+		machinev1beta1.ProvisioningModeThin,
+		machinev1beta1.ProvisioningModeThick,
+		machinev1beta1.ProvisioningModeEagerlyZeroed,
+	}
 )
 
 const (
@@ -1571,6 +1578,17 @@ func validateVSphereDataDisks(dataDisks []machinev1beta1.VSphereDisk) field.Erro
 		if disk.SizeGiB > maxVSphereDataDiskSize {
 			errs = append(errs, field.Invalid(diskPath.Child("sizeGiB"), disk.SizeGiB, fmt.Sprintf("data disk size (GiB) must not exceed %d", maxVSphereDataDiskSize)))
 		}
+
+		// Validate provisioning modes
+		if len(disk.ProvisioningMode) > 0 {
+			validModesSet := sets.NewString()
+			for _, m := range validProvisioningModes {
+				validModesSet.Insert(string(m))
+			}
+			if !validModesSet.Has(string(disk.ProvisioningMode)) {
+				errs = append(errs, field.NotSupported(diskPath, disk.ProvisioningMode, validModesSet.List()))
+			}
+		}
 	}
 
 	return errs

pkg/webhooks/machine_webhook_test.go

@@ -4484,6 +4484,43 @@ func TestValidateVSphereProviderSpec(t *testing.T) {
 			}(),
 			expectedError: "providerSpec.disks[0].name: Invalid value: \"Bad #Name\": data disk name must consist only of alphanumeric characters, hyphens and underscores, and must start and end with an alphanumeric character.",
 		},
+		{
+			testCase: "with data disk configured with provisioning mode",
+			modifySpec: func(p *machinev1beta1.VSphereMachineProviderSpec) {
+				p.DataDisks = []machinev1beta1.VSphereDisk{
+					{
+						Name:             "Disk1",
+						SizeGiB:          10,
+						ProvisioningMode: machinev1beta1.ProvisioningModeThin,
+					},
+				}
+			},
+			expectedOk: true,
+			featureGatesEnabled: func() map[string]bool {
+				fg := make(map[string]bool)
+				fg[string(features.FeatureGateVSphereMultiDisk)] = true
+				return fg
+			}(),
+		},
+		{
+			testCase: "with data disk configured with invalid provisioning mode",
+			modifySpec: func(p *machinev1beta1.VSphereMachineProviderSpec) {
+				p.DataDisks = []machinev1beta1.VSphereDisk{
+					{
+						Name:             "Disk1",
+						SizeGiB:          10,
+						ProvisioningMode: "Fat",
+					},
+				}
+			},
+			expectedOk: false,
+			featureGatesEnabled: func() map[string]bool {
+				fg := make(map[string]bool)
+				fg[string(features.FeatureGateVSphereMultiDisk)] = true
+				return fg
+			}(),
+			expectedError: "providerSpec.disks[0]: Unsupported value: \"Fat\": supported values: \"EagerlyZeroed\", \"Thick\", \"Thin\"",
+		},
 	}
 
 	secret := &corev1.Secret{