fix(GcpNfsVolume): consider annotations equal if actual is superset o… (#288)

Author: dushanpantic

pkg/skr/gcpnfsvolume/modifyPersistenceVolume.go

@@ -41,20 +41,18 @@ func modifyPersistenceVolume(ctx context.Context, st composed.State) (error, con
 		logger.Info("Detected modified PV capacity")
 	}
 
-	//If labels are different, update PV labels.
-	labels := getVolumeLabels(nfsVolume)
-	if !areLabelsEqual(state.PV.Labels, labels) {
+	expectedLabels := getVolumeLabels(nfsVolume)
+	if !areLabelsEqual(state.PV.Labels, expectedLabels) {
 		changed = true
-		state.PV.Labels = labels
+		state.PV.Labels = expectedLabels
 		logger.Info("Detected modified PV labels")
 	}
 
-	//If annotations are different, update PV annotations.
-	annotations := getVolumeAnnotations(nfsVolume)
-	if !areAnnotationsEqual(state.PV.Annotations, annotations) {
+	expectedAnnotations := getVolumeAnnotations(nfsVolume)
+	if !areAnnotationsSuperset(state.PV.Annotations, expectedAnnotations) {
 		changed = true
-		state.PV.Annotations = annotations
-		logger.Info("Detected modified PV annotations")
+		state.PV.Annotations = expectedAnnotations
+		logger.Info("Detected desynced PV annotations")
 	}
 
 	//No changes to PV, continue.

pkg/skr/gcpnfsvolume/modifyPersistentVolumeClaim.go

@@ -35,21 +35,21 @@ func modifyPersistentVolumeClaim(ctx context.Context, st composed.State) (error,
 		logger.Info("Detected modified PVC capacity")
 	}
 
-	labels := getVolumeClaimLabels(nfsVolume)
-	labelsChanged := !areLabelsEqual(state.PVC.Labels, labels)
+	expectedLabels := getVolumeClaimLabels(nfsVolume)
+	labelsChanged := !areLabelsEqual(state.PVC.Labels, expectedLabels)
 	if labelsChanged {
-		state.PVC.Labels = labels
+		state.PVC.Labels = expectedLabels
 		logger.Info("Detected modified PVC labels")
 	}
 
-	annotations := getVolumeClaimAnnotations(nfsVolume)
-	annotationsChanged := !areAnnotationsEqual(state.PVC.Annotations, annotations)
-	if annotationsChanged {
-		state.PVC.Annotations = annotations
-		logger.Info("Detected modified PVC annotations")
+	expectedAnnotations := getVolumeClaimAnnotations(nfsVolume)
+	annotationsDesynced := !areAnnotationsSuperset(state.PVC.Annotations, expectedAnnotations) // PVC controller will keep adding "pv.kubernetes.io/bind-completed=yes" annotation, so we must check if we are actual is superset of expected
+	if annotationsDesynced {
+		state.PVC.Annotations = expectedAnnotations
+		logger.Info("Detected desynced PVC annotations")
 	}
 
-	if !(capacityChanged || labelsChanged || annotationsChanged) {
+	if !(capacityChanged || labelsChanged || annotationsDesynced) {
 		return nil, nil
 	}
 

pkg/skr/gcpnfsvolume/util.go

@@ -90,7 +90,7 @@ func gcpNfsVolumeCapacityToResourceQuantity(gcpVol *cloudresourcesv1beta1.GcpNfs
 	return resource.NewQuantity(int64(gcpVol.Spec.CapacityGb)*1024*1024*1024, resource.BinarySI)
 }
 
-func areMapsEqual(first, second map[string]string) bool {
+func areLabelsEqual(first, second map[string]string) bool {
 	x := first
 	y := second
 
@@ -104,10 +104,11 @@ func areMapsEqual(first, second map[string]string) bool {
 	return reflect.DeepEqual(x, y)
 }
 
-func areLabelsEqual(first, second map[string]string) bool {
-	return areMapsEqual(first, second)
-}
-
-func areAnnotationsEqual(first, second map[string]string) bool {
-	return areMapsEqual(first, second)
+func areAnnotationsSuperset(superset, subset map[string]string) bool {
+	for key, value := range subset {
+		if superset[key] != value {
+			return false
+		}
+	}
+	return true
 }