Skip to content

[Doc][KubeRay] Add a doc for scheduler plugins#53846

Merged
jjyao merged 5 commits intoray-project:masterfrom
kevin85421:20250615-devbox1-tmux1-ray1
Jun 19, 2025
Merged

[Doc][KubeRay] Add a doc for scheduler plugins#53846
jjyao merged 5 commits intoray-project:masterfrom
kevin85421:20250615-devbox1-tmux1-ray1

Conversation

@kevin85421
Copy link
Copy Markdown
Member

@kevin85421 kevin85421 commented Jun 16, 2025 •
edited
Loading

Why are these changes needed?

Add a doc for scheduler plugins

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@kevin85421
update
e92659a 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
MortalHappiness
MortalHappiness reviewed Jun 16, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@MortalHappiness MortalHappiness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc build failed. You need to add this doc to toctree.

doc/source/cluster/kubernetes/k8s-ecosystem/scheduler-plugins.md Outdated

Note that there are two modes for installing the scheduler plugins: **single scheduler mode** or **second scheduler mode**.

For KubeRay v1.4.0, KubeRay only supports the **single scheduler mode**.
Copy link
Copy Markdown
Member

@MortalHappiness MortalHappiness Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you already tried both modes and confirmed that it only works with the single scheduler mode?

Copy link
Copy Markdown
Member Author

@kevin85421 kevin85421 Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tried the second scheduler mode. I am referring to https://scheduler-plugins.sigs.k8s.io/docs/user-guide/installation/:

image

I can give it a try.

Copy link
Copy Markdown
Member Author

@kevin85421 kevin85421 Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't work with the second scheduler although Step 4 is the same.

I tried to deploy a RayCluster with 1 CPU for the head Pod and 1000 CPUs for the worker Pods. The head Pod will still be scheduled when gang scheduling is enabled.

@kevin85421
update
5c667ac 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
@kevin85421
update
d0715b6 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
@kevin85421 kevin85421 marked this pull request as ready for review June 16, 2025 17:58
@kevin85421 kevin85421 requested review from a team and pcmoritz as code owners June 16, 2025 17:58
@kevin85421 kevin85421 added the go add ONLY when ready to merge, run all tests label Jun 16, 2025
MortalHappiness
MortalHappiness approved these changes Jun 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@MortalHappiness MortalHappiness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved from technical side. Waiting for doc team's approval.

@kevin85421
Copy link
Copy Markdown
Member Author

kevin85421 commented Jun 18, 2025

cc @dayshah would you mind approving this PR? Thanks!

angelinalg
angelinalg approved these changes Jun 18, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some style nits. Thank you for contributing to docs.

kevin85421 and others added 2 commits June 18, 2025 14:19
@kevin85421 @angelinalg
Apply suggestions from code review
4310742 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421
update
35d127d 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
@kevin85421
Copy link
Copy Markdown
Member Author

kevin85421 commented Jun 18, 2025

Thanks @MortalHappiness @angelinalg for the review!

@kevin85421
Copy link
Copy Markdown
Member Author

kevin85421 commented Jun 19, 2025

cc @jjyao @edoakes would you mind merging this PR? Thanks!

@jjyao jjyao merged commit 840fb8a into ray-project:master Jun 19, 2025
5 checks passed
minerharry pushed a commit to minerharry/ray that referenced this pull request Jun 27, 2025
@kevin85421 @angelinalg @minerharry
[Doc][KubeRay] Add a doc for scheduler plugins (ray-project#53846)
7069d4c 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
elliot-barn pushed a commit that referenced this pull request Jul 2, 2025
@kevin85421 @angelinalg @elliot-barn
[Doc][KubeRay] Add a doc for scheduler plugins (#53846)
d01edf0 
Signed-off-by: kaihsun <kaihsun@anyscale.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MortalHappiness MortalHappiness MortalHappiness approved these changes

@angelinalg angelinalg angelinalg approved these changes

@pcmoritz pcmoritz Awaiting requested review from pcmoritz

Assignees

@MortalHappiness MortalHappiness

Labels

go add ONLY when ready to merge, run all tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kevin85421 @MortalHappiness @angelinalg @jjyao