[APIServer][Docs] Add user guide for retry behavior & configuration #4144

justinyeh1995 · 2025-10-26T08:22:33Z

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

I've made sure the tests are passing.
Testing Strategy
- Unit tests
- Manual tests
- This PR is not tested :(

… and usecases Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

…o-doc

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

…docs/3883-add-apiserver-rety-to-doc

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

…docs/3883-add-apiserver-rety-to-doc

…ection Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 · 2025-11-12T14:25:50Z

cc @machichima @dentiny - Would appreciate your reviews. Thank you!

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

…docs/3883-add-apiserver-rety-to-doc

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

machichima · 2025-11-13T13:20:08Z

cc @CheyuWu
also cc @kenchung285 as you implemented retry in apiserversdk

machichima · 2025-11-13T13:25:53Z

apiserversdk/docs/retry-configuration.md

+```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
+)
+```


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

After discussing offline, we can just document the default behavior here.

Sounds good. I will remove the customization part.

apiserversdk/docs/retry-configuration.md

Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

kenchung285 · 2025-11-15T02:35:57Z

apiserversdk/docs/retry-configuration.md

+
+## Default Retry Behavior
+
+The APIServer automatically retries for these HTTP status codes:


Maybe we can explicitly mention we use exponential backoff when retrying for this transient errors

Sounds good. I will add this part into the paragraph.

…ization parts Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

kenchung285

Because now the document is only for description of the retry behavior without configuration part, we should rename the file

apiserversdk/docs/retry-configuration.md

Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

Copilot

Pull Request Overview

This PR adds documentation for the automatic retry behavior in the KubeRay APIServer V2, which was introduced in previous PRs (#3551 and #3946). The documentation describes the default retry mechanism, including which HTTP status codes trigger retries and the exponential backoff configuration.

Key Changes:

Added comprehensive documentation of the APIServer's automatic retry behavior for transient failures
Documented the exponential backoff algorithm with default configuration values (3 retries, 500ms initial backoff, 2.0 backoff factor, 10s max backoff, 30s overall timeout)
Listed the specific HTTP status codes (408, 429, 500, 502, 503, 504) that trigger automatic retries

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-16T17:50:40Z

apiserversdk/docs/retry-behavior.md

@@ -0,0 +1,31 @@
+# APIServer Retry Behavior
+
+By default, the KubeRay APIServer automatically retries failed requests to the Kubernetes API when transient errors occur.


[nitpick] The phrase "By default" suggests that the retry behavior can be configured or disabled, but based on the code in proxy.go, the retry configuration is hardcoded and cannot be customized by users. Consider either:

Removing "By default" and rephrasing to: "The KubeRay APIServer automatically retries failed requests..."

Adding a note that this behavior is currently not user-configurable

This would set accurate expectations for users reading the documentation.

@copilot open a new pull request to apply changes based on this feedback

apiserversdk/docs/retry-behavior.md

Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

apiserversdk/docs/retry-behavior.md

Copilot

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

kenchung285

LGTM, thanks!

…docs/3883-add-apiserver-rety-to-doc

* [Bug] Sidecar mode shouldn't restart head pod when head pod is deleted (#4141) * [Bug] Sidecar mode shouldn't restart head pod when head pod is deleted Signed-off-by: 400Ping <fourhundredping@gmail.com> * [Fix] Fix e2e error Signed-off-by: 400Ping <fourhundredping@gmail.com> * [Fix] fix according to rueian's comment Signed-off-by: 400Ping <fourhundredping@gmail.com> * [Chore] fix ci error Signed-off-by: 400Ping <fourhundredping@gmail.com> * Update ray-operator/controllers/ray/raycluster_controller.go Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> Signed-off-by: Ping <fourhundredping@gmail.com> * Update ray-operator/controllers/ray/rayjob_controller.go Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> Signed-off-by: Ping <fourhundredping@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * Trigger CI Signed-off-by: Future-Outlier <eric901201@gmail.com> --------- Signed-off-by: 400Ping <fourhundredping@gmail.com> Signed-off-by: Ping <fourhundredping@gmail.com> Signed-off-by: Future-Outlier <eric901201@gmail.com> Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> * fix: dashboard build for kuberay 1.5.0 (#4161) Signed-off-by: Future-Outlier <eric901201@gmail.com> * [Feature Enhancement] Set ordered replica index label to support multi-slice (#4163) * [Feature Enhancement] Set ordered replica index label to support multi-slice Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * rename replica-id -> replica-name Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * Separate replica index feature gate logic Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * remove index arg in createWorkerPod Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> --------- Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * update stale feature gate comments (#4174) Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * [RayCluster] Add more context why we don't recreate head Pod for RayJob (#4175) Signed-off-by: Kai-Hsun Chen <khchen@x.ai> * feature: Remove empty resource list initialization. (#4168) Fixes #4142. * [Dockerfile] [KubeRay Dashboard]: Fix Dockerfile warnings (ENV format, CMD JSON args) (#4167) * [#4166] improvement: Fix Dockerfile warnings (ENV format, CMD JSON args) * extract the hostname from CMD Signed-off-by: Neo Chien <6762509+cchung100m@users.noreply.github.com> --------- Signed-off-by: Neo Chien <6762509+cchung100m@users.noreply.github.com> Co-authored-by: cchung100m <cchung100m@users.noreply.github.com> * [Fix] Resolve int32 overflow by having the calculation in int64 and c… (#4158) * [Fix] Resolve int32 overflow by having the calculation in int64 and cap it if the count is over math.MaxInt32 Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Test] Add unit tests for CalculateReadyReplicas Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Fix] Add a nosec comment to pass the Lint (pre-commit) test Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Refactor] Add CapInt64ToInt32 to replace #nosec directives Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Refactor] Rename function to SafeInt64ToInt32 and add a underflowing prevention (it also help pass the lint test) Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Refactor] Remove the early return as SafeInt64ToInt32 handles the int32 overflow and underflow checking. Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> --------- Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * Add RayService incremental upgrade sample for guide (#4164) Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * Edit RayCluster example config for label selectors (#4151) Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * [RayJob] update light weight submitter image from quay.io (#4181) Signed-off-by: Future-Outlier <eric901201@gmail.com> * [flaky] RayJob fails when head Pod is deleted when job is running (#4182) Signed-off-by: Future-Outlier <eric901201@gmail.com> * [CI] Pin Docker api version to avoid API version mismatch (#4188) Signed-off-by: win5923 <ken89@kimo.com> * Make replicas configurable for kuberay-operator #4180 (#4195) * Make replicas configurable for kuberay-operator #4180 * Make replicas configurable for kuberay-operator #4180 * [Fix] rayjob update raycluster status (#4192) * feat: check if raycluster status update in rayjob * test: e2e test to check the rayjob raycluster status update * fix: dashboard http client tests discovered and passing (#4173) Signed-off-by: alimaazamat <alima.azamat2003@gmail.com> * [RayJob] Lift cluster status while initializing (#4191) Signed-off-by: Spencer Peterson <spencerjp@google.com> * [RayJob] Remove updateJobStatus call (#4198) Fast follow to #4191 Signed-off-by: Spencer Peterson <spencerjp@google.com> * Add support for Ray token auth (#4179) * Add support for Ray token auth Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * add e2e test for Ray cluster auth Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * address nits from Ruiean Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * update RAY_auth_mode -> RAY_AUTH_MODE Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * configure auth for Ray autoscaler Signed-off-by: Andrew Sy Kim <andrewsy@google.com> --------- Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * Bump js-yaml from 4.1.0 to 4.1.1 in /dashboard (#4194) Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 4.1.0 to 4.1.1. - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@4.1.0...4.1.1) --- updated-dependencies: - dependency-name: js-yaml dependency-version: 4.1.1 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update minimum Ray version required for token authentication to 2.52.0 (#4201) * update minimum Ray version required for token authentication to 2.52.0 Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * update RayCluster auth e2e test to use Ray v2.52 Signed-off-by: Andrew Sy Kim <andrewsy@google.com> --------- Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * add samples for RayCluster token auth (#4200) Signed-off-by: Andrew Sy Kim <andrewsy@google.com> * update (#4208) Signed-off-by: Future-Outlier <eric901201@gmail.com> * [RayJob] Add token authentication support for All mode (#4210) * dashboard client authentication support Signed-off-by: Future-Outlier <eric901201@gmail.com> * support rayjob Signed-off-by: Future-Outlier <eric901201@gmail.com> * update to fix api serverr err Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * updarte Signed-off-by: Future-Outlier <eric901201@gmail.com> * Rayjob sidecar mode auth token mode support Signed-off-by: Future-Outlier <eric901201@gmail.com> * RayJob support k8s job mode Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * Address Andrew's advice Signed-off-by: Future-Outlier <eric901201@gmail.com> * add todo x-ray-authorization comments Signed-off-by: Future-Outlier <eric901201@gmail.com> --------- Signed-off-by: Future-Outlier <eric901201@gmail.com> * [RayCluster] Enable Secret informer watch/list and remove unused RBAC verbs (#4202) * Add authentication secret reconciliation support Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * update Signed-off-by: Future-Outlier <eric901201@gmail.com> * fix flaky test Signed-off-by: Future-Outlier <eric901201@gmail.com> * remove test fix Signed-off-by: Rueian <rueiancsie@gmail.com> --------- Signed-off-by: Future-Outlier <eric901201@gmail.com> Signed-off-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Rueian <rueiancsie@gmail.com> * [APIServer][Docs] Add user guide for retry behavior & configuration (#4144) * [Docs] Add the draft description about feature intro, configurations, and usecases Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Fix] Update the retry walk-through Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Doc] rewrite the first 2 sections Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Doc] Revise documentation wording and add Observing Retry Behavior section Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Fix] fix linting issue by running pre-commit run berfore commiting Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Fix] fix linting errors in the Markdown linting Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Fix] Clean up the math equation Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * Update the math formula of Backoff calculation. Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com> * [Fix] Explicitly mentioned exponential backoff and removed the customization parts Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * [Docs] Clarify naming by replacing “APIServer” with “KubeRay APIServer” Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com> * [Docs] Rename retry-configuration.md to retry-behavior.md for accuracy Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> * Update Title to KubeRay APIServer Retry Behavior Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com> * [Docs] Add a note about the limitation of retry configuration Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> --------- Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com> Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> * Support X-Ray-Authorization fallback header for accepting auth token via proxy (#4213) * Support X-Ray-Authorization fallback header for accepting auth token in dashboard Signed-off-by: Future-Outlier <eric901201@gmail.com> * remove todo comment Signed-off-by: Future-Outlier <eric901201@gmail.com> --------- Signed-off-by: Future-Outlier <eric901201@gmail.com> * [RayCluster] make auth token secret name consistency (#4216) Signed-off-by: fscnick <fscnick.dev@gmail.com> * [RayCluster] Status includes head containter status message (#4196) * [RayCluster] Status includes head containter status message Signed-off-by: Spencer Peterson <spencerjp@google.com> * lint Signed-off-by: Spencer Peterson <spencerjp@google.com> * [RayCluster] Containers not ready status reflects structured reason Signed-off-by: Spencer Peterson <spencerjp@google.com> * nit Signed-off-by: Spencer Peterson <spencerjp@google.com> --------- Signed-off-by: Spencer Peterson <spencerjp@google.com> * Remove erroneous call in applyServeTargetCapacity (#4212) Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> * [RayJob] Add token authentication support for light weight job submitter (#4215) * [RayJob] light weight job submitter auth token support Signed-off-by: Future-Outlier <eric901201@gmail.com> * X-Ray-Authorization Signed-off-by: Rueian <rueiancsie@gmail.com> --------- Signed-off-by: Future-Outlier <eric901201@gmail.com> Signed-off-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Rueian <rueiancsie@gmail.com> * feat: kubectl ray get token command (#4218) * feat: kubectl ray get token command Signed-off-by: Rueian <rueiancsie@gmail.com> * Update kubectl-plugin/pkg/cmd/get/get_token_test.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Rueian <rueiancsie@gmail.com> * Update kubectl-plugin/pkg/cmd/get/get_token.go Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Rueian <rueiancsie@gmail.com> * make sure the raycluster exists before getting the secret Signed-off-by: Rueian <rueiancsie@gmail.com> * better ux Signed-off-by: Rueian <rueiancsie@gmail.com> * Update kubectl-plugin/pkg/cmd/get/get_token.go Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> Signed-off-by: Rueian <rueiancsie@gmail.com> --------- Signed-off-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> --------- Signed-off-by: 400Ping <fourhundredping@gmail.com> Signed-off-by: Ping <fourhundredping@gmail.com> Signed-off-by: Future-Outlier <eric901201@gmail.com> Signed-off-by: Ryan O'Leary <ryanaoleary@google.com> Signed-off-by: Andrew Sy Kim <andrewsy@google.com> Signed-off-by: Kai-Hsun Chen <khchen@x.ai> Signed-off-by: Neo Chien <6762509+cchung100m@users.noreply.github.com> Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com> Signed-off-by: win5923 <ken89@kimo.com> Signed-off-by: alimaazamat <alima.azamat2003@gmail.com> Signed-off-by: Spencer Peterson <spencerjp@google.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Rueian <rueiancsie@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com> Signed-off-by: fscnick <fscnick.dev@gmail.com> Co-authored-by: Ping <fourhundredping@gmail.com> Co-authored-by: Han-Ju Chen (Future-Outlier) <eric901201@gmail.com> Co-authored-by: Ryan O'Leary <113500783+ryanaoleary@users.noreply.github.com> Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com> Co-authored-by: Kavish <141061817+kash2104@users.noreply.github.com> Co-authored-by: Neo Chien <6762509+cchung100m@users.noreply.github.com> Co-authored-by: cchung100m <cchung100m@users.noreply.github.com> Co-authored-by: JustinYeh <justinyeh1995@gmail.com> Co-authored-by: Jun-Hao Wan <ken89@kimo.com> Co-authored-by: Divyam Raj <41264059+divyamraj18@users.noreply.github.com> Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Co-authored-by: Alima Azamat <92766804+alimaazamat@users.noreply.github.com> Co-authored-by: Spencer Peterson <spencerjp@google.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Co-authored-by: fscnick <6858627+fscnick@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

[Docs] Add the draft description about feature intro, configurations,…

30234a2

… and usecases Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 changed the title ~~[Docs] Add the document about retryfeature intro, configurations,…~~ [Docs] Add the documentation about retry features, configurations, and usecases Oct 26, 2025

justinyeh1995 changed the title ~~[Docs] Add the documentation about retry features, configurations, and usecases~~ [Docs] Add user guide for APIServer SDK client retry configuration Oct 26, 2025

justinyeh1995 changed the title ~~[Docs] Add user guide for APIServer SDK client retry configuration~~ [apiserversdk][Docs] Add user guide for APIServer SDK client retry configuration Oct 27, 2025

justinyeh1995 added 2 commits October 27, 2025 23:59

Merge branch 'ray-project:master' into docs/3883-add-apiserver-rety-t…

a746d50

…o-doc

[Fix] Update the retry walk-through

14638bd

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 changed the title ~~[apiserversdk][Docs] Add user guide for APIServer SDK client retry configuration~~ [APIServer][Docs] Add user guide for APIServer SDK client retry configuration Oct 30, 2025

justinyeh1995 changed the title ~~[APIServer][Docs] Add user guide for APIServer SDK client retry configuration~~ [APIServer][Docs] Add user guide for retry behavior & configuration Oct 30, 2025

justinyeh1995 added 6 commits October 31, 2025 07:46

Merge branch 'master' of https://github.com/ray-project/kuberay into …

fcfcdf4

…docs/3883-add-apiserver-rety-to-doc

[Doc] rewrite the first 2 sections

8287448

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

Merge branch 'master' of https://github.com/ray-project/kuberay into …

8533fb3

…docs/3883-add-apiserver-rety-to-doc

Merge branch 'master' of https://github.com/ray-project/kuberay into …

6a85ad3

…docs/3883-add-apiserver-rety-to-doc

Merge branch 'master' of https://github.com/ray-project/kuberay into …

5911cc4

…docs/3883-add-apiserver-rety-to-doc

[Doc] Revise documentation wording and add Observing Retry Behavior s…

f656a35

…ection Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 marked this pull request as ready for review November 12, 2025 14:19

justinyeh1995 added 4 commits November 12, 2025 23:19

[Fix] fix linting issue by running pre-commit run berfore commiting

67c1476

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

[Fix] fix linting errors in the Markdown linting

da763de

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

Merge branch 'master' of https://github.com/ray-project/kuberay into …

9f9e3f4

…docs/3883-add-apiserver-rety-to-doc

[Fix] Clean up the math equation

fb4874a

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

machichima reviewed Nov 13, 2025

View reviewed changes

Update the math formula of Backoff calculation.

9ed4b17

Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

kenchung285 reviewed Nov 15, 2025

View reviewed changes

[Fix] Explicitly mentioned exponential backoff and removed the custom…

7640567

…ization parts Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 force-pushed the docs/3883-add-apiserver-rety-to-doc branch from 554a988 to 7640567 Compare November 15, 2025 11:01

justinyeh1995 requested review from kenchung285 and machichima November 16, 2025 04:05

kenchung285 reviewed Nov 16, 2025

View reviewed changes

apiserversdk/docs/retry-configuration.md Outdated Show resolved Hide resolved

justinyeh1995 and others added 2 commits November 16, 2025 17:45

[Docs] Clarify naming by replacing “APIServer” with “KubeRay APIServer”

9a1e786

Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

[Docs] Rename retry-configuration.md to retry-behavior.md for accuracy

784228e

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

CheyuWu approved these changes Nov 16, 2025

View reviewed changes

rueian requested a review from Copilot November 16, 2025 17:47

Copilot started reviewing on behalf of rueian November 16, 2025 17:48 View session

Copilot finished reviewing on behalf of rueian November 16, 2025 17:50

Copilot AI reviewed Nov 16, 2025

View reviewed changes

kenchung285 reviewed Nov 16, 2025

View reviewed changes

apiserversdk/docs/retry-behavior.md Outdated Show resolved Hide resolved

400Ping approved these changes Nov 17, 2025

View reviewed changes

justinyeh1995 and others added 2 commits November 17, 2025 12:06

Update Title to KubeRay APIServer Retry Behavior

5d58086

Co-authored-by: Cheng-Yeh Chung <kenchung285@gmail.com> Signed-off-by: JustinYeh <justinyeh1995@gmail.com>

[Docs] Add a note about the limitation of retry configuration

3e9b06b

Signed-off-by: justinyeh1995 <justinyeh1995@gmail.com>

justinyeh1995 requested review from Copilot and rueian November 17, 2025 05:18

Copilot started reviewing on behalf of justinyeh1995 November 17, 2025 05:18 View session

Copilot finished reviewing on behalf of justinyeh1995 November 17, 2025 05:20

Copilot AI reviewed Nov 17, 2025

View reviewed changes

apiserversdk/docs/retry-behavior.md Show resolved Hide resolved

rueian approved these changes Nov 17, 2025

View reviewed changes

justinyeh1995 requested a review from Copilot November 17, 2025 12:51

Copilot started reviewing on behalf of justinyeh1995 November 17, 2025 12:51 View session

Copilot finished reviewing on behalf of justinyeh1995 November 17, 2025 12:54

Copilot AI reviewed Nov 17, 2025

View reviewed changes

kenchung285 approved these changes Nov 17, 2025

View reviewed changes

Future-Outlier approved these changes Nov 17, 2025

View reviewed changes

Merge branch 'master' of https://github.com/ray-project/kuberay into …

6a5e883

…docs/3883-add-apiserver-rety-to-doc

rueian merged commit c7669d0 into ray-project:master Nov 20, 2025
27 checks passed


		## Default Retry Behavior

		The APIServer automatically retries for these HTTP status codes:

		@@ -0,0 +1,31 @@
		# APIServer Retry Behavior

		By default, the KubeRay APIServer automatically retries failed requests to the Kubernetes API when transient errors occur.

[APIServer][Docs] Add user guide for retry behavior & configuration #4144

[APIServer][Docs] Add user guide for retry behavior & configuration #4144

Uh oh!

Conversation

justinyeh1995 commented Oct 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why are these changes needed?

Related issue number

Checks

Uh oh!

justinyeh1995 commented Nov 12, 2025

Uh oh!

machichima commented Nov 13, 2025

Uh oh!

machichima Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

machichima Nov 15, 2025

Choose a reason for hiding this comment

Uh oh!

justinyeh1995 Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kenchung285 Nov 15, 2025

Choose a reason for hiding this comment

Uh oh!

justinyeh1995 Nov 15, 2025

Choose a reason for hiding this comment

Uh oh!

kenchung285 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

rueian Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

kenchung285 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

justinyeh1995 commented Oct 26, 2025 •

edited

Loading

justinyeh1995 Nov 15, 2025 •

edited

Loading