deprecate `requeue: true`

[ruanxin]

Description

The requeue has been deprecated in the latest controller-runtime. kubernetes-sigs/controller-runtime#3107, the recommended replacement is RequeueAfter. However, unlike Requeue, using RequeueAfter bypasses the built-in rate-limiting mechanism. This poses a potential performance risk—especially if a large number of items hit the same short RequeueAfter interval—leading to high reconciliation pressure.

DevNotes:

We have a shared RateLimiter defined, we can introduce this as a field for each controller, for the requeue case, refactor them to return ctrl.Result{RequeueAfter: r.rateLimiter.When(req)}, nil

Reasons

No response

Acceptance Criteria

• When there is a non-nil err to return, replace with return ctrl.Result{}, err
  • make sure updateStatusWithError always return error

    lifecycle-manager/internal/controller/kyma/controller.go

    Line 219 in 8c1a35c

    return ctrl.Result{Requeue: true}, r.updateStatusWithError(ctx, kyma, err)

    (it should return the passed-in error always probably)
• replacing the rest with requeueAfter by ratelimit: return ctrl.Result{RequeueAfter: r.rateLimiter.When(req)}, nil

Feature Testing

No response

Testing approach

No response

Attachments

No response

[c-pius]

However, unlike Requeue, using RequeueAfter bypasses the built-in rate-limiting mechanism.

👍🏻 this is true. Just to preserve some additional info as I also looked into this again while investigating #2841

• here is where controller-runtime requeues: https://github.com/kubernetes-sigs/controller-runtime/blob/6e240927407d36a0440a51a89d3c8c84038d04ad/pkg/internal/controller/controller.go#L465-L498
• here is where it maps this to a workqueue add: https://github.com/kubernetes-sigs/controller-runtime/blob/6e240927407d36a0440a51a89d3c8c84038d04ad/pkg/internal/controller/controller.go#L532-L543
• here is a blog article explaining some basics: https://danielmangum.com/posts/controller-runtime-client-go-rate-limiting/