Add iBoot driver documentation

The iBoot driver have been in tree for a long time but it never had any
documentation. This patch is adding one.

Change-Id: I5326911d2fec6bab042a3afe28a748793aa4d1f6
This commit is contained in:
Lucas Alvares Gomes 2015-06-19 14:31:11 +01:00
parent 2d9584b46c
commit 0b778bba24
2 changed files with 85 additions and 0 deletions

View File

@ -179,3 +179,12 @@ Wake-On-Lan driver
:maxdepth: 1
../drivers/wol
iBoot driver
------------
.. toctree::
:maxdepth: 1
../drivers/iboot

View File

@ -0,0 +1,76 @@
.. _IBOOT:
============
iBoot driver
============
Overview
========
The iBoot power driver enables you to take advantage of power cycle
management of nodes using Dataprobe iBoot devices over the DxP protocol.
Drivers
=======
pxe_iboot
^^^^^^^^^
Overview
~~~~~~~~
The ``pxe_iboot`` driver uses iBoot to control the power state of the
node, PXE/iPXE technology for booting and the iSCSI methodology for
deploying the node.
Requirements
~~~~~~~~~~~~
* ``python-iboot`` library should be installed - https://github.com/darkip/python-iboot
Tested platforms
~~~~~~~~~~~~~~~~
* iBoot-G2
Configuring and enabling the driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Add ``pxe_iboot`` to the list of ``enabled_drivers`` in
*/etc/ironic/ironic.conf*. For example::
[DEFAULT]
...
enabled_drivers = pxe_ipmitool,pxe_iboot
2. Restart the Ironic conductor service::
service ironic-conductor restart
Registering a node with the iBoot driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Nodes configured for the iBoot driver should have the ``driver`` property
set to ``pxe_iboot``.
The following configuration values are also required in ``driver_info``:
- ``iboot_address``: The IP address of the iBoot PDU.
- ``iboot_username``: User name used for authentication.
- ``iboot_password``: Password used for authentication.
In addition, there are optional properties in ``driver_info``:
- ``iboot_port``: iBoot PDU port. Defaults to 9100.
- ``iboot_relay_id``: iBoot PDU relay ID. This option is useful in order
to support multiple nodes attached to a single PDU. Defaults to 1.
The following sequence of commands can be used to enroll a node with
the iBoot driver.
1. Create node::
ironic node-create -d pxe_iboot -i iboot_username=<username> -i iboot_password=<password> -i iboot_address=<address>
References
==========
.. [1] iBoot-G2 official documentation - http://dataprobe.com/support_iboot-g2.html