[Doc] Bind the version of kuberay to v1.3.0 in related docs#53661
Merged
edoakes merged 1 commit intoray-project:masterfrom Jun 11, 2025
Merged
[Doc] Bind the version of kuberay to v1.3.0 in related docs#53661edoakes merged 1 commit intoray-project:masterfrom
edoakes merged 1 commit intoray-project:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates Kubernetes autoscaling and Prometheus/Grafana documentation to reference the released KubeRay v1.3.0 tag rather than the master branch, preventing confusion when examples lag behind unreleased features.
- Bind sample YAML and scripts to
v1.3.0in docs - Ensure Prometheus/Grafana config links point to the released version
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/configuring-autoscaling.ipynb | Updated ray-cluster.autoscaler-v2.yaml link to v1.3.0 |
| doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md | Updated install.sh, podMonitor.yaml, and prometheusRules.yaml links to v1.3.0 |
Comments suppressed due to low confidence (2)
doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md:38
- The link for Grafana JSON files still points to the master branch. To ensure consistency with the rest of this guide, bind it to the
v1.3.0tag (e.g.,https://github.com/ray-project/kuberay/tree/v1.3.0/config/grafana).
* Import Ray Dashboard’s [Grafana JSON files](https://github.com/ray-project/kuberay/tree/master/config/grafana) into Grafana using the `--auto-load-dashboard true` flag.
doc/source/cluster/kubernetes/user-guides/configuring-autoscaling.ipynb:1089
- Since the link now targets a specific
v1.3.0tag, consider updating the text from "latest KubeRay version" to "KubeRay v1.3.0" for clarity.
[ray-cluster.autoscaler-v2.yaml](https://github.com/ray-project/kuberay/blob/v1.3.0/ray-operator/config/samples/ray-cluster.autoscaler-v2.yaml) is an example YAML file of a RayCluster with Autoscaler V2 enabled that works with the latest KubeRay version.
kevin85421
reviewed
Jun 9, 2025
Member
kevin85421
left a comment
There was a problem hiding this comment.
Revert the changes for prometheus-grafana.md and others LGTM.
Member
There was a problem hiding this comment.
There have been some recent changes to install.sh, and we plan to release KubeRay v1.4.0 this week. That’s why we’re pointing to the master branch for now. We will update it to v1.4.0 recently.
Can you revert the changes for this file?
Contributor
Author
There was a problem hiding this comment.
Already reverted the changes.
Signed-off-by: Yun Tang <myasuka@live.com>
92d5c04 to
b5760f3
Compare
kevin85421
approved these changes
Jun 11, 2025
Member
|
@Myasuka I have already triggered the full CI run. Please ping me when all CI tests pass. Thank you! |
Contributor
Author
|
@kevin85421 all tests already passed. |
Member
elliot-barn
pushed a commit
that referenced
this pull request
Jun 18, 2025
Current ray's doc has a description of [how to enable autoscaler V2](https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/configuring-autoscaling.html#autoscaler-v2-with-kuberay). However, the ray-cluster.autoscaler-v2.yaml example to the https://github.com/ray-project/kuberay/blob/master/ray-operator/config/samples/ray-cluster.autoscaler-v2.yaml which does not have related configuration of RAY_enable_autoscaler_v2. This is because that [commit-a9c48c](ray-project/kuberay@a9c48c1) introduced a new feature, which has not been released yet. To reduce such problem, we should make the ray's doc bind to a specific released kuberay version. Closes #53655 Signed-off-by: Yun Tang <myasuka@live.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
elliot-barn
pushed a commit
that referenced
this pull request
Jul 2, 2025
Current ray's doc has a description of [how to enable autoscaler V2](https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/configuring-autoscaling.html#autoscaler-v2-with-kuberay). However, the ray-cluster.autoscaler-v2.yaml example to the https://github.com/ray-project/kuberay/blob/master/ray-operator/config/samples/ray-cluster.autoscaler-v2.yaml which does not have related configuration of RAY_enable_autoscaler_v2. This is because that [commit-a9c48c](ray-project/kuberay@a9c48c1) introduced a new feature, which has not been released yet. To reduce such problem, we should make the ray's doc bind to a specific released kuberay version. Closes #53655 Signed-off-by: Yun Tang <myasuka@live.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
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
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?
Current ray's doc has a description of how to enable autoscaler V2. However, the ray-cluster.autoscaler-v2.yaml example to the https://github.com/ray-project/kuberay/blob/master/ray-operator/config/samples/ray-cluster.autoscaler-v2.yaml which does not have related configuration of RAY_enable_autoscaler_v2. This is because that commit-a9c48c introduced a new feature, which has not been released yet.
To reduce such problem, we should make the ray's doc bind to a specific released kuberay version.
Related issue number
Closes #53655
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.