[Docs] add docs for prerunning deadline for Kuberay#61552
Merged
edoakes merged 2 commits intoray-project:masterfrom Mar 9, 2026
Merged
[Docs] add docs for prerunning deadline for Kuberay#61552edoakes merged 2 commits intoray-project:masterfrom
edoakes merged 2 commits intoray-project:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the new preRunningDeadlineSeconds field in KubeRay. The documentation is added to the RayJob quickstart guide and the kubectl plugin user guide. The changes are clear and accurately describe the new feature. I have one minor suggestion to improve consistency in the documentation style.
Note: Security Review has been skipped due to the limited scope of the PR.
doc/source/cluster/kubernetes/getting-started/rayjob-quick-start.md
Outdated
Show resolved
Hide resolved
Signed-off-by: machichima <nary12321@gmail.com>
db15b8a to
83a82ea
Compare
4 tasks
Future-Outlier
approved these changes
Mar 7, 2026
Member
Future-Outlier
left a comment
There was a problem hiding this comment.
LGTM, cc @edoakes to merge.
win5923
reviewed
Mar 7, 2026
| * `K8sJobMode`: The KubeRay operator creates a submitter Kubernetes Job to submit the Ray job. | ||
| * `HTTPMode`: The KubeRay operator sends a request to the RayCluster to create a Ray job. | ||
| * `InteractiveMode`: The KubeRay operator waits for the user to submit a job to the RayCluster. This mode is currently in alpha and the [KubeRay kubectl plugin](kubectl-plugin) relies on it. | ||
| * `InteractiveMode`: The KubeRay operator waits for the user to submit a job to the RayCluster. This mode is currently in alpha and the [KubeRay kubectl plugin](kubectl-plugin) relies on it. To avoid RayJobs staying in `Initializing` or `Waiting` for too long, set `preRunningDeadlineSeconds`. |
Member
There was a problem hiding this comment.
Suggested change
| * `InteractiveMode`: The KubeRay operator waits for the user to submit a job to the RayCluster. This mode is currently in alpha and the [KubeRay kubectl plugin](kubectl-plugin) relies on it. To avoid RayJobs staying in `Initializing` or `Waiting` for too long, set `preRunningDeadlineSeconds`. | |
| * `InteractiveMode`: The KubeRay operator waits for the user to submit a job to the RayCluster. This mode is currently in alpha and the [KubeRay kubectl plugin](kubectl-plugin) relies on it. |
I think we should remove this sentence. The other submissionMode (K8sJobMode, HTTPMode, SidecarMode) only describe the mode itself and don't cross-reference unrelated fields. Also, preRunningDeadlineSeconds applies to all modes, not just InteractiveMode, so calling it out here is misleading. Its own definition in the Automatic resource cleanup section is sufficient.
| * `submitterConfig` (Optional): Additional configurations for the submitter Kubernetes Job. | ||
| * `backoffLimit` (Optional, added in version 1.2.0): The number of retries before marking the submitter Job as failed. The default value is 2. | ||
| * Automatic resource cleanup | ||
| * `preRunningDeadlineSeconds` (Optional): Maximum number of seconds a RayJob can remain before reaching `Running`. If the RayJob does not transition to `Running` within this deadline (for example, while in `Initializing` or `Waiting`), the KubeRay operator transitions the `JobDeploymentStatus` to `Failed` with reason `PreRunningDeadlineExceeded`. The default value is 0 (no pre-running deadline is enforced). |
Member
There was a problem hiding this comment.
Suggested change
| * `preRunningDeadlineSeconds` (Optional): Maximum number of seconds a RayJob can remain before reaching `Running`. If the RayJob does not transition to `Running` within this deadline (for example, while in `Initializing` or `Waiting`), the KubeRay operator transitions the `JobDeploymentStatus` to `Failed` with reason `PreRunningDeadlineExceeded`. The default value is 0 (no pre-running deadline is enforced). | |
| * `preRunningDeadlineSeconds` (Optional): If the RayJob doesn't transition the `JobDeploymentStatus` to Running within `preRunningDeadlineSeconds` seconds, the KubeRay operator transitions the `JobDeploymentStatus` to Failed with reason `PreRunningDeadlineExceeded`. |
I think the description can follow the same pattern as activeDeadlineSeconds for consistency. WDYT?
slfan1989
approved these changes
Mar 8, 2026
Signed-off-by: machichima <nary12321@gmail.com>
ParagEkbote
pushed a commit
to ParagEkbote/ray
that referenced
this pull request
Mar 10, 2026
## Description We introduce new config field `preRunningDeadlineSeconds` in ray-project/kuberay#4525. This PR add the related docs. ## Related issues Related to ray-project/kuberay#4525 ## Additional information docs link: - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/getting-started/rayjob-quick-start.html#rayjob-configuration - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/user-guides/kubectl-plugin.html#submit-a-ray-job-without-a-yaml-file --------- Signed-off-by: machichima <nary12321@gmail.com> Signed-off-by: Parag Ekbote <thecoolekbote189@gmail.com>
abrarsheikh
pushed a commit
that referenced
this pull request
Mar 11, 2026
## Description We introduce new config field `preRunningDeadlineSeconds` in ray-project/kuberay#4525. This PR add the related docs. ## Related issues Related to ray-project/kuberay#4525 ## Additional information docs link: - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/getting-started/rayjob-quick-start.html#rayjob-configuration - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/user-guides/kubectl-plugin.html#submit-a-ray-job-without-a-yaml-file --------- Signed-off-by: machichima <nary12321@gmail.com>
ryanaoleary
pushed a commit
to ryanaoleary/ray
that referenced
this pull request
Mar 13, 2026
## Description We introduce new config field `preRunningDeadlineSeconds` in ray-project/kuberay#4525. This PR add the related docs. ## Related issues Related to ray-project/kuberay#4525 ## Additional information docs link: - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/getting-started/rayjob-quick-start.html#rayjob-configuration - https://anyscale-ray--61552.com.readthedocs.build/en/61552/cluster/kubernetes/user-guides/kubectl-plugin.html#submit-a-ray-job-without-a-yaml-file --------- Signed-off-by: machichima <nary12321@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Description
We introduce new config field
preRunningDeadlineSecondsin ray-project/kuberay#4525. This PR add the related docs.Related issues
Related to ray-project/kuberay#4525
Additional information
docs link: