Merge pull request #142 from consideRatio/pr/update-grafonnet

Update grafonnet from v10.4.0 to v11.1.0, Grafana v11.1.0 is now required

Author: consideRatio

dashboards/activity.jsonnet

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local ts = grafonnet.panel.timeSeries;
 local prometheus = grafonnet.query.prometheus;

dashboards/cluster.jsonnet

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
 // Deploys a dashboard showing cluster-wide information
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local ts = grafonnet.panel.timeSeries;
 local barChart = grafonnet.panel.barChart;

dashboards/common.libsonnet

@@ -1,4 +1,4 @@
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local ts = grafonnet.panel.timeSeries;
 local barChart = grafonnet.panel.barChart;
 local barGauge = grafonnet.panel.barGauge;
@@ -14,10 +14,10 @@ local var = grafonnet.dashboard.variable;
    * - Y axes to start from 0            -- withMin(0)
    * - Legend tooltip to show all values -- withTooltip({mode: 'multi'})
    *
-   * ref: https://grafana.com/docs/grafana/v10.4/panels-visualizations/configure-panel-options/
+   * ref: https://grafana.com/docs/grafana/v11.1/panels-visualizations/configure-panel-options/
    */
 
-  // grafana ref:   https://grafana.com/docs/grafana/v10.4/panels-visualizations/visualizations/time-series/
+  // grafana ref:   https://grafana.com/docs/grafana/v11.1/panels-visualizations/visualizations/time-series/
   // grafonnet ref: https://grafana.github.io/grafonnet/API/panel/timeSeries/index.html
   tsOptions:
     ts.standardOptions.withMin(0)
@@ -26,20 +26,20 @@ local var = grafonnet.dashboard.variable;
     + ts.fieldConfig.defaults.custom.withFillOpacity(10)
   ,
 
-  // grafana ref:   https://grafana.com/docs/grafana/v10.4/panels-visualizations/visualizations/bar-chart/
+  // grafana ref:   https://grafana.com/docs/grafana/v11.1/panels-visualizations/visualizations/bar-chart/
   // grafonnet ref: https://grafana.github.io/grafonnet/API/panel/barChart/index.html
   barChartOptions:
     barChart.standardOptions.withMin(0)
     + barChart.options.withTooltip({ mode: 'multi' })
   ,
 
-  // grafana ref:   https://grafana.com/docs/grafana/v10.4/panels-visualizations/visualizations/bar-gauge/
+  // grafana ref:   https://grafana.com/docs/grafana/v11.1/panels-visualizations/visualizations/bar-gauge/
   // grafonnet ref: https://grafana.github.io/grafonnet/API/panel/barGauge/index.html
   barGaugeOptions:
     barGauge.standardOptions.withMin(0)
   ,
 
-  // grafana ref:   https://grafana.com/docs/grafana/v10.4/panels-visualizations/visualizations/heatmap/
+  // grafana ref:   https://grafana.com/docs/grafana/v11.1/panels-visualizations/visualizations/heatmap/
   // grafonnet ref: https://grafana.github.io/grafonnet/API/panel/heatmap/index.html
   heatmapOptions:
     heatmap.options.withCalculate(true)

dashboards/homedirs.jsonnet

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local prometheus = grafonnet.query.prometheus;
 local table = grafonnet.panel.table;

dashboards/jupyterhub.jsonnet

@@ -1,7 +1,7 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
 // Deploys one dashboard - "JupyterHub dashboard",
 // with useful stats about usage & diagnostics.
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local ts = grafonnet.panel.timeSeries;
 local prometheus = grafonnet.query.prometheus;
@@ -16,7 +16,7 @@ local userMemoryDistribution =
   common.heatmapOptions
   + heatmap.new('User memory usage distribution')
   + heatmap.options.yAxis.withUnit('bytes')
-  + heatmap.options.color.HeatmapColorOptions.withScheme('Viridis')
+  + heatmap.options.color.withScheme('Viridis')
   + heatmap.options.calculation.xBuckets.withMode('size')
   + heatmap.options.calculation.xBuckets.withValue('600s')  // must align with interval
   + heatmap.queryOptions.withInterval('600s')  // must align with xBuckets value
@@ -41,7 +41,7 @@ local userCPUDistribution =
   common.heatmapOptions
   + heatmap.new('User CPU usage distribution')
   + heatmap.options.yAxis.withUnit('percentunit')
-  + heatmap.options.color.HeatmapColorOptions.withScheme('Viridis')
+  + heatmap.options.color.withScheme('Viridis')
   + heatmap.options.calculation.xBuckets.withMode('size')
   + heatmap.options.calculation.xBuckets.withValue('600s')  // must align with interval
   + heatmap.queryOptions.withInterval('600s')  // must align with xBuckets value
