kubernetes-sigs / kubernetes-sigs/controller-runtime
Document ways to trigger/not trigger exponential backoff
Open
Nobody has claimed this yet.
help wanted
kind/documentation
lifecycle/frozen
priority/important-longterm
- Dominant language
- Go
- Stars
- 3k
- Forks
- 1.3k
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 14
Description
Related to #617
As a user of controller-runtime, it is not immediately clear what returns from a Reconcile() will force a requeue with (or without) an exponential backoff. Some quick examples:
return reconcile.Result{requeue: true}, nil
return reconcile.Result{requeueAfter: time.Duration(60) * time.Second}, nil
// err != nil
return reconcile.Result{}, fmt.Errorf("My custom error string")
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Reconcile() contract and reconcile.Result, using the three examples in the issue to trace when requeues receive exponential backoff. Document which return values trigger or avoid backoff, and verify that each example's behavior is explained clearly in the relevant controller-runtime documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100