docs entry point

grafana · Jul 23, 2019 · ce6241a · ce6241a
1 parent e24c1f9
commit ce6241a
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/documentation/README.md b/documentation/README.md
@@ -2,4 +2,23 @@
 
 * [Installing Grafana](./deploy_grafana.md)
 * [Dashboards](./dashboards.md)
-* [Data Sources](./datasources.md)
+* [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.