aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/namespaces/monitoring/grafana/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'kubernetes/namespaces/monitoring/grafana/README.md')
-rw-r--r--kubernetes/namespaces/monitoring/grafana/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/kubernetes/namespaces/monitoring/grafana/README.md b/kubernetes/namespaces/monitoring/grafana/README.md
new file mode 100644
index 0000000..03a9682
--- /dev/null
+++ b/kubernetes/namespaces/monitoring/grafana/README.md
@@ -0,0 +1,11 @@
+# Grafana
+
+This folder contains the manifests for deploying our Grafana instance, the service we use to query our data.
+
+This deployment expects a number of secrets and environment variables to exist in a secret called `grafana-secret-env`.
+
+| Environment | Description |
+|------------------------------|-----------------------------------------------------|
+| GF_AUTH_GITHUB_CLIENT_ID | The client ID of the Github app to use for auth |
+| GF_AUTH_GITHUB_CLIENT_SECRET | The client secret of the Github app to use for auth |
+| GF_SECURITY_ADMIN_PASSWORD | The admin password the the grafana admin console |