[Docs][KubeRay] Add Volcano RayJob gang scheduling example #58320
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a new documentation section demonstrating how to use Volcano for gang scheduling with RayJob. The example is clear and walks through a practical scenario. I've provided a few suggestions to improve clarity, consistency, and the long-term stability of the documentation, such as using versioned URLs for examples and clarifying the description of the sample YAML file.
| First, Create a RayJob | ||
|
|
||
| ```shell | ||
| curl -LO https://raw.githubusercontent.com/ray-project/kuberay/master/ray-operator/config/samples/ray-job.volcano-scheduler-queue.yaml |
There was a problem hiding this comment.
The URL for the sample YAML file points to the master branch. For documentation, it's a best practice to link to a specific version tag (e.g., v1.5.0) instead of a branch. This ensures that the example remains valid and reproducible even if the file on the master branch changes in the future.
| curl -LO https://raw.githubusercontent.com/ray-project/kuberay/master/ray-operator/config/samples/ray-job.volcano-scheduler-queue.yaml | |
| curl -LO https://raw.githubusercontent.com/ray-project/kuberay/v1.5.0/ray-operator/config/samples/ray-job.volcano-scheduler-queue.yaml |
There was a problem hiding this comment.
Yes, changed to use v1.5.0-rc.0.
b58c683
|
Hi @Future-Outlier and @rueian ,PTAL when you have time. Thanks! |
win5923
force-pushed
the
rayjob-volcano
branch
from
ad81daa to
99d7bb0
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: win5923 <ken89@kimo.com>
win5923
force-pushed
the
rayjob-volcano
branch
from
547a2a5 to
d8270b2
Compare
ray-gardener
bot
added
core
Future-Outlier
left a comment
Future-Outlier
left a comment
There was a problem hiding this comment.
overall LGTM, thank you!!!
@win5923
| First, Create a RayJob | ||
|
|
||
| ```shell | ||
| curl -LO https://raw.githubusercontent.com/ray-project/kuberay/master/ray-operator/config/samples/ray-job.volcano-scheduler-queue.yaml |
| ### Step 6: Use Volcano for RayJob gang scheduling | ||
|
|
There was a problem hiding this comment.
I think it's a little bit weird to use Step 6, instead, can we just use Use Volcano for RayJob gang scheduling?
Signed-off-by: win5923 <ken89@kimo.com>
|
Will update Yunikorn's in another PR. thanks for the review! |
Future-Outlier
left a comment
Future-Outlier
left a comment
There was a problem hiding this comment.
LGTM, cc @jjyao for merge.
win5923
changed the title
…ct#58320) Signed-off-by: win5923 <ken89@kimo.com>
…ct#58320) Signed-off-by: win5923 <ken89@kimo.com>
…ct#58320) Signed-off-by: win5923 <ken89@kimo.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>
…ct#58320) Signed-off-by: win5923 <ken89@kimo.com>
4 participants
Description
Starting with KubeRay 1.5.0, KubeRay supports gang scheduling for RayJob custom resources.
Add a example in KubeRay integration with Volcano doc.
Related issues
Related to ray-project/kuberay#3972
Additional information
None.