Skip to content

Commit e76a310

Browse files
committed
docs: update README.md
Signed-off-by: David Calvert <[email protected]>
1 parent 03dedd2 commit e76a310

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ As an example, here's how the `Kubernetes / Views / Global` dashboard looks like
6161
| k8s-addons-prometheus.json | Dashboard for Prometheus. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-addons-prometheus.png) |
6262
| k8s-addons-trivy-operator.json | Dashboard for the Trivy Operator from Aqua Security. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-addons-trivy-operator.png) |
6363
| k8s-system-api-server.json | Dashboard for the API Server Kubernetes component. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-system-api-server.png) |
64-
| k8s-system-coredns.json | Show information on the CoreDNS Kubernetes component. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-system-coredns.png) |
64+
| k8s-system-coredns.json | Dashboard for the CoreDNS Kubernetes component. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-system-coredns.png) |
6565
| k8s-views-global.json | `Global` level view dashboard for Kubernetes. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-views-global.png) |
6666
| k8s-views-namespaces.json | `Namespaces` level view dashboard for Kubernetes. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-views-namespaces.png) |
6767
| k8s-views-nodes.json | `Nodes` level view dashboard for Kubernetes. | [Screenshot](https://raw.githubusercontent.com/dotdc/media/main/grafana-dashboards-kubernetes/k8s-views-nodes.png) |
@@ -95,12 +95,12 @@ grafana:
9595
9696
### Install manually
9797
98-
On the WebUI of your Grafana instance, put your mouse over the `+` sign on the left menu, then click on `Import`.\
98+
In your Grafana instance, put your mouse over the `+` sign on the left menu, then click on `Import`.\
9999
Once you are on the Import page, you can upload the JSON files one by one from your local copy using the `Upload JSON file` button.
100100

101101
### Install via grafana.com
102102

103-
On the WebUI of your Grafana instance, put your mouse over the `+` sign on the left menu, then click on `Import`.\
103+
In your Grafana instance, put your mouse over the `+` sign on the left menu, then click on `Import`.\
104104
Once you are on the Import page, you can put the grafana.com dashboard ID (see table below) under `Import via grafana.com` then click on the `Load` button. Repeat for each dashboard.
105105

106106
Grafana.com dashboard id list:
@@ -292,8 +292,7 @@ To make the fix permanent, you can configure the `Scrape interval` in your Grafa
292292
To make this dashboard more convenient, there's a small variable hack to display `node` instead of `instance`.
293293
Because of that, some panels could lack data when a node changes its IP address as reported in [#102](https://github.com/dotdc/grafana-dashboards-kubernetes/issues/102).
294294

295-
No easy fix for this scenario yet, but it should be a corner case for most people.
296-
Feel free to reopen the issue if you have ideas to fix this.
295+
There is currently no known fix for this scenario, though it should be a corner case for most deployments. Contributions with ideas or solutions are welcome.
297296

298297
### Broken panels on k8s-views-nodes due to the nodename label
299298

@@ -326,12 +325,15 @@ If using the Prometheus operator or the Grafana agent in operator mode, the scra
326325
# File: service-monitor.yaml
327326
apiVersion: monitoring.coreos.com/v1
328327
kind: ServiceMonitor
328+
metadata:
329+
name: node-exporter
330+
spec:
329331
endpoints:
330332
- port: http-metrics
331333
relabelings:
332334
# Add this
333335
- action: replace
334-
sourceLabels: [ __meta_kubernetes_node_name]
336+
sourceLabels: [__meta_kubernetes_node_name]
335337
targetLabel: nodename
336338
```
337339

0 commit comments

Comments
 (0)