public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Markus Frank <m.frank@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH docs v2 8/11] virtiofs: add documentation for live migration
Date: Mon, 23 Feb 2026 16:40:05 +0100	[thread overview]
Message-ID: <20260223155951.468572-9-m.frank@proxmox.com> (raw)
In-Reply-To: <20260223155951.468572-1-m.frank@proxmox.com>

Also update the virtiofs known limitations.

Signed-off-by: Markus Frank <m.frank@proxmox.com>
---
v2 changes:
* added link for further information about virtiofs limitations.

 qm.adoc | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/qm.adoc b/qm.adoc
index 09fbd20..03224a7 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -1297,10 +1297,12 @@ Known Limitations
 * Memory hotplug does not work in combination with virtiofs (also results in
   hanging access).
 * Memory related features such as live migration, snapshots, and hibernate are
-  not available with virtiofs devices.
+  not available with virtiofs devices on {pve} 8.
 * Windows cannot understand ACLs in the context of virtiofs. Therefore, do not
   expose ACLs for Windows VMs, otherwise the virtiofs device will not be visible
   within the VM.
+* For further limitations, see the
+  https://gitlab.com/virtio-fs/virtiofsd#limitations[GitLab page of virtiofsd].
 
 Add Mapping for Shared Directories
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -1314,6 +1316,29 @@ pvesh create /cluster/mapping/dir --id dir1 \
     --map node=node2,path=/path/to/share2 \
 ----
 
+Live Migration
+^^^^^^^^^^^^^^
+
+Live migration is possible on {pve} 9 (Debian Trixie) because versions of
+Virtiofsd starting with v1.11.0 support live migration. To enable live
+migration, select a method using the `live-migration-method` parameter in the
+Directory Mapping (xref:resource_mapping[Resource Mapping]). If a live migration
+method is selected, virtiofsd will start with the flags to enable live migration
+using the chosen method. Ensure you are using the same shared directory on both
+hosts before migrating.
+
+Available migration methods are `file-handles` and `find-path`:
+
+* In the `find-paths` migration mode, virtiofsd tries to find the path inside of
+  the shared directory for every filesystem object that must be transferred to
+  the destination.
+* In the `file-handles` migration mode every filesystem object is converted to a
+  file handle.
+
+For more information about the live migration methods, see the
+https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/doc/migration.md[virtiofsd
+migration page on GitLab].
+
 Add virtiofs to a VM
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -2162,6 +2187,10 @@ Currently there are the following options:
   migrating passed through devices is an experimental feature and may not work
   or cause issues.
 
+* `live-migration-method` (Directory): This sets the live migration mode for
+  virtiofs. If a live migration method is selected, virtiofsd will start with
+  the flags to enable live migration using the chosen method. Available
+  migration methods are `file-handles` and `find-path`.
 
 Managing Virtual Machines with `qm`
 ------------------------------------
-- 
2.47.3





  parent reply	other threads:[~2026-02-23 16:01 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-23 15:39 [PATCH guest-common/qemu-server/docs/manager v2 0/11] Virtiofs improvements Markus Frank
2026-02-23 15:39 ` [PATCH guest-common v2 1/11] mapping: dir: add 'live-migration-method' parameter Markus Frank
2026-02-23 15:39 ` [PATCH qemu-server v2 2/11] fix #6370: virtiofs: add support for thread-pool-size option Markus Frank
2026-02-23 15:40 ` [PATCH qemu-server v2 3/11] virtiofs: add readonly option Markus Frank
2026-02-23 15:40 ` [PATCH qemu-server v2 4/11] virtiofs: add live migration support Markus Frank
2026-02-23 15:40 ` [PATCH docs v2 5/11] virtiofs: add explanation for cache=metadata behavior Markus Frank
2026-02-23 15:40 ` [PATCH docs v2 6/11] virtiofs: add table for optional parameters Markus Frank
2026-02-23 15:40 ` [PATCH docs v2 7/11] virtiofs: add thread-pool-size description Markus Frank
2026-02-23 15:40 ` Markus Frank [this message]
2026-02-23 15:40 ` [PATCH manager v2 09/11] fix #6370: ui: virtiofs edit: add support for thread-pool-size option Markus Frank
2026-02-23 15:40 ` [PATCH manager v2 10/11] virtiofs edit: add support for readonly option Markus Frank
2026-02-23 15:40 ` [PATCH manager v2 11/11] directory mapping: add live-migration-method option for virtiofs Markus Frank

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260223155951.468572-9-m.frank@proxmox.com \
    --to=m.frank@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal