docs: Add TUN device (#148)

compose.yml

@@ -6,6 +6,7 @@ services:
       VERSION: "13"
     devices:
       - /dev/kvm
+      - /dev/net/tun
     cap_add:
       - NET_ADMIN
     ports:

kubernetes.yml

@@ -1,10 +1,11 @@
+---
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: macos-pvc
 spec:
   accessModes:
-    - ReadWriteOnce
+  - ReadWriteOnce
   resources:
     requests:
       storage: 64Gi
@@ -16,57 +17,61 @@ metadata:
   labels:
     name: macos
 spec:
-  terminationGracePeriodSeconds: 120 # the Kubernetes default is 30 seconds and it may be not enough
   containers:
-    - name: macos
+  - name: macos
-      image: dockurr/macos
+    image: dockurr/macos
-      ports:
+    env:
-        - containerPort: 8006
+    - name: VERSION
-          protocol: TCP
+      value: "13"
-        - containerPort: 5000
+    - name: RAM_SIZE
-          protocol: TCP
+      value: "4G"
-        - containerPort: 5000
+    - name: CPU_CORES
-          protocol: UDP
+      value: "2"
-      securityContext:
+    - name: DISK_SIZE
-        privileged: true
+      value: "64G"
-      env:
+    ports:
-        - name: RAM_SIZE
+    - containerPort: 8006
-          value: 4G
+    - containerPort: 5900
-        - name: CPU_CORES
+    - containerPort: 5900
-          value: "2"
+      protocol: UDP
-        - name: DISK_SIZE
+    securityContext:
-          value: "64G"
+      capabilities:
-      volumeMounts:
+        add:
-        - mountPath: /storage
+        - NET_ADMIN
-          name: storage
+      privileged: true
-        - mountPath: /dev/kvm
+    volumeMounts:
-          name: dev-kvm
+    - mountPath: /storage
+      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: macos-pvc
+      claimName: macos-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: macos
 spec:
-  type: NodePort
+  ports:
+  - name: tcp-8006
+    port: 8006
+  - name: tcp-5900
+    port: 5900
+  - name: udp-5900
+    port: 5900
+    protocol: UDP
   selector:
     name: macos
-  ports:
+  type: NodePort
-    - name: tcp-8006
-      protocol: TCP
-      port: 8006
-      targetPort: 8006
-    - name: tcp-5900
-      protocol: TCP
-      port: 5900
-      targetPort: 5900
-    - name: udp-5900
-      protocol: UDP
-      port: 5900
-      targetPort: 5900

readme.md

@@ -33,6 +33,7 @@ services:
       VERSION: "13"
     devices:
       - /dev/kvm
+      - /dev/net/tun
     cap_add:
       - NET_ADMIN
     ports:
@@ -45,7 +46,7 @@ services:
 Via Docker CLI:
 
 ```bash
-docker run -it --rm -p 8006:8006 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 dockurr/macos
+docker run -it --rm -p 8006:8006 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN --stop-timeout 120 dockurr/macos
 ```
 
 Via Kubernetes: