Skip to content

refactor: replace hand-rolled finalizer helpers with controllerutil #279

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

Open
Fedosin wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −33
Open

refactor: replace hand-rolled finalizer helpers with controllerutil #279

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
9 changes: 4 additions & 5 deletions internal/controller/keda/kedacontroller_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ func (r *KedaControllerReconciler) Reconcile(ctx context.Context, req ctrl.Reque
}

if instance.GetDeletionTimestamp() != nil {
if contains(instance.GetFinalizers(), kedaControllerFinalizer) {
if controllerutil.ContainsFinalizer(instance, kedaControllerFinalizer) {
// Run finalization logic for kedaControllerFinalizer. If the
// finalization logic fails, don't remove the finalizer so
// that we can retry during the next reconciliation.
Expand All @@ -355,17 +355,16 @@ func (r *KedaControllerReconciler) Reconcile(ctx context.Context, req ctrl.Reque
// Remove kedaControllerFinalizer. Once all finalizers have been
// removed, the object will be deleted.
patch := client.MergeFrom(instance.DeepCopy())
instance.SetFinalizers(remove(instance.GetFinalizers(), kedaControllerFinalizer))
err := r.Patch(ctx, instance, patch)
if err != nil {
controllerutil.RemoveFinalizer(instance, kedaControllerFinalizer)
if err := r.Patch(ctx, instance, patch); err != nil {
return ctrl.Result{}, err
}
}
return ctrl.Result{}, nil
}

// Add finalizer for this CR
if !contains(instance.GetFinalizers(), kedaControllerFinalizer) {
if !controllerutil.ContainsFinalizer(instance, kedaControllerFinalizer) {
if err := r.addFinalizer(ctx, logger, instance); err != nil {
return ctrl.Result{}, err
}
Expand Down
31 changes: 3 additions & 28 deletions internal/controller/keda/kedacontroller_finalizer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (

"github.com/go-logr/logr"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"

kedav1alpha1 "github.com/kedacore/keda-olm-operator/api/keda/v1alpha1"
)
Expand Down Expand Up @@ -33,12 +34,6 @@ func (r *KedaControllerReconciler) finalizeKedaController(logger logr.Logger) er
return err
}

// DO NOT manage deletion of namespace at the moment (as it was created manually)
// if err := r.removeNamespace(installationNamespace); err != nil {
// logger.Info("error finalized KedaController namespace", "error", err)
// return err
// }

logger.Info("Successfully finalized KedaController")
return nil
}
Expand All @@ -47,31 +42,11 @@ func (r *KedaControllerReconciler) finalizeKedaController(logger logr.Logger) er
func (r *KedaControllerReconciler) addFinalizer(ctx context.Context, logger logr.Logger, instance *kedav1alpha1.KedaController) error {
logger.Info("Adding Finalizer for the KedaController")

// Update CR
patch := client.MergeFrom(instance.DeepCopy())
instance.SetFinalizers(append(instance.GetFinalizers(), kedaControllerFinalizer))
err := r.Patch(ctx, instance, patch)
if err != nil {
controllerutil.AddFinalizer(instance, kedaControllerFinalizer)
if err := r.Patch(ctx, instance, patch); err != nil {
logger.Error(err, "Failed to update KedaController with finalizer")
return err
}
return nil
}

func contains(list []string, s string) bool {
for _, v := range list {
if v == s {
return true
}
}
return false
}

func remove(list []string, s string) []string {
for i, v := range list {
if v == s {
list = append(list[:i], list[i+1:]...)
}
}
return list
}
Loading