[Doc] [KubeRay] [RayJob] Add info about submitter pod template #40158
Conversation
This file contains 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
Signed-off-by: Archit Kulkarni <[email protected]>
architkulkarni
requested review from
wuisawesome,
DmitriGekhtman,
maxpumperla,
pcmoritz,
kevin85421 and
a team
as code owners
kevin85421
approved these changes
Oct 5, 2023
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
There was a problem hiding this comment.
Would you mind adding a link to your benchmark result?
There was a problem hiding this comment.
The benchmark was kind of informal so I don't know if it makes sense to include it in the user-facing documentation. Would you be okay with merging this PR without the benchmark? If you like I can add the link to the benchmark in the KubeRay repo as a code comment.
…rt.md Co-authored-by: Kai-Hsun Chen <[email protected]> Signed-off-by: Archit Kulkarni <[email protected]>
|
GPU doctest failure unrelated. (This PR just adds markdown text) |
architkulkarni
added
the
tests-ok
Looks correct
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
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.
Related issue number
Resolves ray-project/kuberay#1319 (review)
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.