[doc][kuberay] state rayStartParams is optional starting with KubeRay 1.4.0
#53943
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
davidxia
commented
Jun 19, 2025
doc/source/cluster/kubernetes/user-guides/persist-kuberay-custom-resource-logs.md
Outdated
Show resolved
Hide resolved
|
cc @MortalHappiness would you mind reviewing this PR? Thanks! |
doc/source/cluster/kubernetes/user-guides/configuring-autoscaling.ipynb
Outdated
Show resolved
Hide resolved
doc/source/cluster/kubernetes/user-guides/persist-kuberay-custom-resource-logs.md
Outdated
Show resolved
Hide resolved
9600cc8 to
c127d0d
Compare
doc/source/cluster/kubernetes/user-guides/persist-kuberay-custom-resource-logs.md
Outdated
Show resolved
Hide resolved
MortalHappiness
approved these changes
Jun 20, 2025
kevin85421
reviewed
Jun 20, 2025
There was a problem hiding this comment.
Remove the following comments from the YAML files. We can also remove rayStartParams: {} directly. I just want to avoid having the same comment appear in multiple places, as it may be hard to maintain if we decide to update it later.
# rayStartParams is optional with RayCluster CRD from KubeRay 1.4.0 or later but required in earlier versions.
# rayStartParams: {}
kevin85421
reviewed
Jun 20, 2025
doc/source/cluster/kubernetes/user-guides/persist-kuberay-custom-resource-logs.md
Outdated
Show resolved
Hide resolved
|
Have you installed Vale? |
e52a991 to
0a54f2c
Compare
Yes, as a VS Code extension. I don't see any Vale warnings for the changes. |
|
I have already requested the Ray doc team to review. |
dayshah
approved these changes
Jun 24, 2025
doc/source/cluster/kubernetes/user-guides/configuring-autoscaling.ipynb
Outdated
Show resolved
Hide resolved
| @@ -971,6 +971,11 @@ | |||
| "Earlier versions only support `rayStartParams` or resource limits, and don't recognize resource requests.\n", | |||
| "```\n", | |||
| "\n", | |||
| "```{admonition} rayStartParams is optional if using autoscaler image with Ray 2.45.0 or later.\n", | |||
| "`rayStartParams` is optional with RayCluster CRD from KubeRay 1.4.0 or later but required in earlier versions.\n", | |||
| "If you omit `rayStartParams` and want to use autoscaling, the autoscaling image must have Ray 2.45.0 or later.\n", | |||
There was a problem hiding this comment.
sounds like this is repeated from right above?
There was a problem hiding this comment.
I think they're about related but different things. The paragraph above this one is about resource limits being optional. This paragraph is about rayStartParams being optional. Lmk what you think?
angelinalg
approved these changes
Jun 24, 2025
|
Added suggested edits and rebased on master. |
|
Fixed the conflicts. Ready for another review. Thanks! |
…ay 1.4.0 but that if autoscaling is used, the autoscaler image must have Ray 2.45.0 or later. closes ray-project/kuberay#3580 Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Signed-off-by: David Xia <david@davidxia.com>
|
cc @davidxia please ping me when all CI tests pass. Thanks. |
elliot-barn
pushed a commit
that referenced
this pull request
Jul 7, 2025
…ay 1.4.0 (#53943) but that if autoscaling is used, the autoscaler image must have Ray 2.45.0 or later. closes ray-project/kuberay#3580 ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] 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. - [x] 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 - [x] Unit tests - [ ] Release tests - [ ] This PR is not tested :( Signed-off-by: David Xia <david@davidxia.com> Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
ccmao1130
pushed a commit
to ccmao1130/ray
that referenced
this pull request
Jul 29, 2025
…ay 1.4.0 (ray-project#53943) but that if autoscaling is used, the autoscaler image must have Ray 2.45.0 or later. closes ray-project/kuberay#3580 ## Checks - [x] I've signed off every commit(by using the -s flag, i.e., `git commit -s`) in this PR. - [x] 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. - [x] 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 - [x] Unit tests - [ ] Release tests - [ ] This PR is not tested :( Signed-off-by: David Xia <david@davidxia.com> Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Co-authored-by: Dhyey Shah <dhyey2019@gmail.com> Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com> Signed-off-by: ChanChan Mao <chanchanmao1130@gmail.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.
but that if autoscaling is used, the autoscaler image must have Ray 2.45.0 or later.
closes ray-project/kuberay#3580
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.