Add Dockerfile and docker-compose.yaml

Author: fwsGonzo

Dockerfile

@@ -0,0 +1,35 @@
+# Description: Dockerfile for building libvmod-tinykvm
+# Based on Dockerfile written by Laurence Rowe (lrowe)
+FROM varnish:7.6.1 AS varnish
+FROM varnish AS build_vmod
+ENV VMOD_BUILD_DEPS="libcurl4-openssl-dev libpcre3-dev libarchive-dev libjemalloc-dev git cmake build-essential"
+USER root
+WORKDIR /libvmod-tinykvm
+RUN set -e; \
+	export DEBIAN_FRONTEND=noninteractive; \
+	apt-get update; \
+	apt-get -y install /pkgs/*.deb $VMOD_DEPS $VMOD_BUILD_DEPS; \
+	rm -rf /var/lib/apt/lists/*;
+RUN set -e; \
+	git init; \
+	git remote add origin https://github.com/varnish/libvmod-tinykvm.git; \
+	git fetch --depth 1; \
+	git checkout FETCH_HEAD; \
+	git submodule update --init --recursive;
+RUN set -e; \
+	mkdir -p .build; \
+	cd .build; \
+	cmake .. -DCMAKE_BUILD_TYPE=Release -DVARNISH_PLUS=OFF; \
+	cmake --build . -j6;
+
+FROM varnish
+ENV VMOD_RUN_DEPS="libcurl4 libpcre3 libarchive13 libjemalloc2"
+USER root
+RUN set -e; \
+	export DEBIAN_FRONTEND=noninteractive; \
+	apt-get update; \
+	apt-get -y install $VMOD_RUN_DEPS; \
+	rm -rf /var/lib/apt/lists/*;
+COPY --from=build_vmod /libvmod-tinykvm/.build/libvmod_*.so /usr/lib/varnish/vmods/
+COPY demo/tinykvm.vcl /etc/varnish/default.vcl
+USER varnish

README.md

@@ -6,6 +6,12 @@ The TinyKVM VMOD processes data in Varnish at native performance using your serv
 
 You can find the complete [VMOD documentation here](docs/README.md).
 
+## Demonstration
+
+```sh
+KVM_GID=$(getent group kvm | cut -d: -f3) docker compose up
+```
+
 ## Building and installing
 
 The build dependencies for this VMOD can be found in CI, but briefly:
@@ -43,10 +49,6 @@ There is a build-merge-release CI system that currently only builds for Ubuntu 2
 
 [Packages here](https://github.com/varnish/libvmod-tinykvm/releases/download/v0.1/artifacts.zip).
 
-## Try it out
-
-[Demonstration VCL here](/demo/tinykvm.vcl). Use `run.sh` in the same directory to try it out.
-
 ### Example VCL
 
 ```vcl
@@ -70,14 +72,11 @@ sub vcl_backend_fetch {
 		"""{
 			"headers": ["Host: filebin.varnish-software.com"]
 		}""");
-	# Transcode JPG to AVIF and compress with Zstandard
-	tinykvm.chain("avif");
-	set bereq.backend = tinykvm.program("zstd", "",
-		"""{
-			"action": "compress",
-			"level": 6,
-			"resp_headers": ["Content-Disposition: inline; filename=spooky.avif"]
-		}""");
+	# Transcode JPG to AVIF
+	set bereq.backend = tinykvm.program("avif", "", """{
+		"speed": 10,
+		"quality": 35
+	}""");
 }
 ```
 

demo/demo.vcl

@@ -0,0 +1,27 @@
+vcl 4.1;
+import tinykvm;
+backend default none;
+
+sub vcl_init {
+	# Download and activate a Varnish-provided library of compute programs.
+	# A full list of programs and how they can be used would be on the docs site.
+	tinykvm.library("https://filebin.varnish-software.com/tinykvm_programs/compute.json");
+	#tinykvm.library("file:///home/gonzo/github/kvm_demo/compute.json");
+
+	# Tell VMOD compute how to contact Varnish (Unix Socket *ONLY*)
+	tinykvm.init_self_requests("/tmp/tinykvm.sock");
+}
+
+sub vcl_backend_fetch {
+	# Fetch a JPG image from a remote server
+	tinykvm.chain("fetch",
+		"https://filebin.varnish-software.com/tinykvm_programs/spooky.jpg",
+		"""{
+			"headers": ["Host: filebin.varnish-software.com"]
+		}""");
+	# Transcode JPG to AVIF
+	set bereq.backend = tinykvm.program("avif", "", """{
+		"speed": 10,
+		"quality": 35
+	}""");
+}

docker-compose.yaml

@@ -0,0 +1,11 @@
+services:
+  tinykvm-docker:
+    image: vmod-tinykvm:latest
+    container_name: tinykvm-varnish
+    ports:
+      - "8080:80"
+    restart: always
+    group_add:
+      - "${KVM_GID:-109}"
+    devices:
+      - "/dev/kvm:/dev/kvm"