openstack/ironic
Code Issues Proposed changes

Merge "Follow-up to `ilo` hardware type documentation"

Browse Source
This commit is contained in:
Jenkins 2017-08-22 10:48:56 +00:00 committed by Gerrit Code Review
commit 9c2cd51ec0
1 changed files with 71 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
doc/source/admin/drivers/ilo.rst
View File

@ -47,6 +47,16 @@ and local-boot of instance.
and deploys from ironic conductor. Additionally it supports automatic setting of and deploys from ironic conductor. Additionally it supports automatic setting of
requested boot mode from nova. This driver doesn't require iLO Advanced license. requested boot mode from nova. This driver doesn't require iLO Advanced license.
The hardware type ``ilo`` and iLO-based classic drivers support HPE server
features like:
* UEFI secure boot
* Certificate based validation of iLO
* Hardware based secure disk erase using Smart Storage Administrator (SSA) CLI
* Out-of-band discovery of server attributes through hardware inspection
* In-band RAID configuration
* Firmware configuration and secure firmware update
Hardware Interfaces Hardware Interfaces
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
@ -189,8 +199,8 @@ Prerequisites
* ``ipmitool`` command must be present on the service node(s) where * ``ipmitool`` command must be present on the service node(s) where
``ironic-conductor`` is running. On most distros, this is provided as part ``ironic-conductor`` is running. On most distros, this is provided as part
of the ``ipmitool`` package. Refer to `Hardware Inspection Support`_ for more of the ``ipmitool`` package. Please refer to `Hardware Inspection Support`_
information on recommended version. for more information on recommended version.
Different Configuration for ilo drivers Different Configuration for ilo drivers
======================================= =======================================
@ -414,7 +424,7 @@ Requirements
Deploy Process Deploy Process
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Refer to `Netboot with glance and swift`_ and Please refer to `Netboot with glance and swift`_ and
`Localboot with glance and swift for partition images`_ for the deploy process `Localboot with glance and swift for partition images`_ for the deploy process
of partition image and `Localboot with glance and swift`_ for the deploy of partition image and `Localboot with glance and swift`_ for the deploy
process of whole disk image. process of whole disk image.
@ -422,7 +432,7 @@ process of whole disk image.
Configuring and Enabling the driver Configuring and Enabling the driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Glance Configuration`_ and `Enable driver`_. Please refer to `Glance Configuration`_ and `Enable driver`_.
Registering ProLiant node in ironic Registering ProLiant node in ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -463,35 +473,37 @@ node::
Boot modes Boot modes
~~~~~~~~~~ ~~~~~~~~~~
Refer to `Boot mode support`_ section for more information. Please refer to `Boot mode support`_ for more information.
UEFI Secure Boot UEFI Secure Boot
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
Refer to `UEFI Secure Boot Support`_ section for more information. Please refer to `UEFI Secure Boot Support`_ for more information.
Node cleaning Node cleaning
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Refer to `Node Cleaning Support`_ for more information. Please refer to `Node Cleaning Support`_ for more information.
Hardware Inspection Hardware Inspection
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
Refer to `Hardware Inspection Support`_ for more information. Please refer to `Hardware Inspection Support`_ for more information.
Swiftless deploy for intermediate deploy and boot images Swiftless deploy for intermediate deploy and boot images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Swiftless deploy for intermediate images`_ for more information. Please refer to `Swiftless deploy for intermediate images`_ for more
information.
HTTP(S) Based Deploy HTTP(S) Based Deploy
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Refer to `HTTP(S) Based Deploy Support`_ for more information. Please refer to `HTTP(S) Based Deploy Support`_ for more information.
iLO drivers with standalone ironic iLO drivers with standalone ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Support for iLO drivers with Standalone Ironic`_ for more information. Please refer to `Support for iLO drivers with Standalone Ironic`_ for
more information.
RAID Configuration RAID Configuration
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Refer to `RAID Support`_ for more information. Please refer to `RAID Support`_ for more information.
agent_ilo driver agent_ilo driver
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
@ -572,7 +584,7 @@ Requirements
Deploy Process Deploy Process
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Refer to `Netboot with glance and swift`_ and Please refer to `Netboot with glance and swift`_ and
`Localboot with glance and swift for partition images`_ for the deploy process `Localboot with glance and swift for partition images`_ for the deploy process
of partition image and `Localboot with glance and swift`_ for the deploy of partition image and `Localboot with glance and swift`_ for the deploy
process of whole disk image. process of whole disk image.
@ -580,7 +592,7 @@ process of whole disk image.
Configuring and Enabling the driver Configuring and Enabling the driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Glance Configuration`_ and `Enable driver`_. Please refer to `Glance Configuration`_ and `Enable driver`_.
Registering ProLiant node in ironic Registering ProLiant node in ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -621,35 +633,37 @@ node::
Boot modes Boot modes
~~~~~~~~~~ ~~~~~~~~~~
Refer to `Boot mode support`_ section for more information. Please refer to `Boot mode support`_ for more information.
UEFI Secure Boot UEFI Secure Boot
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
Refer to `UEFI Secure Boot Support`_ section for more information. Please refer to `UEFI Secure Boot Support`_ for more information.
Node Cleaning Node Cleaning
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Refer to `Node Cleaning Support`_ for more information. Please refer to `Node Cleaning Support`_ for more information.
Hardware Inspection Hardware Inspection
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
Refer to `Hardware Inspection Support`_ for more information. Please refer to `Hardware Inspection Support`_ for more information.
Swiftless deploy for intermediate deploy and boot images Swiftless deploy for intermediate deploy and boot images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Swiftless deploy for intermediate images`_ for more information. Please refer to `Swiftless deploy for intermediate images`_ for more
information.
HTTP(S) Based Deploy HTTP(S) Based Deploy
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Refer to `HTTP(S) Based Deploy Support`_ for more information. Please refer to `HTTP(S) Based Deploy Support`_ for more information.
iLO drivers with standalone ironic iLO drivers with standalone ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Support for iLO drivers with Standalone Ironic`_ for more information. Please refer to `Support for iLO drivers with Standalone Ironic`_ for
more information.
RAID Configuration RAID Configuration
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Refer to `RAID Support`_ for more information. Please refer to `RAID Support`_ for more information.
pxe_ilo driver pxe_ilo driver
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@ -759,43 +773,39 @@ node::
Boot modes Boot modes
~~~~~~~~~~ ~~~~~~~~~~
Refer to `Boot mode support`_ section for more information. Please refer to `Boot mode support`_ for more information.
UEFI Secure Boot UEFI Secure Boot
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
Refer to `UEFI Secure Boot Support`_ section for more information. Please refer to `UEFI Secure Boot Support`_ for more information.
Node Cleaning Node Cleaning
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Refer to `Node Cleaning Support`_ for more information. Please refer to `Node Cleaning Support`_ for more information.
Hardware Inspection Hardware Inspection
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
Refer to `Hardware Inspection Support`_ for more information. Please refer to `Hardware Inspection Support`_ for more information.
HTTP(S) Based Deploy HTTP(S) Based Deploy
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Refer to `HTTP(S) Based Deploy Support`_ for more information. Please refer to `HTTP(S) Based Deploy Support`_ for more information.
iLO drivers with standalone ironic iLO drivers with standalone ironic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Support for iLO drivers with Standalone Ironic`_ for more information. Please refer to `Support for iLO drivers with Standalone Ironic`_ for more information.
RAID Configuration RAID Configuration
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Refer to `RAID Support`_ for more information. Please refer to `RAID Support`_ for more information.
Functionalities across drivers Functionalities across drivers
============================== ==============================
Boot mode support Boot mode support
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
The following drivers support automatic detection and setting of boot The hardware type ``ilo`` and iLO-based classic drivers support automatic
mode (Legacy BIOS or UEFI). detection and setting of boot mode (Legacy BIOS or UEFI).
* ``pxe_ilo``
* ``iscsi_ilo``
* ``agent_ilo``
* When boot mode capability is not configured: * When boot mode capability is not configured:
@ -857,11 +867,8 @@ element to the diskimage-builder command to build the image. For example::
UEFI Secure Boot Support UEFI Secure Boot Support
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
The following drivers support UEFI secure boot deploy: The hardware type ``ilo`` and iLO-based classic drivers support secure boot
deploy.
* ``pxe_ilo``
* ``iscsi_ilo``
* ``agent_ilo``
The UEFI secure boot can be configured in ironic by adding The UEFI secure boot can be configured in ironic by adding
``secure_boot`` parameter in the ``capabilities`` parameter within ``secure_boot`` parameter in the ``capabilities`` parameter within
@ -901,7 +908,7 @@ flavor.
Use element ``ubuntu-signed`` or ``fedora`` to build signed deploy iso and Use element ``ubuntu-signed`` or ``fedora`` to build signed deploy iso and
user images from user images from
`diskimage-builder <https://pypi.python.org/pypi/diskimage-builder>`_. `diskimage-builder <https://pypi.python.org/pypi/diskimage-builder>`_.
Refer :ref:`deploy-ramdisk` for more information on building Please refer to :ref:`deploy-ramdisk` for more information on building
deploy ramdisk. deploy ramdisk.
The below command creates files named cloud-image-boot.iso, cloud-image.initrd, The below command creates files named cloud-image-boot.iso, cloud-image.initrd,
@ -938,11 +945,7 @@ For more up-to-date information, refer
Node Cleaning Support Node Cleaning Support
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
The following iLO drivers support node cleaning - The hardware type ``ilo`` and iLO-based classic drivers support node cleaning.
* ``pxe_ilo``
* ``iscsi_ilo``
* ``agent_ilo``
For more information on node cleaning, see :ref:`cleaning` For more information on node cleaning, see :ref:`cleaning`
@ -1022,8 +1025,8 @@ Supported **Manual** Cleaning Operations
with the ``management`` interface. See with the ``management`` interface. See
`Initiating firmware update as manual clean step`_ for user guidance on `Initiating firmware update as manual clean step`_ for user guidance on
usage. The supported devices for firmware update are: ``ilo``, ``cpld``, usage. The supported devices for firmware update are: ``ilo``, ``cpld``,
``power_pic``, ``bios`` and ``chassis``. Refer to below table for their ``power_pic``, ``bios`` and ``chassis``. Please refer to below table for
commonly used descriptions. their commonly used descriptions.
.. csv-table:: .. csv-table::
:header: "Device", "Description" :header: "Device", "Description"
@ -1048,13 +1051,8 @@ For more information on node manual cleaning, see :ref:`manual_cleaning`
Hardware Inspection Support Hardware Inspection Support
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
The hardware type ``ilo`` and iLO-based classic drivers support hardware
The following iLO drivers support hardware inspection: inspection.
* ``pxe_ilo``
* ``iscsi_ilo``
* ``agent_ilo``
* ``ilo`` hardware type
.. note:: .. note::
@ -1068,7 +1066,7 @@ The following iLO drivers support hardware inspection:
an error. This feature is available in proliantutils release an error. This feature is available in proliantutils release
version >= 2.2.0. version >= 2.2.0.
* The iLO must be updated with SNMPv3 authentication details. * The iLO must be updated with SNMPv3 authentication details.
Refer to the section `SNMPv3 Authentication` in `HPE iLO4 User Guide`_ Pleae refer to the section `SNMPv3 Authentication` in `HPE iLO4 User Guide`_
for setting up authentication details on iLO. for setting up authentication details on iLO.
The following parameters are mandatory to be given in driver_info The following parameters are mandatory to be given in driver_info
for SNMPv3 inspection: for SNMPv3 inspection:
@ -1170,14 +1168,15 @@ See :ref:`capabilities-discovery` for more details and examples.
Swiftless deploy for intermediate images Swiftless deploy for intermediate images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ``iscsi_ilo`` and ``agent_ilo`` drivers can deploy and boot the server The hardware type ``ilo`` with ``ilo-virtual-media`` as boot interface and
with and without ``swift`` being used for hosting the intermediate virtual media based classical drivers (``iscsi_ilo`` and ``agent_ilo``)
temporary floppy image (holding metadata for deploy kernel and ramdisk) can deploy and boot the server with and without ``swift`` being used for
and the boot ISO (which is required for ``iscsi_ilo`` only). A local HTTP(S) hosting the intermediate temporary floppy image (holding metadata for
web server on each conductor node needs to be configured. Refer deploy kernel and ramdisk) and the boot ISO. A local HTTP(S) web server on
`Web server configuration on conductor`_ for more information. The HTTPS each conductor node needs to be configured.
web server needs to be enabled (instead of HTTP web server) in order to Please refer to `Web server configuration on conductor`_ for more information.
send management information and images in encrypted channel over HTTPS. The HTTPS web server needs to be enabled (instead of HTTP web server) in order
to send management information and images in encrypted channel over HTTPS.
.. note:: .. note::
This feature assumes that the user inputs are on Glance which uses swift This feature assumes that the user inputs are on Glance which uses swift
@ -1187,8 +1186,8 @@ send management information and images in encrypted channel over HTTPS.
Deploy Process Deploy Process
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Refer to `Netboot in swiftless deploy for intermediate images`_ for partition Please refer to `Netboot in swiftless deploy for intermediate images`_ for
image support and refer to `Localboot in swiftless deploy for intermediate images`_ partition image support and `Localboot in swiftless deploy for intermediate images`_
for whole disk image support. for whole disk image support.
HTTP(S) Based Deploy Support HTTP(S) Based Deploy Support
@ -1207,21 +1206,17 @@ must be reachable by the conductor and the bare metal nodes.
Deploy Process Deploy Process
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Refer to `Netboot with HTTP(S) based deploy`_ for partition image boot and refer to Please refer to `Netboot with HTTP(S) based deploy`_ for partition image boot
`Localboot with HTTP(S) based deploy`_ for whole disk image boot. and `Localboot with HTTP(S) based deploy`_ for whole disk image boot.
Support for iLO drivers with Standalone Ironic Support for iLO drivers with Standalone Ironic
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is possible to use ironic as standalone services without other It is possible to use ironic as standalone services without other
OpenStack services. iLO drivers can be used in standalone ironic. OpenStack services. The ``ilo`` hardware type and the iLO-based classic
This feature is referred to as ``iLO drivers with standalone ironic`` in this document and is drivers can be used in standalone ironic. This feature is referred to as
supported by following drivers: ``iLO drivers with standalone ironic`` in this document.
* ``pxe_ilo``
* ``iscsi_ilo``
* ``agent_ilo``
Configuration Configuration
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -1232,7 +1227,7 @@ intermediate images on conductor as described in
Deploy Process Deploy Process
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
``iscsi_ilo`` and ``agent_ilo`` supports both netboot and localboot. Refer ``iscsi_ilo`` and ``agent_ilo`` supports both netboot and localboot. Please refer
to `Netboot in standalone ironic`_ and `Localboot in standalone ironic`_ to `Netboot in standalone ironic`_ and `Localboot in standalone ironic`_
for details of deploy process for netboot and localboot respectively. for details of deploy process for netboot and localboot respectively.
For ``pxe_ilo``, the deploy process is same as native ``pxe_ipmitool`` driver. For ``pxe_ilo``, the deploy process is same as native ``pxe_ipmitool`` driver.