From ce6241a7f4459dae0edd8c0085e271fa7a970fa9 Mon Sep 17 00:00:00 2001 From: Peter Braun Date: Tue, 23 Jul 2019 16:28:02 +0200 Subject: [PATCH] docs entry point --- documentation/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/documentation/README.md b/documentation/README.md index c68308c99..8db720874 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -2,4 +2,23 @@ * [Installing Grafana](./deploy_grafana.md) * [Dashboards](./dashboards.md) -* [Data Sources](./datasources.md) \ No newline at end of file +* [Data Sources](./datasources.md) + +## Examples + +The following example CRs are provided: + +### Grafana deployments + +* [Grafana.yaml](../deploy/examples/Grafana.yaml): Installs Grafana using the default configuration and an Ingress if the `--openshift` flag is not provided. Suitable for Kubernetes and OpenShift. +* [GrafanaWithRoute.yaml](../deploy/examples/GrafanaWithRoute.yaml): Installs Grafana using the default configuration and a Route. Only suitable for OpenShift. +* [GrafanaWithIngressHost.yaml](../deploy/examples/GrafanaWithIngressHost.yaml): Installs Grafana using the default configuration and an Ingress where the host is set for outside access. Only suitable for Kubernetes, setting the host on Ingresses is not permitted on OpenShift. + +### Dashboards + +* [SimpleDashboard.yaml](../deploy/examples/dashboards/SimpleDashboard.yaml): Minimal empty dashboard. +* [DashboardWithPlugins.yaml](../deploy/examples/dashboards/DashboardWithPlugins.yaml): Minimal empty dashboard with plugin dependencies. + +### Data sources + +* [Prometheus.yaml](../deploy/examples/datasources/Prometheus.yaml): Prometheus data source, expects a service named `prometheus-service` listening on port 9090 in the same namespace.