Document os_shutdown_timeout image property

This adds an entry to the "Useful image properties" docs for
the os_shutdown_timeout property. The description is copied
from the metadata definition.

Change-Id: I96be4b908f929361c201a8369d2e140bf711c923
Closes-Bug: #1784953
This commit is contained in:
Matt Riedemann 2018-10-24 10:16:27 -04:00
parent 88c0bedc24
commit 3f18940d80
1 changed files with 9 additions and 0 deletions

View File

@ -225,6 +225,15 @@ Here is a list of useful image properties and the values they expect.
- * ``required`` - Enable the Secure Boot feature.
* ``disabled`` or ``optional`` - (default) Disable the Secure Boot
feature.
* - All
- ``os_shutdown_timeout``
- By default, guests will be given 60 seconds to perform a graceful
shutdown. After that, the VM is powered off. This property allows
overriding the amount of time (unit: seconds) to allow a guest OS to
cleanly shut down before power off. A value of 0 (zero) means the guest
will be powered off immediately with no opportunity for guest OS
clean-up.
- Integer value (in seconds) with a minimum of 0 (zero). Default is 60.
* - All
- ``ramdisk_id``
- The ID of image stored in the Image service that should be used as the