Skip to content

[v0.17.x] pkg/helm/controller/reconcile.go: finalizer fix #3046

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 14, 2020
Merged

[v0.17.x] pkg/helm/controller/reconcile.go: finalizer fix #3046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions changelog/fragments/helm-fix-finalizer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
entries:
- description: >
Helm operator now applies its uninstall finalizer only when
a release is deployed. This fixes a bug that caused the
CR to be unable to be deleted without manually intervening
to delete a prematurely added finalizer.
kind: bugfix
4 changes: 1 addition & 3 deletions pkg/helm/controller/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ import (

"github.com/operator-framework/operator-sdk/pkg/helm/release"
"github.com/operator-framework/operator-sdk/pkg/internal/predicates"
"github.com/operator-framework/operator-sdk/pkg/predicate"
)

var log = logf.Log.WithName("helm.controller")
Expand Down Expand Up @@ -80,8 +79,7 @@ func Add(mgr manager.Manager, options WatchOptions) error {

o := &unstructured.Unstructured{}
o.SetGroupVersionKind(options.GVK)
if err := c.Watch(&source.Kind{Type: o}, &crthandler.EnqueueRequestForObject{},
predicate.GenerationChangedPredicate{}); err != nil {
if err := c.Watch(&source.Kind{Type: o}, &crthandler.EnqueueRequestForObject{}); err != nil {
return err
}

Expand Down
88 changes: 46 additions & 42 deletions pkg/helm/controller/reconcile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ import (
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/tools/record"
"k8s.io/client-go/util/retry"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/reconcile"

"github.com/operator-framework/operator-sdk/internal/util/diffutil"
Expand Down Expand Up @@ -94,38 +96,8 @@ func (r HelmOperatorReconciler) Reconcile(request reconcile.Request) (reconcile.
status := types.StatusFor(o)
log = log.WithValues("release", manager.ReleaseName())

deleted := o.GetDeletionTimestamp() != nil
pendingFinalizers := o.GetFinalizers()
if !deleted && !contains(pendingFinalizers, finalizer) {
log.V(1).Info("Adding finalizer", "finalizer", finalizer)
finalizers := append(pendingFinalizers, finalizer)
o.SetFinalizers(finalizers)
err = r.updateResource(o)

// Need to requeue because finalizer update does not change metadata.generation
return reconcile.Result{Requeue: true}, err
}

status.SetCondition(types.HelmAppCondition{
Type: types.ConditionInitialized,
Status: types.StatusTrue,
})

if err := manager.Sync(context.TODO()); err != nil {
log.Error(err, "Failed to sync release")
status.SetCondition(types.HelmAppCondition{
Type: types.ConditionIrreconcilable,
Status: types.StatusTrue,
Reason: types.ReasonReconcileError,
Message: err.Error(),
})
_ = r.updateResourceStatus(o, status)
return reconcile.Result{}, err
}
status.RemoveCondition(types.ConditionIrreconcilable)

if deleted {
if !contains(pendingFinalizers, finalizer) {
if o.GetDeletionTimestamp() != nil {
if !contains(o.GetFinalizers(), finalizer) {
log.Info("Resource is terminated, skipping reconciliation")
return reconcile.Result{}, nil
}
Expand Down Expand Up @@ -163,13 +135,7 @@ func (r HelmOperatorReconciler) Reconcile(request reconcile.Request) (reconcile.
return reconcile.Result{}, err
}

finalizers := []string{}
for _, pendingFinalizer := range pendingFinalizers {
if pendingFinalizer != finalizer {
finalizers = append(finalizers, pendingFinalizer)
}
}
o.SetFinalizers(finalizers)
controllerutil.RemoveFinalizer(o, finalizer)
if err := r.updateResource(o); err != nil {
log.Info("Failed to remove CR uninstall finalizer")
return reconcile.Result{}, err
Expand All @@ -187,6 +153,24 @@ func (r HelmOperatorReconciler) Reconcile(request reconcile.Request) (reconcile.
return reconcile.Result{}, nil
}

status.SetCondition(types.HelmAppCondition{
Type: types.ConditionInitialized,
Status: types.StatusTrue,
})

if err := manager.Sync(context.TODO()); err != nil {
log.Error(err, "Failed to sync release")
status.SetCondition(types.HelmAppCondition{
Type: types.ConditionIrreconcilable,
Status: types.StatusTrue,
Reason: types.ReasonReconcileError,
Message: err.Error(),
})
_ = r.updateResourceStatus(o, status)
return reconcile.Result{}, err
}
status.RemoveCondition(types.ConditionIrreconcilable)

if !manager.IsInstalled() {
for k, v := range r.OverrideValues {
r.EventRecorder.Eventf(o, "Warning", "OverrideValuesInUse",
Expand All @@ -206,6 +190,13 @@ func (r HelmOperatorReconciler) Reconcile(request reconcile.Request) (reconcile.
}
status.RemoveCondition(types.ConditionReleaseFailed)

log.V(1).Info("Adding finalizer", "finalizer", finalizer)
controllerutil.AddFinalizer(o, finalizer)
if err := r.updateResource(o); err != nil {
log.Info("Failed to add CR uninstall finalizer")
return reconcile.Result{}, err
}

if r.releaseHook != nil {
if err := r.releaseHook(installedRelease); err != nil {
log.Error(err, "Failed to run release hook")
Expand Down Expand Up @@ -236,6 +227,15 @@ func (r HelmOperatorReconciler) Reconcile(request reconcile.Request) (reconcile.
return reconcile.Result{RequeueAfter: r.ReconcilePeriod}, err
}

if !contains(o.GetFinalizers(), finalizer) {
log.V(1).Info("Adding finalizer", "finalizer", finalizer)
controllerutil.AddFinalizer(o, finalizer)
if err := r.updateResource(o); err != nil {
log.Info("Failed to add CR uninstall finalizer")
return reconcile.Result{}, err
}
}

if manager.IsUpdateRequired() {
for k, v := range r.OverrideValues {
r.EventRecorder.Eventf(o, "Warning", "OverrideValuesInUse",
Expand Down Expand Up @@ -343,12 +343,16 @@ func hasHelmUpgradeForceAnnotation(o *unstructured.Unstructured) bool {
}

func (r HelmOperatorReconciler) updateResource(o runtime.Object) error {
return r.Client.Update(context.TODO(), o)
return retry.RetryOnConflict(retry.DefaultBackoff, func() error {
return r.Client.Update(context.TODO(), o)
})
}

func (r HelmOperatorReconciler) updateResourceStatus(o *unstructured.Unstructured, status *types.HelmAppStatus) error {
o.Object["status"] = status
return r.Client.Status().Update(context.TODO(), o)
return retry.RetryOnConflict(retry.DefaultBackoff, func() error {
o.Object["status"] = status
return r.Client.Status().Update(context.TODO(), o)
})
}

func (r HelmOperatorReconciler) waitForDeletion(o runtime.Object) error {
Expand Down