[kuberay] Update helm install command in prometheus doc to set serviceMonitor release=prometheus#53952
Merged
jjyao merged 2 commits intoray-project:masterfrom Jun 19, 2025
Conversation
Member
Author
|
@troychiu @win5923 @kevin85421 PTAL |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Prometheus & Grafana documentation for KubeRay by enhancing the Helm install command to include a selector label, ensuring ServiceMonitor resources are discovered by the Prometheus release.
- Added
--set metrics.serviceMonitor.selector.release=prometheusto the Helm command - Broke out Helm flags onto separate lines for readability
Comments suppressed due to low confidence (2)
doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md:56
- [nitpick] Since the Helm command now also sets the ServiceMonitor selector label, update this description to mention adding
metrics.serviceMonitor.selector.releaseso users know why the label is needed.
* Set `metrics.serviceMonitor.enabled=true` when installing the KubeRay operator with Helm to create a ServiceMonitor that scrapes metrics exposed by the KubeRay operator's service.
doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md:60
- Helm charts for Prometheus Operator typically expect selectors under
matchLabels. Please use--set metrics.serviceMonitor.selector.matchLabels.release=prometheusto correctly apply the release label.
--set metrics.serviceMonitor.selector.release=prometheus
kevin85421
reviewed
Jun 19, 2025
| @@ -56,7 +56,8 @@ kubectl get all -n prometheus-system | |||
| * Set `metrics.serviceMonitor.enabled=true` when installing the KubeRay operator with Helm to create a ServiceMonitor that scrapes metrics exposed by the KubeRay operator's service. | |||
| ```sh | |||
| helm install kuberay-operator kuberay/kuberay-operator --version 1.4.0 \ | |||
Member
There was a problem hiding this comment.
Please add comments to explain the two flags.
release=prometheus
kevin85421
approved these changes
Jun 19, 2025
Member
|
@owenowenisme please ping me when all CI tests pass. |
Member
Author
|
@kevin85421 CI passed. |
Member
minerharry
pushed a commit
to minerharry/ray
that referenced
this pull request
Jun 27, 2025
…eMonitor `release=prometheus` (ray-project#53952) Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
elliot-barn
pushed a commit
that referenced
this pull request
Jul 2, 2025
…eMonitor `release=prometheus` (#53952) Signed-off-by: You-Cheng Lin <mses010108@gmail.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?
We need to set label when creating serviceMonitor with helm to let prometheus discover our ServiceMonitor, so we updated the command to set the label.
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.