diff --git a/doc/source/admin/drivers/ilo.rst b/doc/source/admin/drivers/ilo.rst index 5b856ce0fc..90e98b4c20 100644 --- a/doc/source/admin/drivers/ilo.rst +++ b/doc/source/admin/drivers/ilo.rst @@ -7,12 +7,12 @@ iLO drivers Overview ======== iLO drivers enable to take advantage of features of iLO management engine in -HPE ProLiant servers. iLO drivers are targeted for HPE ProLiant Gen8 and Gen9 -systems which have `iLO 4 management engine`_. From **Pike** release iLO -drivers start supporting ProLiant Gen10 systems which have -`iLO 5 management engine`_. iLO5 conforms to `Redfish`_ API and hence -hardware type ``redfish`` (see :doc:`redfish`) is also an option for this kind -of hardware but it will lack the iLO specific features. +HPE ProLiant servers. The ``ilo`` hardware type is targeted for HPE ProLiant +Gen8 and Gen9 systems which have `iLO 4 management engine`_. From **Pike** +release ``ilo`` hardware type supports ProLiant Gen10 systems which have +`iLO 5 management engine`_. iLO5 conforms to `Redfish`_ API and hence hardware +type ``redfish`` (see :doc:`redfish`) is also an option for this kind of +hardware but it lacks the iLO specific features. For more details and for up-to-date information (like tested platforms, known issues, etc), please check the `iLO driver wiki page `_. @@ -20,55 +20,48 @@ known issues, etc), please check the `iLO driver wiki page \ - --driver-info ilo_username= \ - --driver-info ilo_password= \ - --driver-info ilo_deploy_iso= + - ``deploy_kernel``: The glance UUID or a HTTP(S) URL of the deployment kernel. + - ``deploy_ramdisk``: The glance UUID or a HTTP(S) URL of the deployment ramdisk. -* ``pxe_ilo``: +* The following parameters are mandatory in ``driver_info`` + if ``ilo-inspect`` inspect inteface is used and SNMPv3 inspection + (`SNMPv3 Authentication` in `HPE iLO4 User Guide`_) is desired: - .. code-block:: console + * ``snmp_auth_user`` : The SNMPv3 user. - openstack baremetal node create --os-baremetal-api-version=1.31 \ - --driver ilo \ - --deploy-interface iscsi \ - --boot-interface ilo-pxe \ - --driver-info ilo_address= \ - --driver-info ilo_username= \ - --driver-info ilo_password= \ - --driver-info deploy_kernel= \ - --driver-info deploy_ramdisk= + * ``snmp_auth_prot_password`` : The auth protocol pass phrase. -* ``agent_ilo``: + * ``snmp_auth_priv_password`` : The privacy protocol pass phrase. - .. code-block:: console + The following parameters are optional for SNMPv3 inspection: - openstack baremetal node create --os-baremetal-api-version=1.31 \ - --driver ilo \ - --deploy-interface direct \ - --boot-interface ilo-virtual-media \ - --driver-info ilo_address= \ - --driver-info ilo_username= \ - --driver-info ilo_password= \ - --driver-info ilo_deploy_iso= + * ``snmp_auth_protocol`` : The Auth Protocol. The valid values + are "MD5" and "SHA". The iLO default value is "MD5". + + * ``snmp_auth_priv_protocol`` : The Privacy protocol. The valid + values are "AES" and "DES". The iLO default value is "DES". + +.. note:: + If configuration values for ``ca_file``, ``client_port`` and + ``client_timeout`` are not provided in the ``driver_info`` of the node, + the corresponding config variables defined under ``[ilo]`` section in + ironic.conf will be used. Prerequisites ============= @@ -246,8 +237,8 @@ Prerequisites of the ``ipmitool`` package. Please refer to `Hardware Inspection Support`_ for more information on recommended version. -Different Configuration for ilo drivers -======================================= +Different configuration for ilo hardware type +============================================= Glance Configuration ^^^^^^^^^^^^^^^^^^^^ @@ -339,11 +330,11 @@ Web server configuration on conductor # http://192.1.2.3:8080 (string value) http_url=http://192.168.0.2:8080 -``use_web_server_for_images``: If the variable is set to ``false``, ``iscsi_ilo`` -and ``agent_ilo`` uses swift containers to host the intermediate floppy -image and the boot ISO. If the variable is set to ``true``, these drivers -use the local web server for hosting the intermediate files. The default value -for ``use_web_server_for_images`` is False. +``use_web_server_for_images``: If the variable is set to ``false``, +the ``ilo-virtual-media`` boot interface uses swift containers to host the +intermediate floppy image and the boot ISO. If the variable is set to +``true``, it uses the local web server for hosting the intermediate files. +The default value for ``use_web_server_for_images`` is False. ``http_url``: The value for this variable is prefixed with the generated intermediate files to generate a URL which is attached in the virtual media. @@ -353,7 +344,7 @@ the intermediate floppy image and the boot ISO. .. note:: HTTPS is strongly recommended over HTTP web server configuration for security - enhancement. The ``iscsi_ilo`` and ``agent_ilo`` will send the instance's + enhancement. The ``ilo-virtual-media`` boot interface will send the instance's configdrive over an encrypted channel if web server is HTTPS enabled. Enable driver @@ -368,19 +359,93 @@ Enable driver glance image-create --name deploy-ramdisk.iso --disk-format iso --container-format bare < deploy-ramdisk.iso -4. Add the driver name to the list of ``enabled_drivers`` in - ``/etc/ironic/ironic.conf``. For example, for `iscsi_ilo` driver:: +4. Enable hardware type and hardware interfaces in + ``/etc/ironic/ironic.conf``:: - enabled_drivers = fake,pxe_ipmitool,iscsi_ilo - - Similarly it can be added for ``agent_ilo`` and ``pxe_ilo`` drivers. + [DEFAULT] + enabled_hardware_types = ilo + enabled_boot_interfaces = ilo-virtual-media,ilo-pxe + enabled_power_interfaces = ilo + enabled_console_interfaces = ilo + enabled_raid_interfaces = agent + enabled_management_interfaces = ilo + enabled_inspect_interfaces = ilo 5. Restart the ironic conductor service:: $ service ironic-conductor restart -Drivers -======= +Classic Drivers (Deprecated) +============================ + +These are the classic drivers (deprecated) for ProLiant hardware: + +* ``pxe_ilo`` +* ``iscsi_ilo`` +* ``agent_ilo`` + +.. warning:: + The classic drivers are deprecated in the Queens release and will be removed + in the Rocky release. The ``ilo`` hardware type should be used instead of + the classic drivers. + +To enable the same feature set as provided by all iLO classic drivers, +apply the following configuration: + +.. code-block:: ini + + [DEFAULT] + enabled_hardware_types = ilo + enabled_boot_interfaces = ilo-virtual-media,ilo-pxe + enabled_power_interfaces = ilo + enabled_console_interfaces = ilo + enabled_raid_interfaces = agent + enabled_management_interfaces = ilo + enabled_inspect_interfaces = ilo + +The following commands can be used to enroll a node with the same +feature set as one of the classic drivers, but using the ``ilo`` +hardware type: + +* ``iscsi_ilo``: + + .. code-block:: console + + openstack baremetal node create --os-baremetal-api-version=1.31 \ + --driver ilo \ + --deploy-interface iscsi \ + --boot-interface ilo-virtual-media \ + --driver-info ilo_address= \ + --driver-info ilo_username= \ + --driver-info ilo_password= \ + --driver-info ilo_deploy_iso= + +* ``pxe_ilo``: + + .. code-block:: console + + openstack baremetal node create --os-baremetal-api-version=1.31 \ + --driver ilo \ + --deploy-interface iscsi \ + --boot-interface ilo-pxe \ + --driver-info ilo_address= \ + --driver-info ilo_username= \ + --driver-info ilo_password= \ + --driver-info deploy_kernel= \ + --driver-info deploy_ramdisk= + +* ``agent_ilo``: + + .. code-block:: console + + openstack baremetal node create --os-baremetal-api-version=1.31 \ + --driver ilo \ + --deploy-interface direct \ + --boot-interface ilo-virtual-media \ + --driver-info ilo_address= \ + --driver-info ilo_username= \ + --driver-info ilo_password= \ + --driver-info ilo_deploy_iso= iscsi_ilo driver ^^^^^^^^^^^^^^^^ @@ -1964,6 +2029,18 @@ modes, the virtual media driver only supports uefi boot mode, and that attemptin use iscsi boot at the same time with a bios volume will result in an error. +Certificate based validation in iLO +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The driver supports validation of certificates on the HPE Proliant servers. +The path to certificate file needs to be appropriately set in ``ca_file`` in +the node's ``driver_info``. To update SSL certificates into iLO, +refer to `HPE Integrated Lights-Out Security Technology Brief `_. +Use iLO hostname or IP address as a 'Common Name (CN)' while +generating Certificate Signing Request (CSR). Use the same value as +`ilo_address` while enrolling node to Bare Metal service to avoid SSL +certificate validation errors related to hostname mismatch. + + .. _`ssacli documentation`: http://h20566.www2.hpe.com/hpsc/doc/public/display?docId=c03909334 .. _`proliant-tools`: https://docs.openstack.org/diskimage-builder/latest/elements/proliant-tools/README.html .. _`HPE iLO4 User Guide`: http://h20566.www2.hpe.com/hpsc/doc/public/display?docId=c03334051