Skip to content

📖 Document Reconcile Result/error requeue and backoff behavior - #3574

Open
VedantMadane wants to merge 1 commit into
kubernetes-sigs:mainfrom
VedantMadane:docs/808-reconcile-requeue-backoff
Open

📖 Document Reconcile Result/error requeue and backoff behavior#3574
VedantMadane wants to merge 1 commit into
kubernetes-sigs:mainfrom
VedantMadane:docs/808-reconcile-requeue-backoff

Conversation

@VedantMadane

@VedantMadane VedantMadane commented Aug 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Expand TypedReconciler.Reconcile godoc with concrete Result/error return examples and rules for exponential backoff, RequeueAfter, deprecated Requeue, and TerminalError.

Fixes #808

@kubernetes-prow kubernetes-prow Bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Aug 18, 2026
@kubernetes-prow

kubernetes-prow Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: VedantMadane
Once this PR has been reviewed and has the lgtm label, please assign sbueringer for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow

kubernetes-prow Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Welcome @VedantMadane!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 18, 2026
@kubernetes-prow

kubernetes-prow Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Hi @VedantMadane. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubernetes-prow kubernetes-prow Bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 18, 2026
@VedantMadane
VedantMadane force-pushed the docs/808-reconcile-requeue-backoff branch from 073cb25 to ae6e5f3 Compare August 19, 2026 10:42
@VedantMadane
docs: document Reconcile Result/error requeue and backoff behavior
6b73c7e 
Add concrete return examples and rules for exponential backoff vs
RequeueAfter vs TerminalError on TypedReconciler.Reconcile.

Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
@kubernetes-prow kubernetes-prow Bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Aug 19, 2026
@VedantMadane VedantMadane changed the title 📖 Document Reconcile requeue and exponential backoff behavior docs: document Reconcile Result/error requeue and backoff behavior Aug 19, 2026
@VedantMadane VedantMadane changed the title docs: document Reconcile Result/error requeue and backoff behavior 📖 Document Reconcile Result/error requeue and backoff behavior Aug 19, 2026
@VedantMadane
VedantMadane force-pushed the docs/808-reconcile-requeue-backoff branch from ae6e5f3 to 6b73c7e Compare August 22, 2026 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alvaroaleman alvaroaleman Awaiting requested review from alvaroaleman
@inteon inteon Awaiting requested review from inteon

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document ways to trigger/not trigger exponential backoff

1 participant

@VedantMadane