Merge pull request #573 from amit-handda/sync-before-helm-reconcile

Sync chart mirror on chart spec change to prevent incorrect reconciliation

cmd/helm-operator/main.go

@@ -293,7 +293,7 @@ func main() {
 	// _before_ starting it or else the cache sync seems to hang at
 	// random
 	opr := operator.New(log.With(logger, "component", "operator"),
-		*logReleaseDiffs, kubeClient, hrInformer, queue, rel)
+		*logReleaseDiffs, kubeClient, hrInformer, queue, rel, gitChartSync)
 	go ifInformerFactory.Start(shutdown)
 
 	// wait for the caches to be synced before starting _any_ workers

pkg/chartsync/git.go

@@ -203,6 +203,21 @@ func (c *GitChartSync) Delete(hr *v1.HelmRelease) bool {
 	return ok
 }
 
+// SyncMirror instructs the helmrelease's git mirror to sync from its upstream
+func (c *GitChartSync) SyncMirror(hr *v1.HelmRelease) error {
+	mirror := mirrorName(hr)
+	c.logger.Log("info", "starting sync of git mirror", "mirror", mirror)
+	repo, ok := c.mirrors.Get(mirror)
+	if !ok {
+		return ChartNotReadyError{ErrNoMirror}
+	}
+	ctx, cancel := context.WithTimeout(context.Background(), c.config.GitTimeout)
+	repo.Refresh(ctx)
+	cancel()
+	c.logger.Log("info", "finished syncing git mirror", "mirror", mirror)
+	return nil
+}
+
 // SyncMirrors instructs all git mirrors to sync from their respective
 // upstreams.
 func (c *GitChartSync) SyncMirrors() {

pkg/operator/operator.go

@@ -2,6 +2,7 @@ package operator
 
 import (
 	"fmt"
+	"github.com/fluxcd/helm-operator/pkg/chartsync"
 	"os"
 	"path"
 	"sync"
@@ -43,7 +44,8 @@ type Controller struct {
 	hrLister iflister.HelmReleaseLister
 	hrSynced cache.InformerSynced
 
-	release *release.Release
+	release      *release.Release
+	gitChartSync *chartsync.GitChartSync
 
 	// workqueue is a rate limited work queue. This is used to queue work to be
 	// processed instead of performing it as soon as a change happens. This
@@ -64,7 +66,8 @@ func New(
 	kubeclientset kubernetes.Interface,
 	hrInformer hrv1.HelmReleaseInformer,
 	releaseWorkqueue workqueue.RateLimitingInterface,
-	release *release.Release) *Controller {
+	release *release.Release,
+	gitChartSync *chartsync.GitChartSync) *Controller {
 
 	// Add helm-operator types to the default Kubernetes Scheme so Events can be
 	// logged for helm-operator types.
@@ -81,6 +84,7 @@ func New(
 		releaseWorkqueue: releaseWorkqueue,
 		recorder:         recorder,
 		release:          release,
+		gitChartSync:     gitChartSync,
 	}
 
 	controller.logger.Log("info", "setting up event handlers")
@@ -275,6 +279,14 @@ func (c *Controller) enqueueUpdateJob(old, new interface{}) {
 		return
 	}
 
+	// if there is a change in the chartsource (ref change, eg),
+	// its possible that the mirror's ref-sha be obsolete w.r.t. upstream
+	// repo's ref-sha. To avoid spurious deploy, mirror is synced before
+	// doing helm reconciliation
+	if csDiff := cmp.Diff(oldHr.Spec.ChartSource, newHr.Spec.ChartSource); csDiff != "" {
+		c.gitChartSync.SyncMirror(&newHr)
+	}
+
 	c.enqueueJob(new)
 }