diff options
author | Lee Yarwood <lyarwood@redhat.com> | 2020-01-01 19:26:08 +0000 |
---|---|---|
committer | Lee Yarwood <lyarwood@redhat.com> | 2020-04-21 10:54:18 +0100 |
commit | 30fcb2ddfd2ab5ef26df9a6726806b011d335f31 (patch) | |
tree | e28e8e3a69750ce6c7d3570b11b40829622b114e | |
parent | 9d88f821df7be2eb7153883f9dd1ec55051ab0ff (diff) | |
download | nova-30fcb2ddfd2ab5ef26df9a6726806b011d335f31.tar.gz |
docs: Add stable device rescue docs
Adds the new mode to the existing user rescue docs and highlights some
known limitations.
Change-Id: Iaa2f27ccb2a77102fde6b24b76c9d5ae54608cca
-rw-r--r-- | doc/source/user/rescue.rst | 51 |
1 files changed, 45 insertions, 6 deletions
diff --git a/doc/source/user/rescue.rst b/doc/source/user/rescue.rst index 3ac940bea1..8a50fe1114 100644 --- a/doc/source/user/rescue.rst +++ b/doc/source/user/rescue.rst @@ -2,9 +2,51 @@ Rescue an instance ================== -Rescue mode provides a mechanism for access, even if an image renders -the instance inaccessible. By default, it starts an instance from the -initial image attaching the current boot disk as a secondary one. +Instance rescue provides a mechanism for access, even if an image renders the +instance inaccessible. Two rescue modes are currently provided. + +Instance rescue +--------------- + +By default the instance is booted from the provided rescue image or a fresh +copy of the original instance image if a rescue image is not provided. The root +disk and optional regenerated config drive are also attached to the instance +for data recovery. + +.. note:: + + Rescuing a volume-backed instance is not supported with this mode. + +Stable device instance rescue +----------------------------- + +As of 21.0.0 (Ussuri) an additional stable device rescue mode is available. +This mode now supports the rescue of volume-backed instances. + +This mode keeps all devices both local and remote attached in their original +order to the instance during the rescue while booting from the provided rescue +image. This mode is enabled and controlled by the presence of +``hw_rescue_device`` or ``hw_rescue_bus`` image properties on the provided +rescue image. + +As their names suggest these properties control the rescue device type +(``cdrom``, ``disk`` or ``floppy``) and bus type (``scsi``, ``virtio``, +``ide``, or ``usb``) used when attaching the rescue image to the instance. + +Support for each combination of the ``hw_rescue_device`` and ``hw_rescue_bus`` +image properties is dependent on the underlying hypervisor and platform being +used. For example the ``IDE`` bus is not available on POWER KVM based compute +hosts. + +.. note:: + + This mode is only supported when using the Libvirt virt driver. + + This mode is not supported when using LXC or Xen hypervisors as enabled by + the :oslo.config:option:`libvirt.virt_type` configurable on the computes. + +Usage +----- .. note:: @@ -13,9 +55,6 @@ initial image attaching the current boot disk as a secondary one. loss of the original instance state and makes it impossible to unrescue the instance. - As of the 20.0.0 (Train) release rescuing a volume-backed server - is not supported. - To perform an instance rescue, use the :command:`openstack server rescue` command: |