Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Honor Helm's MaxHistory when using drift correction #2519

Merged
merged 2 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions e2e/drift/drift_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
})
})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}

Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/agent/deployer/deployer.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
}

Expand Down
6 changes: 5 additions & 1 deletion internal/helmdeployer/history.go
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
25 changes: 17 additions & 8 deletions internal/helmdeployer/rollback.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,39 @@ 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)
r.Version = currentRelease.Version
r.MaxHistory = bd.Spec.Options.Helm.MaxHistory
if r.MaxHistory == 0 {
r.MaxHistory = MaxHelmHistory
}
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 {
Expand Down
Loading