Grafana dashboards#
Each 2i2c Hub is set up with a Prometheus server to generate metrics and information about activity on the hub, and each cluster of hubs has a Grafana deployment to ingest and visualize this data.
This section provides information for 2i2c staff about where to find each of 2i2c Grafana deployments, how to get access, and what to expect.
Note
For granting access to persons external to 2i2c, e.g. community representatives, see Give Grafana access to a community representative
Logging into any 2i2c-managed Grafana instance#
Each cluster’s Grafana deployment can be accessed at grafana.<cluster-name>.2i2c.cloud.
For example, the Grafana for the community hubs running on our GCP project is accessible at grafana.pilot.2i2c.cloud.
Checkout the list of all 2i2c running clusters and their Grafana here.
To access the Grafana dashboards you have two options, detailed in the next sections.
Get Viewer access by authenticating with GitHub#
Authenticate with GitHub to get Viewer access into the Grafana, if enabled.
If enabled, this is the recommended way of accessing Grafana if modifying/creating dashboards is not needed.
To get access, ask a 2i2c engineer to enable GitHub authentication following Enable GitHub Organisation authentication for Grafana for that particular Grafana (if it’s not already) and allow you access.
Get Admin access using the admin username and password#
Use the admin username and password to get Admin access into the Grafana.
These credentials can be accessed using sops (see the team compass documentation for how to set up sops on your machine).
See Login to the cluster-specific grafana for how to find the credentials information.
Alternatively, the password is also stored in the shared BitWarden account.
Admin access grants you permissions to create and edit dashboards.
The 2i2c Central Grafana#
The Grafana deployment in the 2i2c cluster is “the 2i2c central Grafana” because it ingests data from all of the 2i2c clusters. This is useful because it can be used to access information about all the clusters that 2i2c manages from one central place.
The central Grafana is running at https://grafana.pilot.2i2c.cloud and you can use the two authentication mechanisms listed in the Logging into any 2i2c-managed Grafana instance section above to access it.
The dashboards available at https://grafana.pilot.2i2c.cloud/dashboards are the default Grafana dashboards from JupyterHub found at jupyterhub/grafana-dashboards.
The 2i2c Community Hub Guide contains a description of each of the JupyterHub Default Dashboards.