From 3a3349b49dd9450e1d0907f59bfc74ff964f0bf2 Mon Sep 17 00:00:00 2001 From: Anusha Ramineni Date: Tue, 31 Mar 2015 15:41:16 +0530 Subject: iLO driver documentation for node cleaning Change-Id: I8b433219b3826fa81397fe01699aa9c1ad09d321 --- doc/source/deploy/cleaning.rst | 9 ++++++ doc/source/drivers/ilo.rst | 69 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 78 insertions(+) diff --git a/doc/source/deploy/cleaning.rst b/doc/source/deploy/cleaning.rst index 8897bf46b..0f1a42eda 100644 --- a/doc/source/deploy/cleaning.rst +++ b/doc/source/deploy/cleaning.rst @@ -34,6 +34,7 @@ This will enable the default set of steps, based on your hardware and Ironic drivers. If you're using an agent_* driver, this includes, by default, erasing all of the previous tenant's data. +.. _InbandvsOutOfBandCleaning: In-Band vs Out-of-Band ====================== @@ -58,6 +59,8 @@ Out-of-band are actions performed by your management controller, such as IPMI, iLO, or DRAC. Out-of-band steps will be performed by Ironic using a Power or Management driver. Which steps are performed depends on the driver and hardware. +For Out-of-Band cleaning operations supported by iLO drivers, refer to +:ref:`ilo_node_cleaning`. FAQ === @@ -85,6 +88,12 @@ to disable erase_devices, you'd use the following config:: [agent] agent_erase_devices_priority=0 +To enable/disable the in-band disk erase using ``agent_ilo`` driver, use the +following config:: + + [ilo] + clean_priority_erase_devices=0 + What cleaning step is running? ------------------------------ diff --git a/doc/source/drivers/ilo.rst b/doc/source/drivers/ilo.rst index 6df4ac22f..3ea0c1929 100644 --- a/doc/source/drivers/ilo.rst +++ b/doc/source/drivers/ilo.rst @@ -102,6 +102,7 @@ Features (like PXE driver), so this driver has the benefit of security enhancement with the same performance. Hence it segregates management info from data channel. +* Support for Out-Of-Band cleaning operations. * Remote Console * HW Sensors * Works well for machines with resource constraints (lesser amount of memory). @@ -255,6 +256,10 @@ UEFI Secure Boot ~~~~~~~~~~~~~~~~ Refer to `UEFI Secure Boot support`_ section for more information. +Node cleaning +~~~~~~~~~~~~~ +Refer to ilo_node_cleaning_ for more information. + agent_ilo driver ^^^^^^^^^^^^^^^^ @@ -286,6 +291,7 @@ more up-to-date information, check the iLO driver wiki [6]_. Features ~~~~~~~~ * PXE-less deploy with Virtual Media using Ironic Python Agent. +* Support for out-of-band cleaning operations. * Remote Console * HW Sensors * IPA runs on the baremetal node and pulls the image directly from Swift. @@ -293,6 +299,8 @@ Features * Segregates management info from data channel. * UEFI Boot Support * UEFI Secure Boot Support +* Support to use default in-band cleaning operations supported by + Ironic Python Agent. For more details, see :ref:`InbandvsOutOfBandCleaning`. Requirements ~~~~~~~~~~~~ @@ -438,6 +446,10 @@ UEFI Secure Boot ~~~~~~~~~~~~~~~~ Refer to `UEFI Secure Boot support`_ section for more information. +Node Cleaning +~~~~~~~~~~~~~ +Refer to ilo_node_cleaning_ for more information. + pxe_ilo driver ^^^^^^^^^^^^^^ @@ -473,6 +485,7 @@ Features * Automatic detection of current boot mode. * Automatic setting of the required boot mode if UEFI boot mode is requested by the nova flavor's extra spec. +* Support for Out-Of-Band cleaning operations. Requirements ~~~~~~~~~~~~ @@ -529,6 +542,10 @@ Boot modes ~~~~~~~~~~ Refer to `Boot mode support`_ section for more information. +Node Cleaning +~~~~~~~~~~~~~ +Refer to ilo_node_cleaning_ for more information. + Functionalities across drivers ============================== @@ -633,6 +650,57 @@ HP UEFI System Utilities User Guide. [7]_ One can also refer to white paper on Secure Boot for Linux on HP Proliant servers for additional details. [8]_ +.. _ilo_node_cleaning: + +Node Cleaning +^^^^^^^^^^^^^ +The following iLO drivers support node cleaning - + +* ``pxe_ilo`` +* ``iscsi_ilo`` +* ``agent_ilo`` + +Supported Cleaning Operations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* The cleaning operations supported are: + + -``reset_ilo``: + Resets the iLO. By default, enabled with priority 1. + -``reset_bios_to_default``: + Resets BIOS Settings to default. By default, enabled with priority 10. + This clean step is supported only on Gen9 and above servers. + -``reset_secure_boot_keys_to_default``: + Resets secure boot keys to manufacturer's defaults. This step is supported + only on Gen9 and above servers. By default, enabled with priority 20 . + -``reset_ilo_credential``: + Resets the iLO password, if 'ilo_change_password' is specified as part of + node's driver_info. By default, enabled with priority 30. + -``clear_secure_boot_keys``: + Clears all secure boot keys. This step is supported only on Gen9 and above + servers. By default, this step is disabled. + +* For in-band cleaning operations supported by ``agent_ilo`` driver, see + :ref:`InbandvsOutOfBandCleaning`. + +* All the cleaning steps have an explicit configuration option for priority. + In order to disable or change the priority of the clean steps, respective + configuration option for priority should be updated in ironic.conf. + +* Updating clean step priority to 0, will disable that particular clean step + and will not run during cleaning. + +* Configuration Options for the clean steps are listed under [ilo] section in + ironic.conf :: + + - clean_priority_reset_ilo=1 + - clean_priority_reset_bios_to_default=10 + - clean_priority_reset_secure_boot_keys_to_default=20 + - clean_priority_clear_secure_boot_keys=0 + - clean_priority_reset_ilo_credential=30 + - clean_priority_erase_devices=10 + +For more information on node cleaning, see [9]_. References ========== @@ -644,4 +712,5 @@ References .. [6] https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers .. [7] HP UEFI System Utilities User Guide - http://www.hp.com/ctg/Manual/c04398276.pdf .. [8] Secure Boot for Linux on HP Proliant servers http://h20195.www2.hp.com/V2/getpdf.aspx/4AA5-4496ENW.pdf +.. [9] http://docs.openstack.org/developer/ironic/deploy/cleaning.html -- cgit v1.2.1