kvm/virtiofsd: New page

Author: iBug

docs/assets/virtiofsd.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+if test $# -ne 2; then
+  echo "Need exactly 2 arguments" >&2
+  exit 1
+fi
+
+VMID="$1"
+PHASE="$2"
+
+if [ "$VMID" -lt 1000 ]; then
+  exit 0
+fi
+
+case "$PHASE" in
+  pre-start) systemctl restart "virtiofsd@$VMID".service ;;
+  pre-stop) ;;
+  post-start) ;;
+  post-stop) ;;
+  *) echo "Unknown phase $PHASE" >&2; exit 1;;
+esac

docs/assets/[email protected]

@@ -0,0 +1,33 @@
+[Unit]
+Description=VirtIO Filesystem Daemon for /opt/vlab (VMID: %i)
+
+[Service]
+Type=exec
+WorkingDirectory=/run/virtiofsd
+RuntimeDirectory=virtiofsd
+Environment=SHARED_DIR=/opt/vlab
+ExecStart=/usr/libexec/virtiofsd \
+  --syslog \
+  --socket-path /run/virtiofsd/%i.sock \
+  --shared-dir $SHARED_DIR \
+  --sandbox namespace \
+  --announce-submounts \
+  --inode-file-handles=prefer
+
+ReadOnlyPaths=/opt/vlab
+InaccessiblePaths=/boot /etc /home /var
+
+SystemCallArchitectures=native
+LockPersonality=yes
+MemoryDenyWriteExecute=yes
+RestrictAddressFamilies=AF_UNIX
+
+PrivateTmp=yes
+#PrivateDevices=yes
+ProtectClock=yes
+ProtectHome=yes
+ProtectHostname=yes
+ProtectKernelLogs=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+ProtectSystem=yes

docs/kvm/virtiofsd.md

@@ -0,0 +1,47 @@
+# 虚拟机 VirtIO FS 文件系统配置
+
+[virtiofsd](https://virtio-fs.gitlab.io/) 是一种将主机上的文件系统共享进虚拟机的机制，类似 NFS，但不经过网络，而是使用本地的 Unix socket 和 FUSE 语义，可以提供比 NFS 更好的性能。
+
+## 主机配置
+
+为 virtiofsd 创建一个模板化的 systemd 服务，以便在主机上启动 virtiofsd 服务（[文件下载](../assets/[email protected])）：
+
+```ini title="/etc/systemd/system/[email protected]"
+--8<-- "[email protected]"
+```
+
+然后编写一个 hook script 脚本（[文件下载](../assets/virtiofsd.sh)）：
+
+```shell title="/mnt/vz/snippets/virtiofsd.sh"
+--8<-- "virtiofsd.sh"
+```
+
+## 虚拟机配置
+
+每个想要使用 `/opt/vlab` 的虚拟机都需要配置以下两点：
+
+```yaml
+args: -chardev socket,id=virtfs0,path=/run/virtiofsd/9612.sock -device vhost-user-fs-pci,queue-size=1024,chardev=virtfs0,tag=vlab-software -object memory-backend-file,id=mem,size=6144M,mem-path=/dev/shm,share=on -numa node,memdev=mem
+hookscript: nfs-template:snippets/virtiofsd.sh
+```
+
+其中 `args` 里有两点需要注意：
+
+- `socket,[...],path=` 后面的路径需要和前面的 systemd service 中为 `virtiofsd` 指定的 socket 路径一致；
+- `memory-backend-file` 的 `size` 需要和虚拟机和内存大小一致。
+
+除此之外，`vhost-user-fs-pci` 后面的 `tag` 参数就是在虚拟机内挂载的 source。以此处的 `tag=vlab-software` 为例，虚拟机内的挂载命令为：
+
+```shell
+mount -t virtiofs vlab-software /opt/vlab
+```
+
+对应的 fstab 写法为：
+
+```shell
+vlab-software /opt/vlab virtiofs nofail 0 0
+```
+
+## 参考资料
+
+- [\[TUTORIAL\] virtiofsd in PVE 8.0.x](https://forum.proxmox.com/threads/virtiofsd-in-pve-8-0-x.130531/)

mkdocs.yml

@@ -112,6 +112,7 @@ nav:
     - 相关记录: vlab-software/misc.md
   - KVM 虚拟机:
     - cloud-init 配置: kvm/cloud-init.md
+    - VirtIO FS 配置: kvm/virtiofsd.md
   - 测试环境:
     - 简介: testing/index.md
     - Vlab VPN: testing/devvpn.md