Initial dashboard description

AMDResearch · Jul 8, 2024 · 35e8f0e · 35e8f0e
1 parent d0bea15
commit 35e8f0e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/docs/grafana.md b/docs/grafana.md
@@ -6,8 +6,26 @@
    :maxdepth: 4
 ```
 
-TODO
+## Import dashboards
+
+Dashboards allow showing real-time cluster telemetry data in a visual form.
+Omnistat provides two sample dashboards:
+- [Global Dashboard](https://github.com/AMDResearch/omnistat/blob/main/grafana/json-models/slurm-global.json):
+  includes an overview of the system, job indices, and cluster-level telemetry.
+- [Job Dashboard](https://github.com/AMDResearch/omnistat/blob/main/grafana/json-models/slurm-job.json):
+  includes more detailed time-series data and other metrics for a particular
+  job.
+
+After installing and configuring Omnistat, ensure the Prometheus data source
+has been added to Grafana, and then import the sample dashboards.
+
+To import a dashboard:
+1. Click Dashboards in the left-side menu.
+2. Click New and select New Dashboard from the drop-down menu.
+3. On the dashboard, click + Add visualization.
 
 ## Example screenshots
 
-## Point to json panels in repo that can be used locally
+![Global dashboard screenshot](images/dashboard-global.png)
+
+![Job dashboard screenshot](images/dashboard-job.png)
diff --git a/docs/images/dashboard-global.png b/docs/images/dashboard-global.png
diff --git a/docs/images/dashboard-job.png b/docs/images/dashboard-job.png