StopMatchingBehavior: accept only two correct values

Enforce validations for StopMatchingBehavior. This PR also changes behavior when in DryRun mode. Value hashes are not considered in DryRun mode. That is because in this mode if version is same, value diffs will be evaluated and reported.
projectsveltos · Dec 6, 2024 · 482fd24 · 482fd24
1 parent 03160d0
commit 482fd24
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 10 deletions.
diff --git a/api/v1alpha1/spec.go b/api/v1alpha1/spec.go
@@ -436,6 +436,7 @@ type KustomizationRef struct {
 // a ClusterProfile. By default, withdrawpolicies, deployed Helm charts and Kubernetes
 // resources will be removed from Cluster. LeavePolicy instead leaves Helm charts
 // and Kubernetes policies in the Cluster.
+// +kubebuilder:validation:Enum:=WithdrawPolicies;LeavePolicies
 type StopMatchingBehavior string
 
 // Define the StopMatchingBehavior constants.

diff --git a/api/v1beta1/spec.go b/api/v1beta1/spec.go
@@ -505,6 +505,7 @@ type KustomizationRef struct {
 // a ClusterProfile. By default, withdrawpolicies, deployed Helm charts and Kubernetes
 // resources will be removed from Cluster. LeavePolicy instead leaves Helm charts
 // and Kubernetes policies in the Cluster.
+// +kubebuilder:validation:Enum:=WithdrawPolicies;LeavePolicies
 type StopMatchingBehavior string
 
 // Define the StopMatchingBehavior constants.

diff --git a/config/crd/bases/config.projectsveltos.io_clusterprofiles.yaml b/config/crd/bases/config.projectsveltos.io_clusterprofiles.yaml
@@ -583,6 +583,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous
@@ -1781,6 +1784,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous

diff --git a/config/crd/bases/config.projectsveltos.io_clustersummaries.yaml b/config/crd/bases/config.projectsveltos.io_clustersummaries.yaml
@@ -601,6 +601,9 @@ spec:
                       the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                       be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                       leave ClusterProfile deployed policies in the Cluster.
+                    enum:
+                    - WithdrawPolicies
+                    - LeavePolicies
                     type: string
                   syncMode:
                     default: Continuous
@@ -1809,6 +1812,9 @@ spec:
                       the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                       be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                       leave ClusterProfile deployed policies in the Cluster.
+                    enum:
+                    - WithdrawPolicies
+                    - LeavePolicies
                     type: string
                   syncMode:
                     default: Continuous

diff --git a/config/crd/bases/config.projectsveltos.io_profiles.yaml b/config/crd/bases/config.projectsveltos.io_profiles.yaml
@@ -583,6 +583,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous
@@ -1781,6 +1784,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous

diff --git a/controllers/handlers_helm.go b/controllers/handlers_helm.go
@@ -1361,17 +1361,20 @@ func shouldUpgrade(ctx context.Context, currentRelease *releaseInfo, requestedCh
 	}
 
 	if clusterSummary.Spec.ClusterProfileSpec.SyncMode != configv1beta1.SyncModeContinuousWithDriftDetection {
-		oldValueHash := getValueHashFromHelmChartSummary(requestedChart, clusterSummary)
+		if clusterSummary.Spec.ClusterProfileSpec.SyncMode != configv1beta1.SyncModeDryRun {
+			// In DryRun mode, if values are different, report will be generated
+			oldValueHash := getValueHashFromHelmChartSummary(requestedChart, clusterSummary)
 
-		// If Values configuration has changed, trigger an upgrade
-		c := getManagementClusterClient()
-		currentValueHash, err := getHelmChartValuesHash(ctx, c, requestedChart, clusterSummary, logger)
-		if err != nil {
-			logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to get current values hash: %v", err))
-			currentValueHash = []byte("") // force upgrade
-		}
-		if !reflect.DeepEqual(oldValueHash, currentValueHash) {
-			return true
+			// If Values configuration has changed, trigger an upgrade
+			c := getManagementClusterClient()
+			currentValueHash, err := getHelmChartValuesHash(ctx, c, requestedChart, clusterSummary, logger)
+			if err != nil {
+				logger.V(logs.LogInfo).Info(fmt.Sprintf("failed to get current values hash: %v", err))
+				currentValueHash = []byte("") // force upgrade
+			}
+			if !reflect.DeepEqual(oldValueHash, currentValueHash) {
+				return true
+			}
 		}
 
 		// With drift detection mode, there is reconciliation due to configuration drift even

diff --git a/manifest/manifest.yaml b/manifest/manifest.yaml
@@ -1364,6 +1364,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous
@@ -2562,6 +2565,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous
@@ -4184,6 +4190,9 @@ spec:
                       the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                       be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                       leave ClusterProfile deployed policies in the Cluster.
+                    enum:
+                    - WithdrawPolicies
+                    - LeavePolicies
                     type: string
                   syncMode:
                     default: Continuous
@@ -5392,6 +5401,9 @@ spec:
                       the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                       be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                       leave ClusterProfile deployed policies in the Cluster.
+                    enum:
+                    - WithdrawPolicies
+                    - LeavePolicies
                     type: string
                   syncMode:
                     default: Continuous
@@ -6327,6 +6339,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous
@@ -7525,6 +7540,9 @@ spec:
                   the ClusterProfile. By default all deployed Helm charts and Kubernetes resources will
                   be withdrawn from Cluster. Setting StopMatchingBehavior to LeavePolicies will instead
                   leave ClusterProfile deployed policies in the Cluster.
+                enum:
+                - WithdrawPolicies
+                - LeavePolicies
                 type: string
               syncMode:
                 default: Continuous