docs: Kubernetes deployment (#916)

kubernetes.yml

@@ -10,58 +10,72 @@ spec:
     requests:
       storage: 16Gi
 ---
-apiVersion: v1
+apiVersion: apps/v1
-kind: Pod
+kind: Deployment
 metadata:
   name: dsm
   labels:
     name: dsm
 spec:
-  containers:
+  replicas: 1
-  - name: dsm
+  selector:
-    image: vdsm/virtual-dsm
+    matchLabels:
-    env:
+      app: dsm
-    - name: RAM_SIZE
+  template:
-      value: "1G"
+    metadata:
-    - name: CPU_CORES
+      labels:
-      value: "1"
+        app: dsm
-    - name: DISK_SIZE
+    spec:
-      value: "16G"
+      containers:
-    ports:
+      - name: dsm
-    - containerPort: 5000
+        image: vdsm/virtual-dsm
-    securityContext:
+        env:
-      capabilities:
+        - name: RAM_SIZE
-        add:
+          value: "1G"
-        - NET_ADMIN
+        - name: CPU_CORES
-      privileged: true
+          value: "1"
-    volumeMounts:
+        - name: DISK_SIZE
-    - mountPath: /storage
+          value: "16G"
-      name: storage
+        ports:
-    - mountPath: /dev/kvm
+          - containerPort: 5000
-      name: dev-kvm
+            name: http
-    - mountPath: /dev/net/tun
+            protocol: TCP
-      name: dev-tun
+        securityContext:
-  terminationGracePeriodSeconds: 120
+          capabilities:
-  volumes:
+            add:
-  - name: storage
+            - NET_ADMIN
-    persistentVolumeClaim:
+          privileged: true
-      claimName: dsm-pvc
+        volumeMounts:
-  - hostPath:
+        - mountPath: /storage
-      path: /dev/kvm
+          name: storage
-    name: dev-kvm
+        - mountPath: /dev/kvm
-  - hostPath:
+          name: dev-kvm
-      path: /dev/net/tun
+        - mountPath: /dev/net/tun
-      type: CharDevice
+          name: dev-tun
-    name: dev-tun
+      terminationGracePeriodSeconds: 120
+      volumes:
+      - name: storage
+        persistentVolumeClaim:
+          claimName: dsm-pvc
+      - hostPath:
+          path: /dev/kvm
+        name: dev-kvm
+      - hostPath:
+          path: /dev/net/tun
+          type: CharDevice
+        name: dev-tun
 ---
 apiVersion: v1
 kind: Service
 metadata:
   name: dsm
 spec:
+  internalTrafficPolicy: Cluster
   ports:
-  - name: tcp-5000
+    - name: http
-    port: 5000
+      port: 5000
+      protocol: TCP
+      targetPort: 5000
   selector:
-    name: dsm
+    app: dsm
-  type: NodePort
+  type: ClusterIP

readme.md

@@ -250,14 +250,14 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ### How do I install a specific version of vDSM?
 
-  By default, version 7.2 will be installed, but if you prefer an older version, you can add its download URL to your compose file as follows:
+  By default, version 7.2 will be installed, but if you prefer an older version, you can add the download URL of the `.pat` file to your compose file as follows:
 
   ```yaml
   environment:
     URL: "https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
   ```
 
-  With this method, it is even possible to switch between different versions while keeping all your file data intact.
+  With this method, it is even possible to switch back and forth between versions while keeping your file data intact.
 
   If you don't have internet access, it's also possible to skip the download by setting URL to:
 
@@ -266,7 +266,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
     URL: "DSM_VirtualDSM_42218.pat"
   ```
 
-  after placing a file called `DSM_VirtualDSM_42218.pat` in your `/storage` folder.
+  after placing a copy of [DSM_VirtualDSM_42218.pat](https://global.synologydownload.com/download/DSM/release/7.0.1/42218/DSM_VirtualDSM_42218.pat) in the root of your `/storage` folder.
 
 ### What are the differences compared to the standard DSM?
 

src/network.sh

@@ -59,8 +59,10 @@ configureDHCP() {
       fi ;;
   esac
 
-  if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+  if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
-    warn "Failed to set MTU size.."
+    if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+      warn "Failed to set MTU size.."
+    fi
   fi
 
   while ! ip link set "$VM_NET_TAP" up; do
@@ -197,7 +199,6 @@ configureNAT() {
   fi
 
   # Create a bridge with a static IP for the VM guest
-
   { ip link add dev dockerbridge type bridge ; rc=$?; } || :
 
   if (( rc != 0 )); then
@@ -218,8 +219,10 @@ configureNAT() {
     error "$tuntap" && return 1
   fi
 
-  if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+  if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
-    warn "Failed to set MTU size.."
+    if ! ip link set dev "$VM_NET_TAP" mtu "$MTU"; then
+      warn "Failed to set MTU size.."
+    fi
   fi
 
   GATEWAY_MAC=$(echo "$VM_NET_MAC" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:\1:\2:\3:\4:\5/')
@@ -275,6 +278,22 @@ configureNAT() {
   return 0
 }
 
+closeBridge() {
+
+  local pid="/var/run/dnsmasq.pid"
+  [ -s "$pid" ] && pKill "$(<"$pid")"
+
+  [[ "${NETWORK,,}" == "user"* ]] && return 0
+
+  ip link set "$VM_NET_TAP" down promisc off &> null || true
+  ip link delete "$VM_NET_TAP" &> null || true
+
+  ip link set dockerbridge down &> null || true
+  ip link delete dockerbridge &> null || true
+
+  return 0
+}
+
 closeNetwork() {
 
   if [[ "$DHCP" == [Yy1]* ]]; then
@@ -290,26 +309,16 @@ closeNetwork() {
   exec 30<&- || true
   exec 40<&- || true
 
-  if [[ "$DHCP" == [Yy1]* ]]; then
+  if [[ "$DHCP" != [Yy1]* ]]; then
 
-    ip link set "$VM_NET_TAP" down || true
+    closeBridge
-    ip link delete "$VM_NET_TAP" || true
+    return 0
-
-  else
-
-    local pid="/var/run/dnsmasq.pid"
-    [ -s "$pid" ] && pKill "$(<"$pid")"
-
-    [[ "${NETWORK,,}" == "user"* ]] && return 0
-
-    ip link set "$VM_NET_TAP" down promisc off || true
-    ip link delete "$VM_NET_TAP" || true
-
-    ip link set dockerbridge down || true
-    ip link delete dockerbridge || true
 
   fi
 
+  ip link set "$VM_NET_TAP" down || true
+  ip link delete "$VM_NET_TAP" || true
+
   return 0
 }
 
@@ -357,6 +366,16 @@ getInfo() {
     MTU=$(cat "/sys/class/net/$VM_NET_DEV/mtu")
   fi
 
+  if [ "$MTU" -gt "1500" ]; then
+    info "MTU size is too large: $MTU, ignoring..." && MTU="0"
+  fi
+
+  if [[ "${ADAPTER,,}" != "virtio-net-pci" ]]; then
+    if [[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]]; then
+      warn "MTU size is $MTU, but cannot be set for $ADAPTER adapters!" && MTU="0"
+    fi
+  fi
+
   if [ -z "$VM_NET_MAC" ]; then
     local file="$STORAGE/dsm.mac"
     [ -s "$file" ] && VM_NET_MAC=$(<"$file")
@@ -399,7 +418,10 @@ getInfo
 html "Initializing network..."
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  info "Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC  MTU: $MTU"
+  mtu=$(cat "/sys/class/net/$VM_NET_DEV/mtu")
+  line="Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC  MTU: $mtu"
+  [[ "$MTU" != "0" ]] && [[ "$MTU" != "$mtu" ]] && line+=" ($MTU)"
+  info "$line"
   [ -f /etc/resolv.conf ] && grep '^nameserver*' /etc/resolv.conf
   echo
 fi
@@ -442,15 +464,10 @@ else
     # Configure for tap interface
     if ! configureNAT; then
 
+      closeBridge
       NETWORK="user"
       warn "falling back to usermode networking! Performance will be bad and port mapping will not work."
 
-      ip link set "$VM_NET_TAP" down promisc off &> null || true
-      ip link delete "$VM_NET_TAP" &> null || true
-
-      ip link set dockerbridge down &> null || true
-      ip link delete dockerbridge &> null || true
-
     fi
 
   fi
@@ -464,6 +481,7 @@ else
 
 fi
 
-NET_OPTS+=" -device $ADAPTER,romfile=,netdev=hostnet0,mac=$VM_NET_MAC,host_mtu=$MTU,id=net0"
+NET_OPTS+=" -device $ADAPTER,id=net0,netdev=hostnet0,romfile=,mac=$VM_NET_MAC"
+[[ "$MTU" != "0" ]] && [[ "$MTU" != "1500" ]] && NET_OPTS+=",host_mtu=$MTU"
 
 return 0