Add comments to the new function definitions and rename cUUID to peUU…

…ID parameter

api/v1beta1/conditions.go

@@ -29,6 +29,7 @@ const (
 	// NoFailureDomainsReconciled indicates no failure domains have been defined
 	NoFailureDomainsReconciled capiv1.ConditionType = "NoFailureDomainsReconciled"
 
+	// FailureDomainsReconciliationFailed indicates the failure domain reconciliation failed
 	FailureDomainsReconciliationFailed = "FailureDomainsReconciliationFailed"
 )
 

controllers/helpers.go

@@ -748,6 +748,7 @@ func GetGPUsForPE(ctx context.Context, client *nutanixClientV3.Client, peUUID st
 	return gpus, nil
 }
 
+// GetFailureDomain gets the failure domain with a given name from a NutanixCluster object.
 func GetFailureDomain(failureDomainName string, nutanixCluster *infrav1.NutanixCluster) (*infrav1.NutanixFailureDomain, error) {
 	if failureDomainName == "" {
 		return nil, fmt.Errorf("failure domain name must be set when searching for failure domains on a Nutanix cluster object")

controllers/nutanixmachine_controller.go

@@ -929,14 +929,14 @@ func (r *NutanixMachineReconciler) GetSubnetAndPEUUIDs(rctx *nctx.MachineContext
 	if err != nil {
 		return "", nil, fmt.Errorf("failed to find failure domain %s", failureDomainName)
 	}
-	cUUID, err := GetPEUUID(rctx.Context, rctx.NutanixClient, failureDomain.Cluster.Name, failureDomain.Cluster.UUID)
+	peUUID, err := GetPEUUID(rctx.Context, rctx.NutanixClient, failureDomain.Cluster.Name, failureDomain.Cluster.UUID)
 	if err != nil {
 		return "", nil, fmt.Errorf("failed to find prism element uuid for failure domain %s", failureDomainName)
 	}
-	subnetUUIDs, err := GetSubnetUUIDList(rctx.Context, rctx.NutanixClient, failureDomain.Subnets, cUUID)
+	subnetUUIDs, err := GetSubnetUUIDList(rctx.Context, rctx.NutanixClient, failureDomain.Subnets, peUUID)
 	if err != nil {
 		return "", nil, fmt.Errorf("failed to find subnet uuids for failure domain %s", failureDomainName)
 	}
 
-	return cUUID, subnetUUIDs, nil
+	return peUUID, subnetUUIDs, nil
 }