Honor Helm's MaxHistory when using drift correction

rancher · Jun 14, 2024 · 4db0169 · 4db0169
1 parent 2cf3c91
commit 4db0169
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 12 deletions.
diff --git a/e2e/drift/drift_test.go b/e2e/drift/drift_test.go
@@ -151,6 +151,11 @@ var _ = Describe("Drift", func() {
 					_ = json.Unmarshal([]byte(out), &configMap)
 					return configMap.Data["foo"] == "bar"
 				}).Should(BeTrue())
+				Expect(func() string {
+					kw := k.Namespace(namespace)
+					n, _ := kw.Get("secrets", "--field-selector=type=helm.sh/release.v1", `-o=go-template='{{printf "%d\n" (len  .items)}}'`)
+					return n
+				}).Should(Equal("2")) // Max Helm history
 			})
 		})
 

diff --git a/internal/cmd/agent/controller/bundledeployment_controller.go b/internal/cmd/agent/controller/bundledeployment_controller.go
@@ -135,9 +135,10 @@ func (r *BundleDeploymentReconciler) Reconcile(ctx context.Context, req ctrl.Req
 
 		// Run drift correction
 		if len(status.ModifiedStatus) > 0 && bd.Spec.CorrectDrift != nil && bd.Spec.CorrectDrift.Enabled {
-			err = r.Deployer.RemoveExternalChanges(ctx, bd)
-			if err != nil {
+			if release, err := r.Deployer.RemoveExternalChanges(ctx, bd); err != nil {
 				merr = append(merr, fmt.Errorf("failed reconciling drift: %w", err))
+			} else {
+				bd.Status.Release = release
 			}
 		}
 

diff --git a/internal/cmd/agent/deployer/deployer.go b/internal/cmd/agent/deployer/deployer.go
@@ -45,7 +45,7 @@ func (d *Deployer) Resources(name string, release string) (*helmdeployer.Resourc
 	return d.helm.Resources(name, release)
 }
 
-func (d *Deployer) RemoveExternalChanges(ctx context.Context, bd *fleet.BundleDeployment) error {
+func (d *Deployer) RemoveExternalChanges(ctx context.Context, bd *fleet.BundleDeployment) (string, error) {
 	return d.helm.RemoveExternalChanges(ctx, bd)
 }
 

diff --git a/internal/helmdeployer/history.go b/internal/helmdeployer/history.go
@@ -94,13 +94,17 @@ func (h *Helm) getRelease(releaseName, namespace string, version int) (*release.
 	return nil, ErrNoRelease
 }
 
+func releaseToResourceID(release *release.Release) string {
+	return fmt.Sprintf("%s/%s:%d", release.Namespace, release.Name, release.Version)
+}
+
 func releaseToResources(release *release.Release) (*Resources, error) {
 	var (
 		err error
 	)
 	resources := &Resources{
 		DefaultNamespace: release.Namespace,
-		ID:               fmt.Sprintf("%s/%s:%d", release.Namespace, release.Name, release.Version),
+		ID:               releaseToResourceID(release),
 	}
 
 	resources.Objects, err = yaml.ToObjects(bytes.NewBufferString(release.Manifest))

diff --git a/internal/helmdeployer/rollback.go b/internal/helmdeployer/rollback.go
@@ -15,17 +15,17 @@ import (
 
 // RemoveExternalChanges does a helm rollback to remove changes made outside of fleet.
 // It removes the helm history entry if the rollback fails.
-func (h *Helm) RemoveExternalChanges(ctx context.Context, bd *fleet.BundleDeployment) error {
+func (h *Helm) RemoveExternalChanges(ctx context.Context, bd *fleet.BundleDeployment) (string, error) {
 	log.FromContext(ctx).WithName("RemoveExternalChanges").Info("Drift correction: rollback")
 
 	_, defaultNamespace, releaseName := h.getOpts(bd.Name, bd.Spec.Options)
 	cfg, err := h.getCfg(ctx, defaultNamespace, bd.Spec.Options.ServiceAccount)
 	if err != nil {
-		return err
+		return "", err
 	}
 	currentRelease, err := cfg.Releases.Last(releaseName)
 	if err != nil {
-		return err
+		return "", err
 	}
 
 	r := action.NewRollback(&cfg)
@@ -37,12 +37,17 @@ func (h *Helm) RemoveExternalChanges(ctx context.Context, bd *fleet.BundleDeploy
 	if bd.Spec.CorrectDrift.Force {
 		r.Force = true
 	}
-	err = r.Run(releaseName)
-	if err != nil && !bd.Spec.CorrectDrift.KeepFailHistory {
-		return removeFailedRollback(cfg, currentRelease, err)
+	if err := r.Run(releaseName); err != nil {
+		if bd.Spec.CorrectDrift.KeepFailHistory {
+			return "", err
+		}
+		return "", removeFailedRollback(cfg, currentRelease, err)
 	}
-
-	return err
+	release, err := cfg.Releases.Last(releaseName)
+	if err != nil {
+		return "", err
+	}
+	return releaseToResourceID(release), nil
 }
 
 func removeFailedRollback(cfg action.Configuration, currentRelease *release.Release, err error) error {