proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-30 06:12:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

qemu: consistently use virtiofs term

Browse Source 
Upstream always uses virtiofs besides inside the projects URL, which
I'd just ignore.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2025-04-08 17:17:44 +02:00
parent 1aaa3ecbb6
commit 9afbde533d
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
qm.adoc
View File

@ -1253,40 +1253,40 @@ resources. If desired, a value of '0' for `max_bytes` can be used to disable
all limits. all limits.
[[qm_virtiofs]] [[qm_virtiofs]]
Virtio-fs Virtiofs
~~~~~~~~~ ~~~~~~~~
Virtio-fs is a shared filesystem designed for virtual environments. It allows to Virtiofs is a shared filesystem designed for virtual environments. It allows to
share a directory tree available on the host by mounting it within VMs. It does share a directory tree available on the host by mounting it within VMs. It does
not use the network stack and aims to offer similar performance and semantics as not use the network stack and aims to offer similar performance and semantics as
the source filesystem. the source filesystem.
To use virtio-fs, the https://gitlab.com/virtio-fs/virtiofsd[virtiofsd] daemon To use virtiofs, the https://gitlab.com/virtio-fs/virtiofsd[virtiofsd] daemon
needs to run in the background. This happens automatically in {pve} when needs to run in the background. This happens automatically in {pve} when
starting a VM using a virtio-fs mount. starting a VM using a virtiofs mount.
Linux VMs with kernel >=5.4 support virtio-fs by default Linux VMs with kernel >=5.4 support virtiofs by default
(https://www.kernelconfig.io/CONFIG_VIRTIO_FS[virtiofs kernel module]), but some (https://www.kernelconfig.io/CONFIG_VIRTIO_FS[virtiofs kernel module]), but some
features require a newer kernel. features require a newer kernel.
There is a There is a
https://github.com/virtio-win/kvm-guest-drivers-windows/wiki/Virtiofs:-Shared-file-system[guide] https://github.com/virtio-win/kvm-guest-drivers-windows/wiki/Virtiofs:-Shared-file-system[guide]
available on how to utilize virtio-fs in Windows VMs. available on how to utilize virtiofs in Windows VMs.
Known Limitations Known Limitations
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
* If virtiofsd crashes, its mount point will hang in the VM until the VM * If virtiofsd crashes, its mount point will hang in the VM until the VM
is completely stopped. is completely stopped.
* virtiofsd not responding may result in a hanging mount in the VM, similar to * virtiofsd not responding may result in a hanging mount in the VM, similar to
an unreachable NFS. an unreachable NFS.
* Memory hotplug does not work in combination with virtio-fs (also results in * Memory hotplug does not work in combination with virtiofs (also results in
hanging access). hanging access).
* Memory related features such as live migration, snapshots, and hibernate are * Memory related features such as live migration, snapshots, and hibernate are
not available with virtio-fs devices. not available with virtiofs devices.
* Windows cannot understand ACLs in the context of virtio-fs. Therefore, do not * Windows cannot understand ACLs in the context of virtiofs. Therefore, do not
expose ACLs for Windows VMs, otherwise the virtio-fs device will not be expose ACLs for Windows VMs, otherwise the virtiofs device will not be visible
visible within the VM. within the VM.
Add Mapping for Shared Directories Add Mapping for Shared Directories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1300,10 +1300,10 @@ pvesh create /cluster/mapping/dir --id dir1 \
--map node=node2,path=/path/to/share2 \ --map node=node2,path=/path/to/share2 \
---- ----
Add virtio-fs to a VM Add virtiofs to a VM
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
To share a directory using virtio-fs, add the parameter `virtiofs<N>` (N can be To share a directory using virtiofs, add the parameter `virtiofs<N>` (N can be
anything between 0 and 9) to the VM config and use a directory ID (dirid) that anything between 0 and 9) to the VM config and use a directory ID (dirid) that
has been configured in the resource mapping. Additionally, you can set the has been configured in the resource mapping. Additionally, you can set the
`cache` option to either `always`, `never`, `metadata`, or `auto` (default: `cache` option to either `always`, `never`, `metadata`, or `auto` (default:
@ -1311,7 +1311,7 @@ has been configured in the resource mapping. Additionally, you can set the
can be read https://lwn.net/Articles/774495/[here under the "Caching Modes" can be read https://lwn.net/Articles/774495/[here under the "Caching Modes"
section]. To enable writeback cache set `writeback` to `1`. section]. To enable writeback cache set `writeback` to `1`.
Virtiofsd supports ACL and xattr passthrough (can be enabled with the The `virtiofsd` supports ACL and xattr passthrough (can be enabled with the
`expose-acl` and `expose-xattr` options), allowing the guest to access ACLs and `expose-acl` and `expose-xattr` options), allowing the guest to access ACLs and
xattrs if the underlying host filesystem supports them, but they must also be xattrs if the underlying host filesystem supports them, but they must also be
compatible with the guest filesystem (for example most Linux filesystems support compatible with the guest filesystem (for example most Linux filesystems support
@ -1320,7 +1320,7 @@ ACLs, while Windows filesystems do not).
The `expose-acl` option automatically implies `expose-xattr`, that is, it makes The `expose-acl` option automatically implies `expose-xattr`, that is, it makes
no difference if you set `expose-xattr` to `0` if `expose-acl` is set to `1`. no difference if you set `expose-xattr` to `0` if `expose-acl` is set to `1`.
If you want virtio-fs to honor the `O_DIRECT` flag, you can set the `direct-io` If you want virtiofs to honor the `O_DIRECT` flag, you can set the `direct-io`
parameter to `1` (default: `0`). This will degrade performance, but is useful if parameter to `1` (default: `0`). This will degrade performance, but is useful if
applications do their own caching. applications do their own caching.
@ -1330,7 +1330,7 @@ qm set <vmid> -virtiofs1 <dirid>,cache=never,expose-xattr=1
qm set <vmid> -virtiofs2 <dirid>,expose-acl=1,writeback=1 qm set <vmid> -virtiofs2 <dirid>,expose-acl=1,writeback=1
---- ----
To temporarily mount virtio-fs in a guest VM with the Linux kernel virtio-fs To temporarily mount virtiofs in a guest VM with the Linux kernel virtiofs
driver, run the following command inside the guest: driver, run the following command inside the guest:
---- ----