Added debug logs

Refactored validateVolumeNotInuse

Author: kolluria

pkg/syncer/cnsoperator/controller/cnsunregistervolume/cnsunregistervolume_controller.go

@@ -339,7 +339,7 @@ func (r *ReconcileCnsUnregisterVolume) Reconcile(ctx context.Context,
 
 // validateVolumeNotInUse validates whether the volume to be unregistered is not in use by
 // either PodVM, TKG cluster or Volume service VM.
-func validateVolumeNotInUse(ctx context.Context, volumdId string, pvcName string,
+func validateVolumeNotInUse(ctx context.Context, volumeID string, pvcName string,
 	pvcNamespace string, k8sClient clientset.Interface) error {
 
 	log := logger.GetLogger(ctx)
@@ -356,22 +356,14 @@ func validateVolumeNotInUse(ctx context.Context, volumdId string, pvcName string
 		for _, podVol := range pod.Spec.Volumes {
 			if podVol.PersistentVolumeClaim != nil &&
 				podVol.PersistentVolumeClaim.ClaimName == pvcName {
-				log.Debugf("Volume %s is in use by pod %s in namespace %s", volumdId,
+				log.Debugf("Volume %s is in use by pod %s in namespace %s", volumeID,
 					pod.Name, pvcNamespace)
 				return fmt.Errorf("cannot unregister the volume %s as it's in use by pod %s in namespace %s",
-					volumdId, pod.Name, pvcNamespace)
+					volumeID, pod.Name, pvcNamespace)
 			}
 		}
 	}
 
-	// Check if the Supervisor volume is not used in any TKGs cluster.
-	// For volumes created from TKGs Cluster, CNS metadata will have two entries for containerClusterArray.
-	// One for clusterFlavor: "WORKLOAD" & clusterDistribution "SupervisorCluster",
-	// another for clusterFlavor: "GUEST_CLUSTER" & clusterDistribution: "TKGService".
-
-	// Check if the Supervisor volume is not used by a volume service VM.
-	// If the volume is specified in the VirtualMachine's spec, then it intends
-	// to be attached to the VM. We will check for the presence of volume in VM's spec.
 	restClientConfig, err := k8s.GetKubeConfig(ctx)
 	if err != nil {
 		msg := fmt.Sprintf("Failed to initialize rest clientconfig. Error: %+v", err)
@@ -393,17 +385,24 @@ func validateVolumeNotInUse(ctx context.Context, volumdId string, pvcName string
 		return err
 	}
 
+	log.Debugf("Found %d VirtualMachines in namespace %s", len(vmList.Items), pvcNamespace)
 	for _, vmInstance := range vmList.Items {
+		log.Debugf("Checking if volume %s is in use by VirtualMachine %s in namespace %s",
+			volumeID, vmInstance.Name, pvcNamespace)
 		for _, vmVol := range vmInstance.Spec.Volumes {
 			if vmVol.PersistentVolumeClaim != nil &&
 				vmVol.PersistentVolumeClaim.ClaimName == pvcName {
-				log.Debugf("Volume %s is in use by VirtualMachine %s in namespace %s", volumdId,
+				// If the volume is specified in the VirtualMachine's spec, then it is
+				// either, in the process of being attached to the VM or is already attached.
+				// In either case, we cannot unregister the volume.
+				log.Debugf("Volume %s is in use by VirtualMachine %s in namespace %s", volumeID,
 					vmInstance.Name, pvcNamespace)
 				return fmt.Errorf("cannot unregister the volume %s as it's in use by VirtualMachine %s in namespace %s",
-					volumdId, vmInstance.Name, pvcNamespace)
+					volumeID, vmInstance.Name, pvcNamespace)
 			}
 		}
 	}
+
 	return nil
 }