External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-10-03 04:45:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve documentation of <disk type='dir'>

Browse Source 
Note the implications and caveats of <disk type='dir'>.

Closes: https://gitlab.com/libvirt/libvirt/-/issues/519
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2023-08-25 14:16:12 +02:00
parent 08339a34ed
commit c3934b2b6b
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/formatdomain.rst
View File

@ -2634,6 +2634,12 @@ paravirtualized driver is specified via the ``disk`` element.
</source>
<target dev='sdb' bus='scsi'/>
</disk>
<disk type='dir' device='floppy'>
<driver name='qemu' type='fat'/>
<source dir='/var/somefiles'>
<target dev='fda'/>
<readonly/>
</disk>
<disk type='volume' device='disk'>
<driver name='qemu' type='raw'/>
<source pool='iscsi-pool' volume='unit:0:0:1' mode='host'/>
@ -2757,6 +2763,18 @@ paravirtualized driver is specified via the ``disk`` element.
``dir``
The ``dir`` attribute specifies the fully-qualified path to the directory
to use as the disk. :since:`Since 0.7.5`
Note that most hypervisors that support ``dir`` disks do that by exposing
an emulated block device with an emulated filesystem populated with
contents of the configured directory. As guest operating system may cache
the filesystem metadata, outside changes to the directory may not appear
in the guest and/or may result in corrupted data being observable from
the VM.
The format of the emulated filesystem is controlled by the ``format``
attribute of the ``<driver>`` driver element. Currently only the ``fat``
format is supported. Hypervisors may only support ``<readonly/>`` mode.
``network``
The ``protocol`` attribute specifies the protocol to access to the
requested image. Possible values are "nbd", "iscsi", "rbd", "sheepdog",