[Docs][KubeRay] Update changes from KubeRay 1.3.2 to 1.4.0 #53886
Conversation
This file contains hidden or 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: Chi-Sheng Liu <chishengliu@chishengliu.com>
34e4cb2 to
0f3b075
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for KubeRay from version 1.3.2 to 1.4.0 by revising default parameter tables for both the kubectl plugin and the quick-start notebook.
- Updated default values in tables to reflect Ray version 2.46.0 and added additional parameters for head and worker configurations.
- Revised instructions in the quick-start notebook for ARM64 (Apple Silicon) usage.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md | Updated default parameter table and improved explanatory text |
| doc/source/cluster/kubernetes/getting-started/raycluster-quick-start.ipynb | Clarified installation instructions for ARM64 users |
Comments suppressed due to low confidence (1)
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md:50
- [nitpick] Consider revising the phrasing 'The default values are follows' to 'The default values are as follows' to improve readability.
The `kubectl ray create cluster` command allows you to create a valid RayCluster without an existing YAML file. The default values are follows (empty values mean unset):
Signed-off-by: Chi-Sheng Liu <chishengliu@chishengliu.com>
MortalHappiness
commented
Jun 19, 2025
Comment on lines
87
to
96
| You can also override the default values with a config file. For example, the following config file sets the worker CPU to 3. | ||
|
|
||
| ```text | ||
| $ curl -LO https://raw.githubusercontent.com/ray-project/kuberay/refs/tags/v1.4.0/kubectl-plugin/config/samples/create-cluster.sample.yaml | ||
| $ kubectl ray create cluster raycluster-sample-3 --file create-cluster.sample.yaml | ||
| Created Ray Cluster: raycluster-sample-3 | ||
| ``` | ||
|
|
||
| See https://github.com/ray-project/kuberay/blob/v1.4.0/kubectl-plugin/config/samples/create-cluster.complete.yaml for the complete list of parameters that can be set in the config file. | ||
|
|
There was a problem hiding this comment.
Related to ray-project/kuberay#3804
|
@kevin85421 gentle ping |
kevin85421
approved these changes
Jun 24, 2025
angelinalg
approved these changes
Jun 24, 2025
doc/source/cluster/kubernetes/getting-started/raycluster-quick-start.ipynb
Outdated
Show resolved
Hide resolved
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Chi-Sheng Liu <chishengliu@chishengliu.com>
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?
As title. Update all user-facing docs about the changes from KubeRay 1.3.2 to 1.4.0
Related issue number
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.