docs: update details about grafana config

2i2c-org · May 9, 2023 · 3fa6776 · 3fa6776
1 parent 099ab4d
commit 3fa6776
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/docs/howto/grafana-github-auth.md b/docs/howto/grafana-github-auth.md
@@ -28,7 +28,15 @@ To enable logging into Grafana using GitHub, follow these steps:
    grafana:
      grafana.ini:
        server:
-         root_url: https://<grafana.ingress.hosts[0]>
+         # root_url should point to the domain we redirect to if we have multiple
+         # domain names configured and redirects from one to another
+         #
+         # FIXME: root_url is also required to be the same as the
+         #        grafana.ingress.hosts[0] config specifically until
+         #        https://github.com/2i2c-org/infrastructure/issues/2533 is
+         #        resolved.
+         #
+         root_url: https://<grafana.ingress.hosts[0]>/
        auth.github:
          enabled: true
          # allowed_organizations should be a space separated list

diff --git a/helm-charts/support/values.yaml b/helm-charts/support/values.yaml
@@ -246,7 +246,7 @@ grafana:
   # secret:
   #
   #     server:
-  #       root_url: https://grafana.<cluster_name>.2i2c.cloud
+  #       root_url: https://grafana.<cluster_name>.2i2c.cloud/
   #     auth.github:
   #       enabled: true
   #       allowed_organizations: "2i2c-org some-other-gh-org"