Merge "Update ilo drivers documentation for inspection"

doc/source/deploy/install-guide.rst

@@ -1103,17 +1103,23 @@ Hardware Inspection
 Starting with Kilo release Ironic supports hardware inspection that simplifies
 enrolling nodes. Inspection allows Ironic to discover required node properties
 once required ``driver_info`` fields (e.g. IPMI credentials) are set
-by an operator. There are two kinds of inspection supported by Ironic:
+by an operator. Inspection will also create the ironic ports for the
+discovered ethernet MACs. Operators will have to manually delete the ironic
+ports for which physical media is not connected. This is required due to the
+`bug 1405131 <https://bugs.launchpad.net/ironic/+bug/1405131>`_.
 
-#. Out-of-band inspection may be supported by some vendor drivers.
+There are two kinds of inspection supported by Ironic:
+
+#. Out-of-band inspection is currently implemented by iLO drivers, listed at
+   :ref:`ilo`.
 
 #. In-band inspection is performed by utilizing the ironic-discoverd_ project.
    This is supported by the following drivers::
 
-   pxe_drac
-   pxe_ipmitool
-   pxe_ipminative
-   pxe_ssh
+    pxe_drac
+    pxe_ipmitool
+    pxe_ipminative
+    pxe_ssh
 
   As of Kilo release this feature needs to be explicitly enabled in the
   configuration by setting ``enabled = True`` in ``[discoverd]`` section.
@@ -1130,13 +1136,24 @@ by an operator. There are two kinds of inspection supported by Ironic:
     add_ports = all
     keep_ports = present
 
-  (requires ironic-discoverd of version 1.1.0 or higher). Note that in this
-  case an operator is responsible for deleting ports that can't be actually
-  used by Ironic, see `bug 1405131
-  <https://bugs.launchpad.net/ironic/+bug/1405131>`_ for explanation.
+  Note: It will require ironic-discoverd of version 1.1.0 or higher.
+
+Inspection can be initiated using node-set-provision-state.
+The node should be in MANAGEABLE state before inspection is initiated.
+
+* Move node to manageable state::
+
+    ironic node-set-provision-state <node_UUID> manage
+
+* Initiate inspection::
+
+    ironic node-set-provision-state <node_UUID> inspect
+
+.. note::
+    The above commands require the python-ironicclient_ to be version 0.5.0 or greater.
 
 .. _ironic-discoverd: https://github.com/stackforge/ironic-discoverd
-
+.. _python-ironicclient: https://pypi.python.org/pypi/python-ironicclient
 
 Specifying the disk for deployment
 ==================================

doc/source/drivers/ilo.rst

@@ -702,6 +702,38 @@ Supported Cleaning Operations
 
 For more information on node cleaning, see [9]_.
 
+Hardware Inspection
+^^^^^^^^^^^^^^^^^^^
+
+NOTE: The RAID shall be pre-configured prior to inspection otherwise
+proliantutils returns 0 for disk size.
+
+The inspection process will discover the following essential properties
+(properties required for scheduling deployment):
+
+* ``memory_mb``: memory size
+
+* ``cpus``: number of cpus
+
+* ``cpu_arch``: cpu architecture
+
+* ``local_gb``: disk size
+
+Inspection can also discover the following extra capabilities for iLO drivers:
+
+* ``ilo_firmware_version``: iLO firmware version
+
+* ``rom_firmware_version``: ROM firmware version
+
+* ``secure_boot``: secure boot is supported or not. The possible values are
+  'true' or 'false'.
+
+* ``server_model``: server model
+
+* ``pci_gpu_devices``: number of gpu devices connected to the baremetal.
+
+* ``nic_capacity``: the max speed of the embedded NIC adapter.
+
 References
 ==========
 .. [1] HP iLO 4 User Guide - http://h20628.www2.hp.com/km-ext/kmcsdirect/emr_na-c03334051-11.pdf
@@ -713,4 +745,3 @@ References
 .. [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
-