openstack/ironic
Code Issues Proposed changes

Add L3 boot section to the docs

Browse Source 
Describes virtual media based L3/DHCP-less ramdisk booting in the
`redfish` hardware type documentation.

Added warning to the deploy-ramdisk docs since the images
we publish will not work.

Co-Authored: Iury Gregory Melo Ferreira <iurygregory@gmail.com>
Change-Id: If9ead46db30ce519f128550f1071a1f01f7a5ccf
Story: 2006691
Task: 37073
This commit is contained in:
Ilya Etingof 2019-10-21 18:56:20 +02:00 committed by Iury Gregory Melo Ferreira
parent 99e8fc9810
commit 747753f911
2 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
doc/source/admin/drivers/redfish.rst
View File

@ -208,7 +208,52 @@ This initial interface does not support bootloader configuration
parameter injection, as such the ``[instance_info]/kernel_append_params``
setting is ignored.
Layer 3 or DHCP-less ramdisk booting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The DHCP used by PXE requires direct L2 connectivity between the node and the
service since it's a User Datagram Protocol (UDP) like other protocols used by
the PXE suite, there is no guarantee that packets will be delivered.
One of the solutions is the reliance on virtual media boot capability coupled
with another feature of ``redfish`` hardware type - its ability to provide
network configuration that is placed in the config-drive_ of the node, the
configuration follows the same schema that OpenStack Nova uses for the
``network_data.json``. The config drive filesystem information is on the IPA
ramdisk ISO image from which the node is booted.
The Glean_ tool is available in the simple-init_ element that needs to be used
when creating the ramdisk image. The ironic ramdisk will probe all removable
media devices on the node in search of media labeled as `config-2`. If found,
this tool will consume static network configuration and set up node's
networking stack accordingly without calling out for DHCP.
When ironic is running within OpenStack, no additional configuration is required
on the ironic side - config drive with ramdisk network configuration will be
collected from Networking service and written on the IPA ramdisk ISO.
Alternatively, the user can build and pass node network configuration, in
form of a network_data_ JSON blob, to ironic node being managed via the
``--network-data`` CLI option. Node-based configuration takes precedence over
the configuration generated by the Network service.
.. code-block:: bash
openstack baremetal node set \
--network-data ~/network_data.json <node>
Node-based configuration can be useful in standalone ironic deployment
scenario.
.. note::
Make sure to use add the simple-init_ element when building the IPA ramdisk.
.. _Redfish: http://redfish.dmtf.org/
.. _Sushy: https://opendev.org/openstack/sushy
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. _ESP: https://wiki.ubuntu.com/EFIBootLoaders#Booting_from_EFI
.. _network_data: https://specs.openstack.org/openstack/nova-specs/specs/liberty/implemented/metadata-service-network-info.html
.. _config-drive: https://docs.openstack.org/nova/queens/user/config-drive.html
.. _Glean: https://docs.openstack.org/infra/glean/
.. _simple-init: https://docs.openstack.org/diskimage-builder/latest/elements/simple-init/README.html

5
doc/source/install/deploy-ramdisk.rst
View File

@ -19,6 +19,10 @@ Two kinds of images are published on every commit from every branch of
.. warning:: CentOS 7 master images are no longer updated and must not be
used.
.. warning:: The published images will not work for dhcp-less deployments
since the simple-init_ element is not present. Check the DIB_
documentation to see how to build the image.
* TinyIPA_ images are suitable for CI and testing environments and can be
downloaded from
https://tarballs.openstack.org/ironic-python-agent/tinyipa/files/.
@ -32,3 +36,4 @@ ironic-python-agent ramdisks.
.. _DIB: https://docs.openstack.org/ironic-python-agent-builder/latest/admin/dib.html
.. _TinyIPA: https://docs.openstack.org/ironic-python-agent-builder/latest/admin/tinyipa.html
.. _ironic-python-agent-builder: https://docs.openstack.org/ironic-python-agent-builder/latest/
.. _simple-init: https://docs.openstack.org/diskimage-builder/latest/elements/simple-init/README.html