From 2672bbfa879800b1aedcab85e1d5e6e1d2e7279a Mon Sep 17 00:00:00 2001
From: Dmitry Tantsur <divius.inside@gmail.com>
Date: Thu, 2 Nov 2017 13:05:59 +0100
Subject: [PATCH] Update idrac hardware type documentation

This change introduces a minimum page for the iDRAC drivers with
dependency installation, configuration and enrolling.

I'll leave it up to the driver team to provide further updates.

Change-Id: If0805cb0f73ac3888711c1908dc8faaa34f7e0ec
---
 doc/source/admin/drivers.rst       | 13 +++---
 doc/source/admin/drivers/idrac.rst | 63 ++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+), 8 deletions(-)
 create mode 100644 doc/source/admin/drivers/idrac.rst

diff --git a/doc/source/admin/drivers.rst b/doc/source/admin/drivers.rst
index f6041bf3b1..a7ef80d633 100644
--- a/doc/source/admin/drivers.rst
+++ b/doc/source/admin/drivers.rst
@@ -29,16 +29,13 @@ IPMITool driver
 
   drivers/ipmitool
 
-DRAC driver
------------
+iDRAC driver
+------------
 
-DRAC with PXE deploy
-^^^^^^^^^^^^^^^^^^^^
-
-- Add ``pxe_drac`` to the list of ``enabled_drivers`` in
-  ``/etc/ironic/ironic.conf``
-- Install python-dracclient package
+.. toctree::
+  :maxdepth: 1
 
+  drivers/idrac
 
 SNMP driver
 -----------
diff --git a/doc/source/admin/drivers/idrac.rst b/doc/source/admin/drivers/idrac.rst
new file mode 100644
index 0000000000..820834f904
--- /dev/null
+++ b/doc/source/admin/drivers/idrac.rst
@@ -0,0 +1,63 @@
+=============
+iDRAC drivers
+=============
+
+Overview
+========
+
+iDRAC_ hardware is supported by the ``idrac`` hardware type and the following
+classic drivers:
+
+* ``pxe_drac`` (using out-of-band inspection)
+* ``pxe_drac_inspector`` (using in-band inspection via **ironic-inspector**)
+
+It is also supported by the standard ``ipmi`` hardware type, though with
+a smaller feature set.
+
+.. TODO(dtantsur): supported hardware
+
+Enabling
+========
+
+All iDRAC drivers require the ``python-dracclient`` library to be installed,
+for example::
+
+    sudo pip install 'python-dracclient>=1.3.0'
+
+To enable the ``idrac`` hardware type, add the following to your
+``/etc/ironic/ironic.conf``:
+
+.. code-block:: ini
+
+    [DEFAULT]
+    enabled_hardware_types=idrac
+    enabled_management_interfaces=idrac
+    enabled_power_interfaces=idrac
+
+To enable all optional features (inspection, RAID and vendor passthru), use
+the following configuration:
+
+.. code-block:: ini
+
+    [DEFAULT]
+    enabled_hardware_types=idrac
+    enabled_inspect_interfaces=idrac
+    enabled_management_interfaces=idrac
+    enabled_power_interfaces=idrac
+    enabled_raid_interfaces=idrac
+    enabled_vendor_interfaces=idrac
+
+Enrolling
+=========
+
+The following command will enroll a bare metal node with the ``idrac``
+hardware type::
+
+    openstack baremetal node create --driver idrac \
+        --driver-info drac_address=http://drac.host \
+        --driver-info drac_username=user \
+        --driver-info drac_password=pa$$w0rd
+
+.. TODO(dtantsur): describe RAID support and inspection
+
+.. _iDRAC: http://www.dell.com/learn/us/en/15/solutions/integrated-dell-remote-access-controller-idrac