Skip to content

Commit 10a1bc5

Browse files
authored
fix(docs): update values.yaml path for prometheus (#757)
# Description 1. fix broken path for Prometheus values.yaml path (Helm deployment) 2. clean-up the bullet points numbering ## Related Issue If this pull request is related to any issue, please mention it here. Additionally, make sure that the issue is assigned to you before submitting this pull request. ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [x] I have added tests, if applicable. ## Screenshots (if applicable) or Testing Completed Please add any relevant screenshots or GIFs to showcase the changes made. ## Additional Notes Add any additional notes or context about the pull request here. --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project. Signed-off-by: Simone Rodigari <[email protected]>
1 parent 0dc47e0 commit 10a1bc5

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

docs/02-Installation/04-Grafana/prometheus-unmanaged.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,42 @@
1515
helm repo update
1616
```
1717

18-
2. Save **[these Prometheus values](https://github.com/microsoft/retina/blob/main/deploy/legacy/prometheus/values.yaml)** below to `deploy/legacy/prometheus/values.yaml`
19-
20-
3. Install the Prometheus chart
18+
2. Install the Prometheus chart
2119

2220
```shell
23-
helm install prometheus -n kube-system -f deploy/prometheus/values.yaml prometheus-community/kube-prometheus-stack
21+
helm install prometheus -n kube-system -f deploy/legacy/prometheus/values.yaml prometheus-community/kube-prometheus-stack
2422
```
2523

2624
Or if you already have the chart installed, upgrade how you see fit, providing the new job name as an additional scrape config, ex:
2725

2826
```shell
29-
helm upgrade prometheus -n kube-system -f deploy/prometheus/values.yaml prometheus-community/kube-prometheus-stack
27+
helm upgrade prometheus -n kube-system -f deploy/legacy/prometheus/values.yaml prometheus-community/kube-prometheus-stack
3028
```
3129

3230
Note: Grafana and kube-state metrics may schedule on Windows nodes, the current chart doesn't have node affinity for those components. Some manual intervention may be required.
3331

34-
6. Verify that the Retina Pods are being scraped by port-forwarding the Prometheus server:
32+
3. Verify that the Retina Pods are being scraped by port-forwarding the Prometheus server:
3533

3634
```shell
3735
kubectl port-forward --namespace kube-system svc/prometheus-operated 9090
3836
```
3937

40-
7. Then go to [http://localhost:9090/targets](http://localhost:9090/targets) to see the Retina Pods being discovered and scraped:
38+
4. Then go to [http://localhost:9090/targets](http://localhost:9090/targets) to see the Retina Pods being discovered and scraped:
4139

4240
![alt text](../img/prometheus-retina-pods.png)
4341

4442
## Configuring Grafana
4543

4644
Create a Grafana instance at [grafana.com](https://www.grafana.com) and follow [Configuring Grafana](./grafana.md), or use the one installed from above.
4745

48-
8. Get the Grafana password:
46+
1. Get the Grafana password:
4947

5048
```shell
5149
kubectl get secret -n kube-system prometheus-grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo
5250
```
5351

54-
9. Import the new dashboard from **[here](https://grafana.com/grafana/dashboards/18814/)**.
52+
2. Import the new dashboard from **[here](https://grafana.com/grafana/dashboards/18814/)**.
5553

56-
10. Metrics should be visible:
54+
3. Metrics should be visible:
5755

5856
![alt text](../img/grafana-dashboard-metrics.png)

0 commit comments

Comments
 (0)