ironic/doc/source/deploy/drivers.rst
Andreas Jaeger 4cff2ab6d5 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

Fix problems found:
* Duplicate labels (rename wrong faq entries, rename unused drivers
  entries)
* Add api/autoindex.rst as hidden to the index so that we do not get a
  warning. The modindex includes the same content, so no need to show
  this.
* Add releasenotes/index.rst, webapi/v1.rst, user-guide, and install-guide.rst
  to hidden index since they're not listed in index on purpose, so sphinx
  will not warn that they do not appear in a toc
* Add deploy/radosgw to index
* ignore app.add_directiv warning
* Fix reference to user-guide to use proper markup so that Sphinx knows
  the user-guide is referenced.

Change-Id: I00d249229d4d31ba36d4393d60847fdb1513a744
2017-03-08 08:22:24 +01:00

109 lines
1.6 KiB
ReStructuredText

.. _enabling_drivers:
================
Enabling drivers
================
Ironic-Python-Agent (agent)
---------------------------
Ironic-Python-Agent is an agent that handles *ironic* bare metal
nodes in various actions such as inspection and deployment of such
nodes, and runs processes inside of a ramdisk.
For more information on this, see :ref:`IPA`.
IPMITool driver
---------------
.. toctree::
:maxdepth: 1
../drivers/ipmitool
DRAC driver
-----------
DRAC with PXE deploy
^^^^^^^^^^^^^^^^^^^^
- Add ``pxe_drac`` to the list of ``enabled_drivers`` in
``/etc/ironic/ironic.conf``
- Install python-dracclient package
SNMP driver
-----------
.. toctree::
:maxdepth: 1
../drivers/snmp
iLO driver
----------
.. toctree::
:maxdepth: 1
../drivers/ilo
iRMC driver
-----------
.. toctree::
:maxdepth: 1
../drivers/irmc
Cisco UCS driver
----------------
.. toctree::
:maxdepth: 1
../drivers/ucs
CIMC driver
-----------
.. toctree::
:maxdepth: 1
../drivers/cimc
OneView driver
--------------
.. toctree::
:maxdepth: 1
../drivers/oneview
XenServer ssh driver
--------------------
.. toctree::
:maxdepth: 1
../drivers/xenserver
Unsupported drivers
-------------------
The following drivers were declared as unsupported in ironic Newton release
and as of Ocata release they are removed form ironic:
- AMT driver - available as part of ironic-staging-drivers_
- iBoot driver - available as part of ironic-staging-drivers_
- Wake-On-Lan driver - available as part of ironic-staging-drivers_
- Virtualbox drivers
- SeaMicro drivers
- MSFT OCS drivers
.. _ironic-staging-drivers: http://ironic-staging-drivers.readthedocs.io