From 3f18940d809f6b7a48a7feba8099e997152e64e8 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 24 Oct 2018 10:16:27 -0400 Subject: [PATCH] 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 --- doc/source/admin/useful-image-properties.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/source/admin/useful-image-properties.rst b/doc/source/admin/useful-image-properties.rst index 88c37c4bf8..675ba6b2fa 100644 --- a/doc/source/admin/useful-image-properties.rst +++ b/doc/source/admin/useful-image-properties.rst @@ -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