From 686c0f7f47edc3656aaffd490988b058cf3977ac Mon Sep 17 00:00:00 2001 From: Shivanand Tendulker Date: Wed, 6 Sep 2017 01:05:48 -0400 Subject: [PATCH] Update documentation for ``ilo`` hardware type Updated driver documentation for ``ilo`` hardware type for console, deploy, network, raid and storage interfaces. Closes-Bug: #1712465 Change-Id: I00158ab692d8f6ab91095280151f307fdd7dcd23 (cherry picked from commit 85b990f5951784a92e20374f239580273d6f5e4c) --- doc/source/admin/drivers/ilo.rst | 68 +++++++++++++++---- .../admin/upgrade-to-hardware-types.rst | 3 + 2 files changed, 58 insertions(+), 13 deletions(-) diff --git a/doc/source/admin/drivers/ilo.rst b/doc/source/admin/drivers/ilo.rst index 9d9b003c7b..2e076cfa62 100644 --- a/doc/source/admin/drivers/ilo.rst +++ b/doc/source/admin/drivers/ilo.rst @@ -63,8 +63,10 @@ Hardware Interfaces The ``ilo`` hardware type supports following hardware interfaces: * boot - ``ilo-virtual-media`` and ``ilo-pxe``. They can be enabled via the - ``enabled_boot_interfaces`` option: + Supports ``ilo-virtual-media`` and ``ilo-pxe``. The default is + ``ilo-virtual-media``. They can be enabled by using the + ``[DEFAULT]enabled_boot_interfaces`` option in ``ironic.conf`` + as given below: .. code-block:: ini @@ -72,13 +74,21 @@ The ``ilo`` hardware type supports following hardware interfaces: enabled_hardware_types = ilo enabled_boot_interfaces = ilo-virtual-media,ilo-pxe - .. note:: - ``ilo-virtual-media`` is the default ``boot`` interface for ``ilo`` - hardware type. +* console + Supports ``ilo`` and ``no-console``. The default is ``ilo``. + They can be enabled by using the ``[DEFAULT]enabled_console_interfaces`` + option in ``ironic.conf`` as given below: + + .. code-block:: ini + + [DEFAULT] + enabled_hardware_types = ilo + enabled_console_interfaces = ilo,no-console * inspect - ``ilo`` and ``inspector``. They can be enabled via the - ``enabled_inspect_interfaces`` option: + Supports ``ilo`` and ``inspector``. The default is ``ilo``. They + can be enabled by using the ``[DEFAULT]enabled_inspect_interfaces`` option + in ``ironic.conf`` as given below: .. code-block:: ini @@ -87,13 +97,13 @@ The ``ilo`` hardware type supports following hardware interfaces: enabled_inspect_interfaces = ilo,inspector .. note:: - ``ilo`` is the default ``inspect`` interface for ``ilo`` - hardware type. `Ironic Inspector `_ + `Ironic Inspector `_ needs to be configured to use ``inspector`` as the inspect interface. * management - ``ilo``. It can be enabled via the - ``enabled_management_interfaces`` option: + Supports only ``ilo``. It can be enabled by using the + ``[DEFAULT]enabled_management_interfaces`` option in ``ironic.conf`` as + given below: .. code-block:: ini @@ -102,8 +112,9 @@ The ``ilo`` hardware type supports following hardware interfaces: enabled_management_interfaces = ilo * power - ``ilo``. It can be enabled via the - ``enabled_power_interfaces`` option: + Supports only ``ilo``. It can be enabled by using the + ``[DEFAULT]enabled_power_interfaces`` option in ``ironic.conf`` as given + below: .. code-block:: ini @@ -111,6 +122,37 @@ The ``ilo`` hardware type supports following hardware interfaces: enabled_hardware_types = ilo enabled_power_interfaces = ilo +* raid + Supports ``agent`` and ``no-raid``. The default is ``no-raid``. + They can be enabled by using the ``[DEFAULT]enabled_raid_interfaces`` + option in ``ironic.conf`` as given below: + + .. code-block:: ini + + [DEFAULT] + enabled_hardware_types = ilo + enabled_raid_interfaces = agent,no-raid + +* storage + Supports ``cinder`` and ``noop``. The default is ``noop``. + They can be enabled by using the ``[DEFAULT]enabled_storage_interfaces`` + option in ``ironic.conf`` as given below: + + .. code-block:: ini + + [DEFAULT] + enabled_hardware_types = ilo + enabled_storage_interfaces = cinder,noop + + .. note:: + The storage interface ``cinder`` is supported only when corresponding + boot interface of the ``ilo`` hardware type based node is ``ilo-pxe``. + Please refer to :doc:`/admin/boot-from-volume` for configuring + ``cinder`` as a storage interface. + +``ilo`` hardware type supports all standard ``deploy`` and ``network`` +interface implementations, see :ref:`enable-hardware-interfaces` for details. + The following command can be used to enroll a ProLiant node with ``ilo`` hardware type: diff --git a/doc/source/admin/upgrade-to-hardware-types.rst b/doc/source/admin/upgrade-to-hardware-types.rst index 28e44f7c08..987bea3027 100644 --- a/doc/source/admin/upgrade-to-hardware-types.rst +++ b/doc/source/admin/upgrade-to-hardware-types.rst @@ -16,6 +16,9 @@ Use the following table: ================ ============= ==================== ====== ========== ========= Classic Driver Hardware Type Boot Deploy Management Power ================ ============= ==================== ====== ========== ========= +pxe_ilo ilo ilo-pxe iscsi ilo ilo +agent_ilo ilo ilo-virtual-media direct ilo ilo +iscsi_ilo ilo ilo-virtual-media iscsi ilo ilo pxe_ipmitool ipmi pxe iscsi ipmitool ipmitool agent_ipmitool ipmi pxe direct ipmitool ipmitool pxe_irmc irmc irmc-pxe iscsi irmc irmc