[doc] Add KubeRay ecosystem #433

seanlaii · 2025-12-22T19:29:40Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
/kind documentation
What this PR does / why we need it:
KubeRay has integrated with Volcano to support gang-scheduling and network topology aware scheduling features.
We would like to a guideline in volcano's documentation.
Which issue(s) this PR fixes:
[Docs] Add KubeRay ecosystem doc in Volcano ray-project/kuberay#4289

volcano-sh-bot · 2025-12-22T19:29:52Z

Welcome @seanlaii! It looks like this is your first PR to volcano-sh/website 🎉

gemini-code-assist · 2025-12-22T19:29:55Z

Summary of Changes

Hello @seanlaii, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces new documentation that outlines the integration of KubeRay with Volcano, a powerful batch scheduler for Kubernetes. The added guide explains how this integration, available since KubeRay v1.5.1, enables advanced scheduling capabilities such as gang scheduling and network topology awareness for Ray workloads, thereby optimizing resource allocation and performance for distributed AI/ML applications running on Kubernetes.

Highlights

New Documentation: A comprehensive guide has been added detailing the integration of KubeRay with Volcano, a batch scheduler for Kubernetes.
Volcano Integration Details: The documentation explains how KubeRay v1.5.1 and later versions support gang scheduling and network topology-aware scheduling for RayJob and RayCluster resources through Volcano.
Configuration and Examples: The guide includes prerequisites, supported labels for configuring Volcano scheduling (e.g., ray.io/scheduler-name: volcano), and practical deployment examples for both RayCluster and RayJob.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds documentation for integrating KubeRay with Volcano. The new page provides a comprehensive guide, including an introduction to KubeRay, setup instructions, configuration details, and example deployments for RayCluster and RayJob. The documentation is well-structured and clear. I have one suggestion to adjust the menu weight to avoid conflicts with existing documentation pages.

content/en/docs/kuberay_on_volcano.md

seanlaii · 2025-12-22T19:39:30Z

Hi @win5923 @JesseStutler , could you take a look when you have a chance? Thank you!

JesseStutler · 2025-12-23T06:36:15Z

@seanlaii Does this pr have rendering problem? I see that all the netlify CI failed

JesseStutler · 2025-12-23T06:36:44Z

@seanlaii BTW, could you also add a Chinese version doc? Thanks!

JesseStutler · 2025-12-23T06:38:55Z

content/en/docs/ray_on_volcano.md

+# test-cluster-0-head-jj9bg            1/1     Running   0          36s
+```
+
+##### RayJob Example


Could you also add vcjob example? https://github.com/volcano-sh/volcano/blob/master/docs/user-guide/how_to_use_ray_plugin.md, in volcano v1.13 version, we have also supported using vcjob to create raycluster

Sure, added.

seanlaii · 2025-12-23T18:59:16Z

@seanlaii Does this pr have rendering problem? I see that all the netlify CI failed

I think it might be rate limited. It is working now.

seanlaii · 2025-12-23T19:00:52Z

@seanlaii BTW, could you also add a Chinese version doc? Thanks!

Sure, I will add it once the English version is reviewed. Please let me know if you have any feedback on the English version. Thanks!

cc @win5923

content/en/docs/ray_on_volcano.md

win5923

LGTM for the KubeRay part, thanks for your effort!

Signed-off-by: seanlaii <[email protected]>

seanlaii · 2025-12-24T20:53:53Z

@win5923 Thanks for the review!
@JesseStutler I have updated the doc and added the Chinese version. Please take a look when you have a chance. Thanks!

JesseStutler · 2025-12-25T04:02:51Z

/approve
/lgtm
Thanks for your effort!

volcano-sh-bot · 2025-12-25T04:02:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JesseStutler, win5923

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [JesseStutler]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

JesseStutler · 2025-12-27T03:16:38Z

content/zh/docs/ray_on_volcano.md

+# Add menu entry to sidebar.
+linktitle = "Ray"
+[menu.docs]
+  parent = "ecosystem"


I didn't find the zh doc in the website, I saw that the parent in other zh docs under "生态" is called "zoology", which is very weird, could you help us fix it and submit a new PR?

Sure, will send a PR.

volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Dec 22, 2025

volcano-sh-bot requested review from Arhell and k82cn December 22, 2025 19:29

volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 22, 2025

gemini-code-assist bot reviewed Dec 22, 2025

View reviewed changes

content/en/docs/kuberay_on_volcano.md Outdated Show resolved Hide resolved

seanlaii force-pushed the kuberay-eco branch from db06fa1 to a2bc05c Compare December 22, 2025 19:35

seanlaii force-pushed the kuberay-eco branch 3 times, most recently from cccd97a to f3dc97a Compare December 23, 2025 04:01

JesseStutler reviewed Dec 23, 2025

View reviewed changes

win5923 mentioned this pull request Dec 23, 2025

Clean up unused label for volcano scheduler ray-project/kuberay#4305

Merged

4 tasks

seanlaii force-pushed the kuberay-eco branch 2 times, most recently from 02c7f47 to 46c8c28 Compare December 23, 2025 18:57

win5923 reviewed Dec 24, 2025

View reviewed changes

content/en/docs/ray_on_volcano.md Show resolved Hide resolved

win5923 approved these changes Dec 24, 2025

View reviewed changes

[doc] Add KubeRay ecosystem

2a1c482

Signed-off-by: seanlaii <[email protected]>

seanlaii force-pushed the kuberay-eco branch from 46c8c28 to 2a1c482 Compare December 24, 2025 20:51

volcano-sh-bot assigned JesseStutler Dec 25, 2025

volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 25, 2025

volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 25, 2025

volcano-sh-bot merged commit 7e0416c into volcano-sh:master Dec 25, 2025
6 checks passed

seanlaii deleted the kuberay-eco branch December 25, 2025 20:45

JesseStutler reviewed Dec 27, 2025

View reviewed changes

[doc] Add KubeRay ecosystem #433

[doc] Add KubeRay ecosystem #433

Uh oh!

Conversation

seanlaii commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

volcano-sh-bot commented Dec 22, 2025

Uh oh!

gemini-code-assist bot commented Dec 22, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

seanlaii commented Dec 22, 2025

Uh oh!

JesseStutler commented Dec 23, 2025

Uh oh!

JesseStutler commented Dec 23, 2025

Uh oh!

JesseStutler Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

seanlaii Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

seanlaii commented Dec 23, 2025

Uh oh!

seanlaii commented Dec 23, 2025

Uh oh!

Uh oh!

win5923 left a comment

Choose a reason for hiding this comment

Uh oh!

seanlaii commented Dec 24, 2025

Uh oh!

JesseStutler commented Dec 25, 2025

Uh oh!

volcano-sh-bot commented Dec 25, 2025

Uh oh!

Uh oh!

JesseStutler Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

seanlaii Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

seanlaii commented Dec 22, 2025 •

edited

Loading