docs: Add TUN device (#167)

compose.yml

@@ -6,6 +6,7 @@ services:
       BOOT: "https://dl-cdn.alpinelinux.org/alpine/v3.19/releases/aarch64/alpine-virt-3.19.1-aarch64.iso"
     devices:
       - /dev/kvm
+      - /dev/net/tun
     cap_add:
       - NET_ADMIN
     ports:

kubernetes.yml

@@ -1,10 +1,11 @@
+---
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: qemu-pvc
 spec:
   accessModes:
-    - ReadWriteOnce
+  - ReadWriteOnce
   resources:
     requests:
       storage: 16Gi
@@ -16,47 +17,53 @@ metadata:
   labels:
     name: qemu
 spec:
-  terminationGracePeriodSeconds: 120 # the Kubernetes default is 30 seconds and it may be not enough
   containers:
-    - name: qemu
+  - name: qemu
-      image: qemux/qemu-arm
+    image: qemux/qemu-arm
-      ports:
+    env:
-        - containerPort: 8006
+    - name: BOOT
-          protocol: TCP
+      value: "https://dl-cdn.alpinelinux.org/alpine/v3.19/releases/aarch64/alpine-virt-3.19.1-aarch64.iso"
-      securityContext:
+    - name: RAM_SIZE
-        privileged: true
+      value: "1G"
-      env:
+    - name: CPU_CORES
-        - name: BOOT
+      value: "1"
-          value: "https://dl-cdn.alpinelinux.org/alpine/v3.19/releases/aarch64/alpine-virt-3.19.1-aarch64.iso"
+    - name: DISK_SIZE
-        - name: RAM_SIZE
+      value: "16G"
-          value: 1G
+    ports:
-        - name: CPU_CORES
+    - containerPort: 8006
-          value: "1"
+    securityContext:
-        - name: DISK_SIZE
+      capabilities:
-          value: "16G"
+        add:
-      volumeMounts:
+        - NET_ADMIN
-        - mountPath: /storage
+      privileged: true
-          name: storage
+    volumeMounts:
-        - mountPath: /dev/kvm
+    - mountPath: /storage
-          name: dev-kvm
+      name: storage
+    - mountPath: /dev/kvm
+      name: dev-kvm
+    - mountPath: /dev/net/tun
+      name: dev-tun
+  terminationGracePeriodSeconds: 120
   volumes:
-    - name: storage
+  - name: storage
-      persistentVolumeClaim:
+    persistentVolumeClaim:
-        claimName: qemu-pvc
+      claimName: qemu-pvc
-    - name: dev-kvm
+  - hostPath:
-      hostPath:
+      path: /dev/kvm
-        path: /dev/kvm
+    name: dev-kvm
+  - hostPath:
+      path: /dev/net/tun
+      type: CharDevice
+    name: dev-tun
 ---
 apiVersion: v1
 kind: Service
 metadata:
   name: qemu
 spec:
-  type: NodePort
+  ports:
+  - name: tcp-8006
+    port: 8006
   selector:
     name: qemu
-  ports:
+  type: NodePort
-    - name: tcp-8006
-      protocol: TCP
-      port: 8006
-      targetPort: 8006

readme.md

@@ -35,6 +35,7 @@ services:
       BOOT: "https://dl-cdn.alpinelinux.org/alpine/v3.19/releases/aarch64/alpine-virt-3.19.1-aarch64.iso"
     devices:
       - /dev/kvm
+      - /dev/net/tun
     cap_add:
       - NET_ADMIN
     ports:
@@ -45,7 +46,7 @@ services:
 Via Docker CLI:
 
 ```bash
-docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device=/dev/kvm --cap-add NET_ADMIN qemux/qemu-arm
+docker run -it --rm -e "BOOT=http://example.com/image.iso" -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN qemux/qemu-arm
 ```
 
 Via Kubernetes: