enables storage policy in failure domain and disables cluster module creation when failure domain is used

Author: RenilRaj-BR

apis/v1alpha3/vspherefailuredomain_types.go

@@ -78,6 +78,11 @@ type Topology struct {
 	// virtual machine is created/located.
 	// +optional
 	Datastore string `json:"datastore,omitempty"`
+
+	// StoragePolicy is the name of the policy that is used to target a datastore
+	// in which the virtual machine is created/located
+	// +optional
+	StoragePolicy string `json:"storagePolicy,omitempty"`
 }
 
 type FailureDomainHosts struct {

apis/v1alpha3/zz_generated.conversion.go

@@ -79,6 +79,11 @@ type Topology struct {
 	// virtual machine is created/located.
 	// +optional
 	Datastore string `json:"datastore,omitempty"`
+
+	// StoragePolicy is the name of the policy that is used to target a datastore
+	// in which the virtual machine is created/located
+	// +optional
+	StoragePolicy string `json:"storagePolicy,omitempty"`
 }
 
 type FailureDomainHosts struct {

apis/v1alpha4/vspherefailuredomain_types.go

@@ -85,6 +85,11 @@ type Topology struct {
 	// virtual machine is created/located.
 	// +optional
 	Datastore string `json:"datastore,omitempty"`
+
+	// StoragePolicy is the name of the policy that is used to target a datastore
+	// in which the virtual machine is created/located
+	// +optional
+	StoragePolicy string `json:"storagePolicy,omitempty"`
 }
 
 // FailureDomainHosts has information required for placement of machines on VSphere hosts.

apis/v1alpha4/zz_generated.conversion.go

@@ -109,6 +109,11 @@ spec:
                     items:
                       type: string
                     type: array
+                  storagePolicy:
+                    description: |-
+                      StoragePolicy is the name of the policy that is used to target a datastore
+                      in which the virtual machine is created/located
+                    type: string
                 required:
                 - datacenter
                 type: object
@@ -240,6 +245,11 @@ spec:
                     items:
                       type: string
                     type: array
+                  storagePolicy:
+                    description: |-
+                      StoragePolicy is the name of the policy that is used to target a datastore
+                      in which the virtual machine is created/located
+                    type: string
                 required:
                 - datacenter
                 type: object
@@ -368,6 +378,11 @@ spec:
                     items:
                       type: string
                     type: array
+                  storagePolicy:
+                    description: |-
+                      StoragePolicy is the name of the policy that is used to target a datastore
+                      in which the virtual machine is created/located
+                    type: string
                 required:
                 - datacenter
                 type: object

apis/v1beta1/vspherefailuredomain_types.go

@@ -359,7 +359,12 @@ func (r *clusterReconciler) reconcileDeploymentZones(ctx context.Context, cluste
 }
 
 func (r *clusterReconciler) reconcileClusterModules(ctx context.Context, clusterCtx *capvcontext.ClusterContext) (reconcile.Result, error) {
-	if feature.Gates.Enabled(feature.NodeAntiAffinity) {
+	// We want to enable cluster module only when NodeAntiAffinity flag is true and failure domains are not used.
+	// When failure domain is used and an empty value is passed for data center or the resource pool in a vm template,
+	// cluster module creation will fail as there are no values in dc or resource pool.
+	// These values in the vm template gets replaced at a later stage by the values in the failure domain.
+	// When failure domain is used, we do not need the cluster module
+	if feature.Gates.Enabled(feature.NodeAntiAffinity) && clusterCtx.VSphereCluster.Spec.FailureDomainSelector == nil {
 		return r.clusterModuleReconciler.Reconcile(ctx, clusterCtx)
 	}
 	return reconcile.Result{}, nil

config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherefailuredomains.yaml

@@ -61,6 +61,11 @@ func (webhook *VSphereFailureDomainWebhook) ValidateCreate(_ context.Context, ra
 		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "Topology", "ComputeCluster"), "cannot be empty if Hosts is not empty"))
 	}
 
+	// We should either pass a datastore or a storage policy, not both at the same time
+	if obj.Spec.Topology.Datastore != "" && obj.Spec.Topology.StoragePolicy != "" {
+		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "Topology", "Datastore"), "should be empty if StoragePolicy is not empty"))
+	}
+
 	if obj.Spec.Region.Type == infrav1.HostGroupFailureDomain {
 		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec", "Region", "Type"), fmt.Sprintf("region's Failure Domain type cannot be %s", obj.Spec.Region.Type)))
 	}
@@ -93,6 +98,10 @@ func (webhook *VSphereFailureDomainWebhook) ValidateUpdate(_ context.Context, ol
 	if !reflect.DeepEqual(newTyped.Spec, oldTyped.Spec) {
 		return nil, field.Forbidden(field.NewPath("spec"), "VSphereFailureDomainSpec is immutable")
 	}
+	// We should either pass a datastore or a storage policy, not both at the same time
+	if newTyped.Spec.Topology.Datastore != "" && newTyped.Spec.Topology.StoragePolicy != "" {
+		return nil, field.Forbidden(field.NewPath("spec", "Topology", "Datastore"), "should be empty if StoragePolicy is not empty")
+	}
 	return nil, nil
 }
 

controllers/vspherecluster_reconciler.go

@@ -432,6 +432,9 @@ func (v *VimMachineService) generateOverrideFunc(ctx context.Context, vimMachine
 		if vsphereDeploymentZone.Spec.PlacementConstraint.ResourcePool != "" {
 			vm.Spec.ResourcePool = vsphereDeploymentZone.Spec.PlacementConstraint.ResourcePool
 		}
+		if vsphereFailureDomain.Spec.Topology.StoragePolicy != "" {
+			vm.Spec.StoragePolicyName = vsphereFailureDomain.Spec.Topology.StoragePolicy
+		}
 		if vsphereFailureDomain.Spec.Topology.Datastore != "" {
 			vm.Spec.Datastore = vsphereFailureDomain.Spec.Topology.Datastore
 		}