[APIServer][Docs] Add user guide for retry behavior & configuration #4144
+93
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… and usecases Signed-off-by: justinyeh1995 <[email protected]>
justinyeh1995
changed the title
justinyeh1995
changed the title
justinyeh1995
changed the title
Signed-off-by: justinyeh1995 <[email protected]>
justinyeh1995
changed the title
justinyeh1995
changed the title
…docs/3883-add-apiserver-rety-to-doc
Signed-off-by: justinyeh1995 <[email protected]>
…docs/3883-add-apiserver-rety-to-doc
…docs/3883-add-apiserver-rety-to-doc
…docs/3883-add-apiserver-rety-to-doc
…ection Signed-off-by: justinyeh1995 <[email protected]>
Contributor
Author
|
cc @machichima @dentiny - Would appreciate your reviews. Thank you! |
Signed-off-by: justinyeh1995 <[email protected]>
Signed-off-by: justinyeh1995 <[email protected]>
…docs/3883-add-apiserver-rety-to-doc
Signed-off-by: justinyeh1995 <[email protected]>
Collaborator
|
cc @CheyuWu |
machichima
reviewed
Nov 13, 2025
Comment on lines
+45
to
+53
| ```go | ||
| const ( | ||
| HTTPClientDefaultMaxRetry = 5 // Increase retries from 3 to 5 | ||
| HTTPClientDefaultBackoffFactor = float64(2) | ||
| HTTPClientDefaultInitBackoff = 2 * time.Second // Longer backoff makes timing visible | ||
| HTTPClientDefaultMaxBackoff = 20 * time.Second | ||
| HTTPClientDefaultOverallTimeout = 120 * time.Second // Longer timeout to allow more retries | ||
| ) | ||
| ``` |
Collaborator
There was a problem hiding this comment.
It seems like currently we do not have a way to configure it without modifying the code. I am thinking in this case we can omit the configuration part and just write about the default behavior?
cc @Future-Outlier @rueian for some advice on this
| - **MaxBackoff**: 10s (maximum wait time between retries) | ||
| - **OverallTimeout**: 30s (total timeout for all attempts) | ||
|
|
||
| which means $$Backoff_i = \min(InitBackoff \times BackoffFactor^i, MaxBackoff)$$ |
Collaborator
There was a problem hiding this comment.
Suggested change
| which means $$Backoff_i = \min(InitBackoff \times BackoffFactor^i, MaxBackoff)$$ | |
| which means $$\text{Backoff}_i = \min(\text{InitBackoff} \times \text{BackoffFactor}^i, \text{MaxBackoff})$$ | |
For better format, preview:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR addresses the need for documentation related to the new automatic retry feature introduced to the APIServer SDK V2 client in PRs #3551 and #3946. Currently, there is no guide for users on how to configure this essential retry functionality.
Related issue number
Closes #3883
Checks