[Doc][KuberRay] add doc for kuberay with uv #53303

fscnick · 2025-05-25T15:31:03Z

Why are these changes needed?

To provide the guide for the user who wants to use uv with kuberay.

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 :(

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick · 2025-05-25T15:33:07Z

The version 1.4.0 is not released yet. Use nightly instead.

Signed-off-by: fscnick <fscnick.dev@gmail.com>

saloni-garg · 2025-05-27T01:41:27Z

doc/source/cluster/kubernetes/k8s-ecosystem/uv.md

+
+This guide is the basic setting about how to build a custom image with uv as a package manager. For best practices, please reference https://github.com/astral-sh/uv-docker-example.
+
+The following example uses `kind` and `helm` to demostrate deploying to kubernetes.


~~demostrate~~ demonstrate :)

saloni-garg · 2025-05-27T01:44:29Z

doc/source/cluster/kubernetes/k8s-ecosystem/uv.md

+kind load docker-image ray-uv:demo
+```
+
+Prepare RayCluster yaml file `ray-cluster.uv.yaml` with the following steps:


Thanks for the detailed guide, would be really awesome if we also add an example ray-cluster.uv.yaml file. Or just a short example inline.

Thanks for reviewing it. I have added an example below.

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick · 2025-05-27T15:44:22Z

@kevin85421 PTAL

kevin85421

why do we need to build an image?

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick · 2025-05-30T17:04:16Z

why do we need to build an image?

It seems not necessary to build an image because the more recent image has shipped with uv already. I have remove building the image from the guide.

Additionally, here is the screenshot of result.

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick · 2025-05-31T08:39:21Z

Discuss @kevin85421 move ray-cluster.uv.yaml to ray-project/kuberay#3720. Left some steps here.

MortalHappiness

LGTM from the technical aspect. Still need the doc team's review.

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

kevin85421

Hi @fscnick,

I pushed a commit to this branch: 5b1cc3b. Can you:

verify whether the instructions work or not
fix Vale issues if any
move the file to https://docs.ray.io/en/latest/cluster/kubernetes/user-guides.html because uv integration is a Ray feature.

Thanks!

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick · 2025-06-02T16:02:00Z

Hi @fscnick,

I pushed a commit to this branch: 5b1cc3b. Can you:

verify whether the instructions work or not

fix Vale issues if any

move the file to https://docs.ray.io/en/latest/cluster/kubernetes/user-guides.html because uv integration is a Ray feature.

Thanks!

Hi @kevin85421,

I have verified the instructions except using nightly build, fixing vale and moving to user-guides.

kevin85421

Nice!

dstrodtman · 2025-06-02T17:22:44Z

.vale.ini

@@ -19,3 +19,6 @@ Google.Colons = No
 # TODO(@bveeramani): We're temporarily disabling "Heading". In the future, we'll update
 # all headings and enable this rule.
 Google.Headings = No
+
+# Ignore the (xxx-xxx...)= in a file because it is doc ref.


Suggested change

# Ignore the (xxx-xxx...)= in a file because it is doc ref.

# Ignores the pattern `(xxx-xxx...)=` used as anchors for headers.

Please confirm this is correct.

@fscnick Could you open an issue and a follow-up PR for the change to .vale.ini? We can remove the change from this PR.

It's OK if (kuberay-uv)= doesn't follow Vale rules—this usage appears throughout the entire codebase.

Opened. #53516

doc/source/cluster/kubernetes/user-guides/uv.md

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

Co-authored-by: Douglas Strodtman <douglas@anyscale.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

kevin85421 · 2025-06-02T17:38:00Z

cc @pcmoritz Just a heads-up: we’ll start promoting uv starting with KubeRay v1.4.0, which is coming out soon.

kevin85421 · 2025-06-02T17:44:59Z

@dstrodtman would you mind approving this PR if it looks good to you? Thanks!

doc/source/cluster/kubernetes/user-guides/uv.md

dstrodtman · 2025-06-02T17:55:49Z

doc/source/cluster/kubernetes/user-guides/uv.md

+# ['Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍', 'Python is 👍']
+```
+
+> NOTE: Use `/bin/bash -c` to execute the command while changing the current directory to `/home/ray/samples`. The default `working_dir` would be the current directory.


Just confirming: this instruction and description are to let the user set the working_dir to /home/ray/samples

doc/source/cluster/kubernetes/user-guides/uv.md

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

kevin85421 · 2025-06-02T18:17:20Z

@dstrodtman thank you for the quick review!

pcmoritz · 2025-06-02T18:17:32Z

doc/source/cluster/kubernetes/user-guides/uv.md

