Skip to contentSkip to conversation

docs/microvm.rst: fix alignment and explain shut down

PATCH Applied Sergio Lopez 2 participants 4 messages Nov 15, 2019

lore
Share & tools
lore
#0 lore raw

cover docs/microvm.rst: fix alignment and explain shut down

Fix the alignment in the "Limitations" section and include an explanation about the particularities of the microvm machine type when it comes to triggering a guest initiated shut down.

Sergio Lopez (2):
docs/microvm.rst: fix alignment in "Limitations" docs/microvm.rst: add instructions for shutting down the guest

 docs/microvm.rst | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)
Signature · 1 line
2.23.0
#1 lore raw

PATCH 1/2 docs/microvm.rst: fix alignment in "Limitations"

Fix the alignment of the items in the "Limitations" section.

---
 docs/microvm.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
docs/microvm.rst +3 -3
index aae811a922..4cf84746b9 100644
@@ -33,9 +33,9 @@ Limitations
 
 Currently, microvm does *not* support the following features:
 
- - PCI-only devices.
- - Hotplug of any kind.
- - Live migration across QEMU versions.
+- PCI-only devices.
+- Hotplug of any kind.
+- Live migration across QEMU versions.
 
 
 Using the microvm machine type
Signature · 1 line
2.23.0
#2 lore raw

PATCH 2/2 docs/microvm.rst: add instructions for shutting down the guest

In reply to Sergio Lopez

Add a new section explaining the particularities of the microvm machine type for triggering a guest-initiated shut down.

---
 docs/microvm.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
docs/microvm.rst +21 -0
index 4cf84746b9..fcf41fc1f6 100644
@@ -106,3 +106,24 @@ disabled::
      -device virtio-blk-device,drive=test \
      -netdev tap,id=tap0,script=no,downscript=no \
      -device virtio-net-device,netdev=tap0
+
+
+Triggering a guest-initiated shut down
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As the microvm machine type includes just a small set of system
+devices, some x86 mechanisms for rebooting or shutting down the
+system, like sending a key sequence to the keyboard or writing to an
+ACPI register, doesn't have any effect in the VM.
+
+The recommended way to trigger a guest-initiated shut down is by
+generating a ``triple-fault``, which will cause the VM to initiate a
+reboot. Additionally, if the ``-no-reboot`` argument is present in the
+command line, QEMU will detect this event and terminate its own
+execution gracefully.
+
+Linux does support this mechanism, but by default will only be used
+after other options have been tried and failed, causing the reboot to
+be delayed by a small number of seconds. It's possible to instruct it
+to try the triple-fault mechanism first, by adding ``reboot=t`` to the
+kernel's command line.
Signature · 1 line
2.23.0
#3 lore raw

Re: [PATCH 2/2] docs/microvm.rst: add instructions for shutting down the guest

Quoted 28 lines · Sergio Lopez

Add a new section explaining the particularities of the microvm machine type for triggering a guest-initiated shut down.

---
 docs/microvm.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
docs/microvm.rst +11 -0
index 4cf84746b9..fcf41fc1f6 100644
@@ -106,3 +106,24 @@ disabled::
      -device virtio-blk-device,drive=test \
      -netdev tap,id=tap0,script=no,downscript=no \
      -device virtio-net-device,netdev=tap0
+
+
+Triggering a guest-initiated shut down
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As the microvm machine type includes just a small set of system
+devices, some x86 mechanisms for rebooting or shutting down the
+system, like sending a key sequence to the keyboard or writing to an
+ACPI register, doesn't have any effect in the VM.
+
+The recommended way to trigger a guest-initiated shut down is by

docs/microvm.rst disabled:: · line 129

Quoted 10 lines
docs/microvm.rst +10 -0
+generating a ``triple-fault``, which will cause the VM to initiate a
+reboot. Additionally, if the ``-no-reboot`` argument is present in the
+command line, QEMU will detect this event and terminate its own
+execution gracefully.
+
+Linux does support this mechanism, but by default will only be used
+after other options have been tried and failed, causing the reboot to
+be delayed by a small number of seconds. It's possible to instruct it
+to try the triple-fault mechanism first, by adding ``reboot=t`` to the
+kernel's command line.

Queued, thanks.

Paolo