Examples of the Finalizer Helper Library

[austince]

Are there any examples that use the new Finalizer helper library? I'm giving it a try but don't quite understand where the business logic of the finalizer should live. It feels like the Reconciler knows what should be deleted, not main.

Should I define the finalizer logic inside the x_controller.go file, and just register that in the main? Should the reconciler itself actually implement the Finalizer interface?

And then, does it make sense to requeue if either the obj or its status was updated?

requeue, err := r.Finalizers.Finalize(ctx, &job)
if requeue.Updated || requeue.StatusUpdated || err != nil {
  if requeue.Updated {
	r.Client.Update(ctx, &job)
  }

  if requeue.StatusUpdated {
	r.Client.Status().Update(ctx, &job)
  }
  return ctrl.Result{Requeue: requeue.Updated || requeue.StatusUpdated}, err
}

Thanks for the help!

Originally posted by @austince in #1453 (comment)

[varshaprasad96]

Finalizers could be used to clean up any external resources across namespaces when the parent object is deleted. This example maybe helpful to have an overview on where finalizers could be used inside a controller.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale