openstack/nova
Code Issues Proposed changes

Merge "docs: Show the recommended way to PXE boot an instance"

Browse Source
This commit is contained in:
Zuul 2025-01-10 03:17:48 +00:00 committed by Gerrit Code Review
commit a2e555574c
2 changed files with 62 additions and 0 deletions

61
doc/source/user/boot-instance-using-PXE.rst Normal file

@ -0,0 +1,61 @@
==========================
Boot an instance using PXE
==========================
Follow the steps below to boot an existing instance using PXE.
Create an image with iPXE
=========================
iPXE is open source boot firmware. See the documentation for more details:
https://ipxe.org/docs
Use the iPXE image as a rescue image
====================================
Boot the instance from the iPXE image using rescue.
Legacy instance rescue
----------------------
The ordering of disks is not guaranteed to be consistent.
.. code-block:: console
$ openstack server rescue --image IPXE_IMAGE INSTANCE_NAME
Stable device instance rescue
-----------------------------
To preserve the ordering of disks when booting, use `stable device rescue`_.
#. Ensure that the ``hw_rescue_device`` (``cdrom`` | ``disk`` | ``floppy``)
and/or the ``hw_rescue_bus`` (``scsi`` | ``virtio`` | ``ide`` | ``usb``) image
properties are set on the image. For example:
.. code-block:: console
$ openstack image set --property hw_rescue_device=disk IPXE_IMAGE
or:
.. code-block:: console
$ openstack image set --property hw_rescue_bus=virtio IPXE_IMAGE
or:
.. code-block:: console
$ openstack image set --property hw_rescue_device=disk \
--property hw_rescue_bus=virtio IPXE_IMAGE
#. Run the rescue using the API microversion 2.87 or later:
.. code-block:: console
$ openstack --os-compute-api-version 2.87 server rescue \
--image IPXE_IMAGE INSTANCE_NAME
.. _stable device rescue: https://docs.openstack.org/nova/latest/user/rescue.html#stable-device-instance-rescue

1
doc/source/user/launch-instances.rst

@ -165,4 +165,5 @@ You can launch an instance from various sources.
launch-instance-from-image
launch-instance-from-volume
launch-instance-using-ISO-image
boot-instance-using-PXE