diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index a055b38ec4..ab66bbaa6a 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -903,6 +903,113 @@ +

Filesystems

+ +

+ A directory on the host that can be accessed directly from the guest. + since 0.3.3, since 0.8.5 for QEMU/KVM +

+ +
+  ...
+  <devices>
+    <filesystem type='template'>
+      <source name='my-vm-template'/>
+      <target dir='/'/>
+    </filesystem>
+    <filesystem type='mount' >
+      <source dir='/export/to/guest'/>
+      <target dir='/import/from/host'/>
+      <readonly/>
+    </filesystem>
+    ...
+  </devices>
+  ...
+ +
+
filesystem
+
+ + The filesystem attribute type specifies the type of the + source. The possible values are: + +
+
type='mount'
+
+ A host directory to mount in the guest. Used by LXC, + OpenVZ (since 0.6.2) + and QEMU/KVM (since 0.8.5). + This is the default mode if one is not specified. +
+
type='template'
+
+ OpenVZ filesystem template. Only used by OpenVZ driver. +
+
type='file'
+
+ Currently unused. +
+
type='block'
+
+ Currently unused. +
+
+ + The filesystem block has an optional attribute mode + which specifies the security mode for accessing the source + (since 0.8.5). Currently this only works + with type='mount' for the QEMU/KVM driver. The possible + values are: + +
+
mode='passthrough'
+
+ The source is accessed with the permissions of the + user inside the guest. This is the default mode if + one is not specified. + More info +
+
mode='mapped'
+
+ The source is accessed with the permissions of the + hypervisor (QEMU process). + More info +
+
mode='squash'
+
+ Similar to 'passthrough', the exception is that failure of + privileged operations like 'chown' are ignored. This makes a + passthrough-like mode usable for people who run the hypervisor + as non-root. + More info +
+
+ +
+ +
source
+
+ The resource on the host that is being accessed in the guest. The + name attribute must be used with + type='template', and the dir attribute must + be used with type='mount' +
+ +
target
+
+ Where the source can be accessed in the guest. For + most drivers this is an automatic mount point, but for QEMU/KVM + this is merely an arbitrary string tag that is exported to the + guest as a hint for where to mount. +
+ +
readonly
+
+ An optional readonly attribute is available but currently + unused. +
+
+

Controllers