@@ -66,7 +66,7 @@ local userAgeDistribution =
   common.heatmapOptions
   + heatmap.new('User active age distribution')
   + heatmap.options.yAxis.withUnit('s')
-  + heatmap.options.color.HeatmapColorOptions.withScheme('Viridis')
+  + heatmap.options.color.withScheme('Viridis')
   + heatmap.options.calculation.xBuckets.withMode('size')
   + heatmap.options.calculation.xBuckets.withValue('600s')  // must align with interval
   + heatmap.queryOptions.withInterval('600s')  // must align with xBuckets value

dashboards/jupyterhub.libsonnet

@@ -1,4 +1,4 @@
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local ts = grafonnet.panel.timeSeries;
 local prometheus = grafonnet.query.prometheus;
 

dashboards/support.jsonnet

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
 // Deploys a dashboard showing information about support resources
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local ts = grafonnet.panel.timeSeries;
 local prometheus = grafonnet.query.prometheus;

dashboards/usage-report.jsonnet

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local barGauge = grafonnet.panel.barGauge;
 local prometheus = grafonnet.query.prometheus;

dashboards/user.jsonnet

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S jsonnet -J ../vendor
-local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v10.4.0/main.libsonnet';
+local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-v11.1.0/main.libsonnet';
 local dashboard = grafonnet.dashboard;
 local ts = grafonnet.panel.timeSeries;
 local prometheus = grafonnet.query.prometheus;

docs/contributing.md

@@ -57,9 +57,15 @@ with `jsonnet`, you can deploy dashboards to a Grafana instance like this:
 
 ### Upgrading the grafonnet version
 
-The grafonnet jsonnet library is bundled here with [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler).
-Just running `jb update` in the git repo root dir after installing jsonnet-bunder should bring
-you up to speed.
+The grafonnet jsonnet library is bundled here with [jsonnet-bundler]. The
+upgrade procedure looks looks like this:
+
+1. Install jsonnet-bunder
+2. Update `jsonnetfile.json` to reference the new version
+3. Run `jb update` in the git repo root dir
+4. Search and replace remaining old version references with the new version
+
+[jsonnet-bundler]: https://github.com/jsonnet-bundler/jsonnet-bundler
 
 ### Metrics guidelines
 

docs/tutorials/deploy.md

@@ -2,7 +2,7 @@
 # Deploying the dashboards
 
 ```{warning}
-ANY CHANGES YOU MAKE VIA THE GRAFANA UI WILL BE OVERWRITTEN NEXT TIME YOU RUN deploy.bash.
+ANY CHANGES YOU MAKE VIA THE GRAFANA UI WILL BE OVERWRITTEN NEXT TIME YOU RUN `deploy.py`.
 TO MAKE CHANGES, EDIT THE JSONNET FILE AND DEPLOY AGAIN
 ```
 
@@ -43,7 +43,8 @@ TO MAKE CHANGES, EDIT THE JSONNET FILE AND DEPLOY AGAIN
    Make sure this is indented correctly where it should be!
    ```
 
-4. A recent version of Grafana, with a prometheus data source already added.
+4. A recent version of Grafana (v11.1.0 or higher), with a prometheus data
+   source already added.
 
 5. An API key with 'admin' permissions. This is per-organization, and you can make a new one
    by going to the configuration pane for your Grafana (the gear icon on the left bar), and

jsonnetfile.json

@@ -6,7 +6,7 @@
       "source": {
         "git": {
           "remote": "https://github.com/grafana/grafonnet.git",
-          "subdir": "gen/grafonnet-v10.4.0"
+          "subdir": "gen/grafonnet-v11.1.0"
         }
       },
       "version": "main"

jsonnetfile.lock.json

@@ -5,11 +5,11 @@
       "source": {
         "git": {
           "remote": "https://github.com/grafana/grafonnet.git",
-          "subdir": "gen/grafonnet-v10.4.0"
+          "subdir": "gen/grafonnet-v11.1.0"
         }
       },
-      "version": "6ac1593ca787638da223380ff4a3fd0f96e953e1",
-      "sum": "ZSmDT7i/qU9P8ggmuPuJT+jonq1ZEsBRCXycW/H5L/A=",
+      "version": "1ce5aec95ce32336fe47c8881361847c475b5254",
+      "sum": "41w7p/rwrNsITqNHMXtGSJAfAyKmnflg6rFhKBduUxM=",
       "name": "grafonnet"
     },
     {