External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00
Code

docs: Add s390-pv documentation

Browse Source 
Add documentation for launch security type s390-pv.

Signed-off-by: Boris Fiuczynski <fiuczy@linux.ibm.com>
Reviewed-by: Daniel Henrique Barboza <danielhb413@gmail.com>
Reviewed-by: Pavel Hrdina <phrdina@redhat.com>
This commit is contained in:
Boris Fiuczynski 2021-07-16 11:44:31 +02:00 committed by Pavel Hrdina
parent 9568a4d410
commit b823f7a781
2 changed files with 54 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/formatdomain.rst
View File

@ -8082,6 +8082,13 @@ Note: DEA/TDEA is synonymous with DES/TDES.
Launch Security Launch Security
--------------- ---------------
Specifying ``<launchSecurity type='s390-pv'\>`` in a s390 domain prepares
the guest to run in protected virtualization secure mode, also known as
IBM Secure Execution. For more required host and guest preparation steps, see
`Protected Virtualization on s390 <kbase/s390_protected_virt.html>`__
:since:`Since 7.6.0`
The contents of the ``<launchSecurity type='sev'>`` element is used to provide The contents of the ``<launchSecurity type='sev'>`` element is used to provide
the guest owners input used for creating an encrypted VM using the AMD SEV the guest owners input used for creating an encrypted VM using the AMD SEV
feature (Secure Encrypted Virtualization). SEV is an extension to the AMD-V feature (Secure Encrypted Virtualization). SEV is an extension to the AMD-V

55
docs/kbase/s390_protected_virt.rst
View File

@ -127,10 +127,13 @@ Protected virtualization guests support I/O using virtio devices.
As the virtio data structures of secure guests are not accessible As the virtio data structures of secure guests are not accessible
by the host, it is necessary to use shared memory ('bounce buffers'). by the host, it is necessary to use shared memory ('bounce buffers').
To enable virtio devices to use shared buffers, it is necessary Since libvirt 7.6.0 the
to configure them with platform_iommu enabled. This can done by adding `<launchSecurity> <https://libvirt.org/formatdomain.html#launchSecurity>`__
``iommu='on'`` to the driver element of a virtio device definition in the element with type ``s390-pv`` should be used on protected virtualization guests.
guest's XML, e.g. Without ``launchSecurity`` you must enable all virtio devices to use shared
buffers by configuring them with platform_iommu enabled.
This can done by adding ``iommu='on'`` to the driver element of a virtio
device definition in the guest's XML, e.g.
:: ::
@ -140,8 +143,10 @@ guest's XML, e.g.
<driver name='vhost' iommu='on'/> <driver name='vhost' iommu='on'/>
</interface> </interface>
It is mandatory to define all virtio bus devices in this way to Unless you are using ``launchSecurity`` you must define all virtio bus
prevent the host from attempting to access protected memory. devices in this way to prevent the host from attempting to access
protected memory.
Ballooning will not work and is fenced by QEMU. It should be Ballooning will not work and is fenced by QEMU. It should be
disabled by specifying disabled by specifying
@ -158,8 +163,42 @@ allocated 2K entries. A commonly used value for swiotlb is 262144.
Example guest definition Example guest definition
======================== ========================
Minimal domain XML for a protected virtualization guest, essentially Minimal domain XML for a protected virtualization guest with
it's mostly about the ``iommu`` property the ``launchSecurity`` element of type ``s390-pv``
::
<domain type='kvm'>
<name>protected</name>
<memory unit='KiB'>2048000</memory>
<currentMemory unit='KiB'>2048000</currentMemory>
<vcpu>1</vcpu>
<os>
<type arch='s390x'>hvm</type>
</os>
<cpu mode='host-model'/>
<devices>
<disk type='file' device='disk'>
<driver name='qemu' type='qcow2' cache='none' io='native'>
<source file='/var/lib/libvirt/images/protected.qcow2'/>
<target dev='vda' bus='virtio'/>
</disk>
<interface type='network'>
<source network='default'/>
<model type='virtio'/>
</interface>
<console type='pty'/>
<memballoon model='none'/>
</devices>
<launchSecurity type='s390-pv'/>
</domain>
Example guest definition without launchSecurity
===============================================
Minimal domain XML for a protected virtualization guest using the
``iommu='on'`` setting for each virtio device.
:: ::