Allow limiting the maximum release history on upgrades (#14) (#107)

Co-authored-by: Malte Isberner <[email protected]>

Author: SimonBaeumer

pkg/client/actionclient.go

@@ -163,6 +163,7 @@ func (c *actionClient) Upgrade(name, namespace string, chrt *chart.Chart, vals m
 		if rel != nil {
 			rollback := action.NewRollback(c.conf)
 			rollback.Force = true
+			rollback.MaxHistory = upgrade.MaxHistory
 
 			// As of Helm 2.13, if Upgrade returns a non-nil release, that
 			// means the release was also recorded in the release store.

pkg/reconciler/reconciler.go

@@ -73,6 +73,7 @@ type Reconciler struct {
 	skipDependentWatches    bool
 	maxConcurrentReconciles int
 	reconcilePeriod         time.Duration
+	maxHistory              int
 
 	annotSetupOnce       sync.Once
 	annotations          map[string]struct{}
@@ -280,6 +281,18 @@ func WithReconcilePeriod(rp time.Duration) Option {
 	}
 }
 
+// WithMaxReleaseHistory specifies the maximum size of the Helm release history maintained
+// on upgrades/rollbacks. Zero (default) means unlimited.
+func WithMaxReleaseHistory(maxHistory int) Option {
+	return func(r *Reconciler) error {
+		if maxHistory < 0 {
+			return errors.New("maximum Helm release history size must not be negative")
+		}
+		r.maxHistory = maxHistory
+		return nil
+	}
+}
+
 // WithInstallAnnotations is an Option that configures Install annotations
 // to enable custom action.Install fields to be set based on the value of
 // annotations found in the custom resource watched by this reconciler.
@@ -592,6 +605,12 @@ func (r *Reconciler) getReleaseState(client helmclient.ActionInterface, obj meta
 	}
 
 	var opts []helmclient.UpgradeOption
+	if r.maxHistory > 0 {
+		opts = append(opts, func(u *action.Upgrade) error {
+			u.MaxHistory = r.maxHistory
+			return nil
+		})
+	}
 	for name, annot := range r.upgradeAnnotations {
 		if v, ok := obj.GetAnnotations()[name]; ok {
 			opts = append(opts, annot.UpgradeOption(v))
@@ -636,6 +655,12 @@ func (r *Reconciler) doInstall(actionClient helmclient.ActionInterface, u *updat
 
 func (r *Reconciler) doUpgrade(actionClient helmclient.ActionInterface, u *updater.Updater, obj *unstructured.Unstructured, vals map[string]interface{}, log logr.Logger) (*release.Release, error) {
 	var opts []helmclient.UpgradeOption
+	if r.maxHistory > 0 {
+		opts = append(opts, func(u *action.Upgrade) error {
+			u.MaxHistory = r.maxHistory
+			return nil
+		})
+	}
 	for name, annot := range r.upgradeAnnotations {
 		if v, ok := obj.GetAnnotations()[name]; ok {
 			opts = append(opts, annot.UpgradeOption(v))

pkg/reconciler/reconciler_test.go

@@ -173,6 +173,19 @@ var _ = Describe("Reconciler", func() {
 				Expect(WithReconcilePeriod(-time.Nanosecond)(r)).NotTo(Succeed())
 			})
 		})
+		var _ = Describe("WithMaxReleaseHistory", func() {
+			It("should set the max history size", func() {
+				Expect(WithMaxReleaseHistory(10)(r)).To(Succeed())
+				Expect(r.maxHistory).To(Equal(10))
+			})
+			It("should allow setting the history to unlimited", func() {
+				Expect(WithMaxReleaseHistory(0)(r)).To(Succeed())
+				Expect(r.maxHistory).To(Equal(0))
+			})
+			It("should fail if value is less than 0", func() {
+				Expect(WithMaxReleaseHistory(-1)(r)).NotTo(Succeed())
+			})
+		})
 		var _ = Describe("WithInstallAnnotations", func() {
 			It("should set multiple reconciler install annotations", func() {
 				a1 := annotation.InstallDisableHooks{CustomName: "my.domain/custom-name1"}