Skip to content

Commit 1b930ae

Browse files
authored
docs: add GrafanaDashboard installation instructions (#148)
1 parent aeab4cc commit 1b930ae

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [Install with Helm values](#install-with-helm-values)
1616
- [Install as ConfigMaps](#install-as-configmaps)
1717
- [Install as ConfigMaps with Terraform](#install-as-configmaps-with-terraform)
18+
- [Install as GrafanaDashboard with Grafana Operator](#install-as-grafanadashboard-with-grafana-operator)
1819
- [Known issue(s)](#known-issues)
1920
- [Broken panels due to a too-high resolution](#broken-panels-due-to-a-too-high-resolution)
2021
- [Broken panels on k8s-views-nodes when a node changes its IP address](#broken-panels-on-k8s-views-nodes-when-a-node-changes-its-ip-address)
@@ -203,6 +204,80 @@ You will also need to enable and configure the Grafana `dashboards sidecar` as d
203204

204205
*Note: no namespace is set by default, you can change that in the `kustomization.yaml` file.*
205206

207+
### Install as GrafanaDashboard with Grafana Operator
208+
209+
If you use Grafana Operator to provision your Grafana dashboards, you can use the following manifests:
210+
211+
Make sure to use your proper namespace.
212+
213+
```yaml
214+
apiVersion: grafana.integreatly.org/v1beta1
215+
kind: GrafanaDashboard
216+
metadata:
217+
name: k8s-system-api-server
218+
namespace: monitoring
219+
spec:
220+
instanceSelector:
221+
matchLabels:
222+
dashboards: "grafana"
223+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-system-api-server.json"
224+
---
225+
apiVersion: grafana.integreatly.org/v1beta1
226+
kind: GrafanaDashboard
227+
metadata:
228+
name: k8s-system-coredns
229+
namespace: monitoring
230+
spec:
231+
instanceSelector:
232+
matchLabels:
233+
dashboards: "grafana"
234+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-system-coredns.json"
235+
---
236+
apiVersion: grafana.integreatly.org/v1beta1
237+
kind: GrafanaDashboard
238+
metadata:
239+
name: k8s-views-global
240+
namespace: monitoring
241+
spec:
242+
instanceSelector:
243+
matchLabels:
244+
dashboards: "grafana"
245+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-views-global.json"
246+
---
247+
apiVersion: grafana.integreatly.org/v1beta1
248+
kind: GrafanaDashboard
249+
metadata:
250+
name: k8s-views-namespaces
251+
namespace: monitoring
252+
spec:
253+
instanceSelector:
254+
matchLabels:
255+
dashboards: "grafana"
256+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-views-namespaces.json"
257+
---
258+
apiVersion: grafana.integreatly.org/v1beta1
259+
kind: GrafanaDashboard
260+
metadata:
261+
name: k8s-views-nodes
262+
namespace: monitoring
263+
spec:
264+
instanceSelector:
265+
matchLabels:
266+
dashboards: "grafana"
267+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-views-nodes.json"
268+
---
269+
apiVersion: grafana.integreatly.org/v1beta1
270+
kind: GrafanaDashboard
271+
metadata:
272+
name: k8s-views-pods
273+
namespace: monitoring
274+
spec:
275+
instanceSelector:
276+
matchLabels:
277+
dashboards: "grafana"
278+
url: "https://raw.githubusercontent.com/dotdc/grafana-dashboards-kubernetes/master/dashboards/k8s-views-pods.json"
279+
```
280+
206281
## Known issue(s)
207282

208283
### Broken panels due to a too-high resolution

0 commit comments

Comments
 (0)