Skip to content

Commit 17e4dc9

Browse files
authored
refactor: Document how to access grafana (#348)
1 parent d853034 commit 17e4dc9

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2525
- Temporarily skip VRT driver in GDALg to avoid https://github.com/OSGeo/gdal/issues/12645
2626
- Consistent naming of behavior field
2727
- Made all python tests comply with mypy strict validation
28+
- Improved documentation about access to grafana
2829

2930
## [0.7.13] - 2025-11-04
3031

docs/observability.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ helm install eoapi eoapi/eoapi \
3434
--set monitoring.prometheus.enabled=true \
3535
--set observability.grafana.enabled=true
3636

37-
# Access Grafana (get password)
38-
kubectl get secret eoapi-grafana -n eoapi \
39-
-o jsonpath="{.data.admin-password}" | base64 -d
37+
# Access Grafana (see "Accessing Grafana" section below for credentials)
38+
kubectl port-forward -n eoapi svc/eoapi-obs-grafana 3000:80
4039
```
4140

4241
### Using Configuration Files
@@ -213,6 +212,22 @@ Minimum resource requirements (actual usage varies by cluster size and metrics v
213212

214213
## Operations
215214

215+
### Accessing Grafana
216+
217+
```bash
218+
# Get Grafana admin username (usually 'admin')
219+
kubectl get secret -n eoapi -l app.kubernetes.io/name=grafana \
220+
-o jsonpath="{.items[0].data.admin-user}" | base64 --decode
221+
222+
# Get Grafana admin password
223+
kubectl get secret -n eoapi -l app.kubernetes.io/name=grafana \
224+
-o jsonpath="{.items[0].data.admin-password}" | base64 --decode
225+
226+
# Port-forward to access Grafana UI
227+
kubectl port-forward -n eoapi svc/eoapi-obs-grafana 3000:80
228+
# Access at http://localhost:3000
229+
```
230+
216231
### Verification Commands
217232

218233
```bash

0 commit comments

Comments
 (0)