Skip to content

Commit 039d261

Browse files
[Docs] Kuberay Sidecar Mode (#58273)
Signed-off-by: Future-Outlier <[email protected]> Signed-off-by: Han-Ju Chen (Future-Outlier) <[email protected]> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent e466c6f commit 039d261

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/source/cluster/kubernetes/getting-started/rayjob-quick-start.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ To understand the following content better, you should understand the difference
5454
* `K8sJobMode`: The KubeRay operator creates a submitter Kubernetes Job to submit the Ray job.
5555
* `HTTPMode`: The KubeRay operator sends a request to the RayCluster to create a Ray job.
5656
* `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.
57+
* `SidecarMode`: The KubeRay operator injects a container into the Ray head Pod to submit the Ray job. This mode does not support `clusterSelector`, `submitterPodTemplate`, and `submitterConfig`, and requires the head Pod's restart policy to be `Never`.
5758
* `submitterPodTemplate` (Optional): Defines the Pod template for the submitter Kubernetes Job. This field is only effective when `submissionMode` is "K8sJobMode".
5859
* `RAY_DASHBOARD_ADDRESS` - The KubeRay operator injects this environment variable to the submitter Pod. The value is `$HEAD_SERVICE:$DASHBOARD_PORT`.
5960
* `RAY_JOB_SUBMISSION_ID` - The KubeRay operator injects this environment variable to the submitter Pod. The value is the `RayJob.Status.JobId` of the RayJob.

0 commit comments

Comments
 (0)