Kube-burner Report - OCP Wrapper Dashboard in latest grafonnet library

Author: Vishnu Challa

Makefile

@@ -1,45 +1,64 @@
-JSONNET = https://github.com/google/jsonnet/releases/download/v0.17.0/jsonnet-bin-v0.17.0-linux.tar.gz
+JB = https://github.com/jsonnet-bundler/jsonnet-bundler/releases/latest/download/jb-linux-amd64
 BINDIR = bin
 TEMPLATESDIR = templates
 OUTPUTDIR = rendered
 ALLDIRS = $(BINDIR) $(OUTPUTDIR)
 SYNCER_IMG_TAG ?= quay.io/cloud-bulldozer/dittybopper-syncer:latest
 PLATFORM = linux/amd64,linux/arm64,linux/ppc64le,linux/s390x
 
-# Get all templates at $(TEMPLATESDIR)
-TEMPLATES := $(wildcard $(TEMPLATESDIR)/**/*.jsonnet)
+ifeq ($(filter v2,$(MAKECMDGOALS)),v2)
+    # Set variables and instructions for v2
+    TEMPLATES := $(wildcard $(TEMPLATESDIR)/**/*-v2.jsonnet)
+	LIBRARY_PATH := $(TEMPLATESDIR)/vendor
+	JSONNET := https://github.com/cloud-bulldozer/utils/releases/download/v0.0.0/jsonnet-bin-v0.20.0-linux.tar.gz
+else
+	# Get all templates at $(TEMPLATESDIR)
+	TEMPLATES := $(filter-out %-v2.jsonnet, $(wildcard $(TEMPLATESDIR)/**/*.jsonnet))
+	LIBRARY_PATH := $(TEMPLATESDIR)/grafonnet-lib
+	JSONNET := https://github.com/google/jsonnet/releases/download/v0.17.0/jsonnet-bin-v0.17.0-linux.tar.gz
+endif
 
 # Replace $(TEMPLATESDIR)/*.jsonnet by $(OUTPUTDIR)/*.json
 outputs := $(patsubst $(TEMPLATESDIR)/%.jsonnet, $(OUTPUTDIR)/%.json, $(TEMPLATES))
 
 all: deps format build
 
-deps: $(ALLDIRS) $(TEMPLATESDIR)/grafonnet-lib $(BINDIR)/jsonnet
+deps: $(ALLDIRS) $(BINDIR)/jsonnet $(LIBRARY_PATH)
 
 $(ALLDIRS):
 	mkdir -p $(ALLDIRS)
 
 format: deps
 	$(BINDIR)/jsonnetfmt -i $(TEMPLATES)
 
-build: deps $(TEMPLATESDIR)/grafonnet-lib $(outputs)
+build: deps $(LIBRARY_PATH) $(outputs)
 
 clean:
 	@echo "Cleaning up"
-	rm -rf $(ALLDIRS) $(TEMPLATESDIR)/grafonnet-lib
-
-$(TEMPLATESDIR)/grafonnet-lib:
-	git clone --depth 1 https://github.com/grafana/grafonnet-lib.git $(TEMPLATESDIR)/grafonnet-lib
+	rm -rf $(ALLDIRS) $(TEMPLATESDIR)/vendor $(TEMPLATESDIR)/grafonnet-lib
 
 $(BINDIR)/jsonnet:
 	@echo "Downloading jsonnet binary"
 	curl -s -L $(JSONNET) | tar xz -C $(BINDIR)
+	@echo "Downloading jb binary"
+	curl -s -L $(JB) -o $(BINDIR)/jb
+	chmod +x $(BINDIR)/jb
+
+$(TEMPLATESDIR)/grafonnet-lib:
+	git clone --depth 1 https://github.com/grafana/grafonnet-lib.git $(TEMPLATESDIR)/grafonnet-lib
+
+$(TEMPLATESDIR)/vendor:
+	@echo "Downloading vendor files"
+	cd $(TEMPLATESDIR) && ../$(BINDIR)/jb install && cd ../
 
 # Build each template and output to $(OUTPUTDIR)
 $(OUTPUTDIR)/%.json: $(TEMPLATESDIR)/%.jsonnet
 	@echo "Building template $<"
 	mkdir -p $(dir $@)
-	$(BINDIR)/jsonnet $< > $@
+	$(BINDIR)/jsonnet -J ./$(LIBRARY_PATH) $< > $@
+
+v2: all
+	@echo "Rendered the v2 dashboards with latest grafonnet library"
 
 build-syncer-image: build
 	podman build --platform=${PLATFORM} -f Dockerfile --manifest=${SYNCER_IMG_TAG} .

README.md

@@ -34,6 +34,28 @@ bin/jsonnet templates/ocp-performance.jsonnet > rendered/ocp-performance.json
 $ ls rendered
 ocp-ingress-controller.json ocp-performance.json
 ```
+Similarly for V2, the dashboards that are built using latest grafonnet library, use 
+```
+$ make v2
+mkdir -p bin rendered
+Downloading jsonnet binary
+curl -s -L https://github.com/cloud-bulldozer/utils/releases/download/v0.0.0/jsonnet-bin-v0.20.0-linux.tar.gz | tar xz -C bin
+Downloading jb binary
+curl -s -L https://github.com/jsonnet-bundler/jsonnet-bundler/releases/latest/download/jb-linux-amd64 -o bin/jb
+chmod +x bin/jb
+Downloading vendor files
+cd templates && ../bin/jb install && cd ../
+GET https://github.com/grafana/grafonnet/archive/f40876da40d787e9c288de0b547ac85597c781d9.tar.gz 200
+GET https://github.com/grafana/grafonnet/archive/f40876da40d787e9c288de0b547ac85597c781d9.tar.gz 200
+GET https://github.com/jsonnet-libs/docsonnet/archive/cc9df63eaca56f39e8e4e1ce192141333257b08d.tar.gz 200
+GET https://github.com/jsonnet-libs/xtd/archive/0256a910ac71f0f842696d7bca0bf01ea77eb654.tar.gz 200
+bin/jsonnetfmt -i templates/General/ocp-performance-v2.jsonnet
+Building template templates/General/ocp-performance-v2.jsonnet
+mkdir -p rendered/General/
+bin/jsonnet -J ./templates/vendor templates/General/ocp-performance-v2.jsonnet > rendered/General/ocp-performance-v2.json
+Rendered the v2 dashboards with latest grafonnet library
+```
+Rest all operations reamin same as before.
 
 In order to clean up the environment execute `make clean`.
 
@@ -73,4 +95,4 @@ In addition, make sure to lint your modifications to jsonnet files if you don't
 
 The dashboards from this repository have been tested with the following versions:
 
-- Grafana 7.X
+- Grafana 7.X