NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: domain: Be more upfront about 'sgio' not being actually supported

Browse Source 
The support for the 'sgio' attribute for SCSI-backed devices was dropped
as there wasn't really ever any upstream support for it.

The docs do state that support for this depends on the hypervisor
itself, but we can be more clear that there is no hypervisor which does
support it.

There is also a suggestion to use 'sgio' instead of 'rawio' as being
more "secure" but since it no longer works drop this suggestion.

Resolves: https://issues.redhat.com/browse/RHEL-65268
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2024-10-30 10:17:46 +01:00
parent d02140383d
commit eb4ed1fe15
1 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/formatdomain.rst
View File

@ -2767,14 +2767,13 @@ paravirtualized driver is specified via the ``disk`` element.
per-process basis). This attribute is only valid when device is "lun". NB, per-process basis). This attribute is only valid when device is "lun". NB,
``rawio`` intends to confine the capability per-device, however, current ``rawio`` intends to confine the capability per-device, however, current
QEMU implementation gives the domain process broader capability than that QEMU implementation gives the domain process broader capability than that
(per-process basis, affects all the domain disks). To confine the (per-process basis, affects all the domain disks). :since:`Since 0.9.10`
capability as much as possible for QEMU driver as this stage, ``sgio`` is
recommended, it's more secure than ``rawio``. :since:`Since 0.9.10`
``sgio`` ``sgio``
If supported by the hypervisor and OS, indicates whether unprivileged If supported by the hypervisor and OS, indicates whether unprivileged
SG_IO commands are filtered for the disk. Valid settings are "filtered" or SG_IO commands are filtered for the disk. Valid settings are "filtered" or
"unfiltered" where the default is "filtered". Only available when the "unfiltered" where the default is "filtered". Only available when the
``device`` is 'lun'. :since:`Since 1.0.2` ``device`` is 'lun'. The attribute exists :since:`Since 1.0.2`, although
currently it's no longer supported by any hypervisor.
``snapshot`` ``snapshot``
Indicates the default behavior of the disk during disk snapshots: Indicates the default behavior of the disk during disk snapshots:
``internal`` requires a file format such as qcow2 that can store both ``internal`` requires a file format such as qcow2 that can store both
@ -4346,7 +4345,7 @@ or:
... ...
<devices> <devices>
<hostdev mode='subsystem' type='scsi' sgio='filtered' rawio='yes'> <hostdev mode='subsystem' type='scsi' rawio='yes'>
<source> <source>
<adapter name='scsi_host0'/> <adapter name='scsi_host0'/>
<address bus='0' target='0' unit='0'/> <address bus='0' target='0' unit='0'/>
@ -4436,14 +4435,19 @@ or:
``display`` attribute to be set to ``on``. ``display`` attribute to be set to ``on``.
``scsi`` ``scsi``
For SCSI devices, user is responsible to make sure the device is not used For SCSI devices, user is responsible to make sure the device is not used
by host. If supported by the hypervisor and OS, the optional ``sgio`` ( by host.
:since:`since 1.0.6` ) attribute indicates whether unprivileged SG_IO
commands are filtered for the disk. Valid settings are "filtered" or If supported by the hypervisor and OS, the optional ``sgio`` (
"unfiltered", where the default is "filtered". The optional ``rawio`` ( :since:`since 1.0.6`, but currently no longer supported by any hypervisor
:since:`since 1.2.9` ) attribute indicates whether the lun needs the rawio driver ) attribute indicates whether unprivileged SG_IO commands are
capability. Valid settings are "yes" or "no". See the rawio description filtered for the disk. Valid settings are "filtered" or
within the `Hard drives, floppy disks, CDROMs`_ section. If a disk lun in the domain "unfiltered", where the default is "filtered".
already has the rawio capability, then this setting not required.
The optional ``rawio`` (:since:`since 1.2.9` ) attribute indicates whether
the lun needs the rawio capability. Valid settings are "yes" or "no".
See the rawio description within the `Hard drives, floppy disks, CDROMs`_
section. If a disk lun in the domain already has the rawio capability,
then this setting not required.
``scsi_host`` ``scsi_host``
:since:`since 2.5.0` For SCSI devices, user is responsible to make sure :since:`since 2.5.0` For SCSI devices, user is responsible to make sure
the device is not used by host. This ``type`` passes all LUNs presented by the device is not used by host. This ``type`` passes all LUNs presented by