+```
+
+The `ray-cluster.uv.yaml` YAML file contains a RayCluster custom resource and a ConfigMap that includes a sample Ray Python script.
+* The `RAY_RUNTIME_ENV_HOOK` feature flag enables the `uv` integration in Ray. Future versions may enable this by default.


Yes that's right, the PR for this has actually already been merged #53060, will be released with Ray 2.47 :)

Obviously we need to leave this in the docs right now, but after Ray 2.47 is released let's add a note that this is not needed any more in Ray >= 2.47.

open an issue to track the progress: ray-project/kuberay#3732

kevin85421 · 2025-06-02T20:46:15Z

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

[Doc][KuberRay] add doc for kuberay with uv

663afd8

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick added 2 commits May 26, 2025 22:32

[Doc][KubeRay] add uv doc to toctree

2cd37a5

Signed-off-by: fscnick <fscnick.dev@gmail.com>

Merge remote-tracking branch 'upstream/master' into add-kuberay-uv-doc

86fa587

Signed-off-by: fscnick <fscnick.dev@gmail.com>

saloni-garg reviewed May 27, 2025

View reviewed changes

fscnick added 4 commits May 27, 2025 21:47

[Doc][KubeRay] add example yaml

582fe84

Signed-off-by: fscnick <fscnick.dev@gmail.com>

[Doc][KubeRay] revise replicas

12bd3e3

Signed-off-by: fscnick <fscnick.dev@gmail.com>

Merge remote-tracking branch 'upstream/master' into add-kuberay-uv-doc

6259269

Signed-off-by: fscnick <fscnick.dev@gmail.com>

[Doc][KubeRay] add kuberay-uv ref

b6d0128

Signed-off-by: fscnick <fscnick.dev@gmail.com>

fscnick marked this pull request as ready for review May 27, 2025 15:44

fscnick requested review from pcmoritz, kevin85421 and a team as code owners May 27, 2025 15:44

kevin85421 reviewed May 28, 2025

View reviewed changes

[Doc][KubeRay] remove building image part from the guide

ee5c85a

Signed-off-by: fscnick <fscnick.dev@gmail.com>

kevin85421 mentioned this pull request May 31, 2025

[Doc] add ray cluster uv sample yaml ray-project/kuberay#3720

Merged

4 tasks

[Doc][KubeRay] remove example ray-cluster.uv.yaml in doc

972149c

Signed-off-by: fscnick <fscnick.dev@gmail.com>

MortalHappiness approved these changes May 31, 2025

View reviewed changes

Update uv.md

5b1cc3b

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

kevin85421 reviewed Jun 1, 2025

View reviewed changes

fscnick added 4 commits June 2, 2025 21:34

[Doc][KubeRay] move uv.md to user-guides

97501f3

Signed-off-by: fscnick <fscnick.dev@gmail.com>

[Doc][KubeRay] fix vale

1f2e119

Signed-off-by: fscnick <fscnick.dev@gmail.com>

[Doc][KubeRay] vale ignore doc ref in markdown

d7cb8f7

Signed-off-by: fscnick <fscnick.dev@gmail.com>

Merge remote-tracking branch 'upstream/master' into add-kuberay-uv-doc

703fc14

Signed-off-by: fscnick <fscnick.dev@gmail.com>

kevin85421 approved these changes Jun 2, 2025

View reviewed changes

dstrodtman reviewed Jun 2, 2025

View reviewed changes

doc/source/cluster/kubernetes/user-guides/uv.md Outdated Show resolved Hide resolved

kevin85421 and others added 2 commits June 2, 2025 10:33

Update .vale.ini

461386c

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

Update doc/source/cluster/kubernetes/user-guides/uv.md

79bd112

Co-authored-by: Douglas Strodtman <douglas@anyscale.com> Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

kevin85421 requested a review from dstrodtman June 2, 2025 17:35

kevin85421 added the go add ONLY when ready to merge, run all tests label Jun 2, 2025

dstrodtman reviewed Jun 2, 2025

View reviewed changes

Update uv.md

4da889d

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>

pcmoritz reviewed Jun 2, 2025

View reviewed changes

pcmoritz approved these changes Jun 2, 2025

View reviewed changes

jjyao merged commit d384e77 into ray-project:master Jun 2, 2025
5 checks passed

fscnick deleted the add-kuberay-uv-doc branch June 3, 2025 11:49


		This guide is the basic setting about how to build a custom image with uv as a package manager. For best practices, please reference https://github.com/astral-sh/uv-docker-example.

		The following example uses `kind` and `helm` to demostrate deploying to kubernetes.

	# Ignore the (xxx-xxx...)= in a file because it is doc ref.
	# Ignores the pattern `(xxx-xxx...)=` used as anchors for headers.

[Doc][KuberRay] add doc for kuberay with uv #53303

[Doc][KuberRay] add doc for kuberay with uv #53303

Uh oh!

Conversation

fscnick commented May 25, 2025

Why are these changes needed?

Related issue number

Checks

Uh oh!

fscnick commented May 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fscnick commented May 27, 2025

Uh oh!

kevin85421 left a comment

Choose a reason for hiding this comment

Uh oh!

fscnick commented May 30, 2025

Uh oh!

fscnick commented May 31, 2025

Uh oh!

MortalHappiness left a comment

Choose a reason for hiding this comment

Uh oh!

kevin85421 left a comment

Choose a reason for hiding this comment

Uh oh!

fscnick commented Jun 2, 2025

Uh oh!

kevin85421 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kevin85421 commented Jun 2, 2025

Uh oh!

kevin85421 commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kevin85421 commented Jun 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevin85421 commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!