[Doc] [KubeRay] [RayJob] Add info about submitter pod template (#40158)

Adds information about the JobSubmitterPod to the RayJob documentation. This is an advanced configuration option that was previously only documented in comments in the sample RayJob YAML file. --------- Signed-off-by: Archit Kulkarni <[email protected]> Co-authored-by: Kai-Hsun Chen <[email protected]>
ray-project · Oct 19, 2023 · 2d72609 · 2d72609
1 parent 3c0476a
commit 2d72609
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/source/cluster/kubernetes/getting-started/rayjob-quick-start.md b/doc/source/cluster/kubernetes/getting-started/rayjob-quick-start.md
@@ -147,3 +147,9 @@ helm uninstall kuberay-operator
 # Step 6.3: Delete the Kubernetes cluster
 kind delete cluster
 ```
+
+## Advanced Usage
+
+The Pod template for the Kubernetes Job that runs `ray job submit` can be customized by setting the `submitterPodTemplate` field in the RayJob custom resource. See <https://raw.githubusercontent.com/ray-project/kuberay/master/ray-operator/config/samples/ray_v1alpha1_rayjob.yaml> for an example (commented out in this file).
+
+If `submitterPodTemplate` is unspecified, the Pod will consist of a container named `ray-job-submitter` with image matching that of the Ray head, resource requests of 500m CPU and 200MiB memory, and limits of 1 CPU and 1GiB memory.