fix: allow deleting orphans while retaining the data

check for DeleteCustomResourceOnly label in orphan
if label is set to true, skip data cleaning

ref#11286

Signed-off-by: Nina Zhan <[email protected]>

Author: nzhan126

controller/node_controller.go

@@ -1322,7 +1322,7 @@ func (nc *NodeController) syncOrphans(node *longhorn.Node, collectedDataInfo map
 	return nil
 }
 
-func (nc *NodeController) getNewAndMissingOrphanedReplicaDataStores(diskName, diskUUID, diskPath string, replicaDataStores map[string]string) (map[string]string, map[string]string) {
+func (nc *NodeController) getNewAndMissingOrphanedReplicaDataStores(diskName, diskUUID, diskPath string, orphanedReplicaDataStores map[string]string) (map[string]string, map[string]string) {
 	newOrphanedReplicaDataStores := map[string]string{}
 	missingOrphanedReplicaDataStores := map[string]string{}
 
@@ -1339,13 +1339,19 @@ func (nc *NodeController) getNewAndMissingOrphanedReplicaDataStores(diskName, di
 		}
 	}
 
-	for dataStore := range replicaDataStores {
+	for dataStore := range orphanedReplicaDataStores {
 		orphanName := types.GetOrphanChecksumNameForOrphanedDataStore(nc.controllerID, diskName, diskPath, diskUUID, dataStore)
 		if _, ok := orphanMap[orphanName]; !ok {
 			newOrphanedReplicaDataStores[dataStore] = ""
 		}
 	}
 
+	replicas, err := nc.ds.ListReplicasByDiskUUIDRO(diskUUID)
+	if err != nil {
+		nc.logger.WithError(err).Warnf("Failed to list replicas for disk %v", diskUUID)
+		return map[string]string{}, map[string]string{}
+	}
+
 	for _, orphan := range orphanMap {
 		if orphan.Spec.Parameters[longhorn.OrphanDiskName] != diskName ||
 			orphan.Spec.Parameters[longhorn.OrphanDiskUUID] != diskUUID ||
@@ -1354,9 +1360,25 @@ func (nc *NodeController) getNewAndMissingOrphanedReplicaDataStores(diskName, di
 		}
 
 		dataStore := orphan.Spec.Parameters[longhorn.OrphanDataName]
-		if _, ok := replicaDataStores[dataStore]; !ok {
+		reused := false
+		for _, r := range replicas {
+			if r.Spec.DataDirectoryName == dataStore {
+				reused = true
+				break
+			}
+		}
+		_, ok := orphanedReplicaDataStores[dataStore]
+
+		if !ok {
+			if reused {
+				if err := datastore.AddOrphanDeleteCustomResourceOnlyLabel(nc.ds, orphan.Name); err != nil {
+					nc.logger.Infof("failed to add label delete-custom-resource-only to orphan %v ", orphan.Name)
+					return map[string]string{}, map[string]string{}
+				}
+			}
 			missingOrphanedReplicaDataStores[dataStore] = ""
 		}
+
 	}
 
 	return newOrphanedReplicaDataStores, missingOrphanedReplicaDataStores
@@ -1437,7 +1459,12 @@ func (nc *NodeController) canDeleteOrphan(orphan *longhorn.Orphan, autoDeleteEna
 
 	// When dataCleanableCondition is false, it means the associated node is not ready, missing or evicted (check updateDataCleanableCondition()).
 	// In this case, we can delete the orphan directly because the data is not reachable and no need to keep the orphan resource.
-	canDelete := autoDeleteAllowed || dataCleanableCondition.Status == longhorn.ConditionStatusFalse
+	isReasonNodeOrDisk := (dataCleanableCondition.Reason == longhorn.OrphanConditionTypeDataCleanableReasonNodeUnavailable) ||
+		(dataCleanableCondition.Reason == longhorn.OrphanConditionTypeDataCleanableReasonNodeEvicted) ||
+		(dataCleanableCondition.Reason == longhorn.OrphanConditionTypeDataCleanableReasonDiskInvalid) ||
+		(dataCleanableCondition.Reason == longhorn.OrphanConditionTypeDataCleanableReasonDiskEvicted) ||
+		(dataCleanableCondition.Reason == longhorn.OrphanConditionTypeDataCleanableReasonDiskChanged)
+	canDelete := autoDeleteAllowed || ((dataCleanableCondition.Status == longhorn.ConditionStatusFalse) && isReasonNodeOrDisk)
 	if !canDelete {
 		nc.logger.Debugf("Orphan %v is not ready to be deleted, autoDeleteAllowed: %v, dataCleanableCondition: %v", orphan.Name, autoDeleteAllowed, dataCleanableCondition.Status)
 	}

controller/orphan_controller.go

@@ -622,7 +622,6 @@ func (oc *OrphanController) updateDataCleanableCondition(orphan *longhorn.Orphan
 	if orphan.Spec.Type == longhorn.OrphanTypeReplicaData {
 		reason = oc.checkOrphanedReplicaDataCleanable(node, orphan)
 	}
-
 	return nil
 }
 
@@ -647,6 +646,11 @@ func (oc *OrphanController) checkOrphanedReplicaDataCleanable(node *longhorn.Nod
 		return longhorn.OrphanConditionTypeDataCleanableReasonDiskEvicted
 	}
 
+	exists, _ := datastore.IsLabelLonghornDeleteCustomResourceOnlyExisting(orphan)
+	if exists {
+		return longhorn.OrphanConditionTypeDataCleanableReasonSkipped
+	}
+
 	return ""
 }
 

datastore/longhorn.go

@@ -3213,6 +3213,18 @@ func (s *DataStore) ListReplicasByDiskUUID(uuid string) (map[string]*longhorn.Re
 	return s.listReplicas(diskSelector)
 }
 
+func (s *DataStore) ListReplicasByDiskUUIDRO(uuid string) ([]*longhorn.Replica, error) {
+	diskSelector, err := metav1.LabelSelectorAsSelector(&metav1.LabelSelector{
+		MatchLabels: map[string]string{
+			types.LonghornDiskUUIDKey: uuid,
+		},
+	})
+	if err != nil {
+		return nil, err
+	}
+	return s.replicaLister.Replicas(s.namespace).List(diskSelector)
+}
+
 func getBackingImageSelector(backingImageName, diskUUID string) (labels.Selector, error) {
 	matchLabels := map[string]string{
 		types.GetLonghornLabelKey(types.LonghornLabelBackingImage): backingImageName,
@@ -3461,6 +3473,27 @@ func AddSystemBackupDeleteCustomResourceOnlyLabel(ds *DataStore, systemBackupNam
 	return nil
 }
 
+// AddOrphanDeleteCustomResourceOnlyLabel adds the label `longhorn.io/delete-custom-resource-only: true` to the Orphan
+func AddOrphanDeleteCustomResourceOnlyLabel(ds *DataStore, OrphanName string) error {
+	orphan, err := ds.GetOrphan(OrphanName)
+	if err != nil {
+		return err
+	}
+	if exists, err := IsLabelLonghornDeleteCustomResourceOnlyExisting(orphan); err != nil {
+		return err
+	} else if exists {
+		return nil
+	}
+	if err := labelLonghornDeleteCustomResourceOnly(orphan); err != nil {
+		return err
+	}
+	if _, err = ds.UpdateOrphan(orphan); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func FixupRecurringJob(v *longhorn.Volume) error {
 	if err := labelRecurringJobDefault(v); err != nil {
 		return err

k8s/pkg/apis/longhorn/v1beta2/orphan.go

@@ -20,6 +20,7 @@ const (
 	OrphanConditionTypeDataCleanableReasonDiskInvalid     = "DiskInvalid"
 	OrphanConditionTypeDataCleanableReasonDiskEvicted     = "DiskEvicted"
 	OrphanConditionTypeDataCleanableReasonDiskChanged     = "DiskChanged"
+	OrphanConditionTypeDataCleanableReasonSkipped         = "Skipped"
 )
 
 const (