diff options
author | Zuul <zuul@review.openstack.org> | 2018-06-28 17:53:33 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2018-06-28 17:53:33 +0000 |
commit | 9aa09200b7d8df89338992e17b2c3f367e09975b (patch) | |
tree | 50a466e565798f3a8789e2de1a40d48550d8b63b /doc | |
parent | fb1876b8b1b7ca53676727cee1b7035f6c4363dd (diff) | |
parent | 1a07137118a95d72b3eb3b66121ee337fb989429 (diff) | |
download | ironic-9aa09200b7d8df89338992e17b2c3f367e09975b.tar.gz |
Merge "Remove the ipmitool classic drivers"
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/admin/drivers/ipmitool.rst | 35 | ||||
-rw-r--r-- | doc/source/admin/inspection.rst | 8 | ||||
-rw-r--r-- | doc/source/admin/report.txt | 4 | ||||
-rw-r--r-- | doc/source/install/enabling-drivers.rst | 31 | ||||
-rw-r--r-- | doc/source/install/enrollment.rst | 1 |
5 files changed, 12 insertions, 67 deletions
diff --git a/doc/source/admin/drivers/ipmitool.rst b/doc/source/admin/drivers/ipmitool.rst index 60fee146b..160f742f9 100644 --- a/doc/source/admin/drivers/ipmitool.rst +++ b/doc/source/admin/drivers/ipmitool.rst @@ -1,29 +1,15 @@ -=============== -IPMITool driver -=============== +=========== +IPMI driver +=========== Overview ======== -The IPMI_ (Intelligent Platform Management Interface) drivers manage nodes -by using IPMI protocol versions 2.0 or 1.5. They use the IPMItool_ utility -which is an open-source command-line interface (CLI) for controlling +The ``ipmi`` hardware type manage nodes by using IPMI_ (Intelligent Platform +Management Interface) protocol versions 2.0 or 1.5. It uses the IPMItool_ +utility which is an open-source command-line interface (CLI) for controlling IPMI-enabled devices. -The following hardware types and classic drivers use IPMItool for power and -management: - -* hardware types: - - * ``ipmi`` - -* classic drivers: - - * ``agent_ipmitool`` - * ``pxe_ipmitool`` - * ``agent_ipmitool_socat`` - * ``pxe_ipmitool_socat`` - Glossary ======== @@ -32,7 +18,7 @@ Glossary * BMC_ - Baseboard Management Controller. * RMCP - Remote Management Control Protocol. -Enabling the IPMItool driver(s) +Enabling the IPMI hardware type =============================== Please see :doc:`/install/configure-ipmi` for the required dependencies. @@ -49,12 +35,11 @@ Please see :doc:`/install/configure-ipmi` for the required dependencies. Please see :doc:`/install/enabling-drivers` for more details. -Registering a node with the IPMItool driver -=========================================== +Registering a node with the IPMI driver +======================================= Nodes configured to use the IPMItool drivers should have the ``driver`` field -set to ``ipmi`` (hardware type) or to the name of one of the classic drivers -that support IPMItool. +set to ``ipmi``. The following configuration value is required and has to be added to the node's ``driver_info`` field: diff --git a/doc/source/admin/inspection.rst b/doc/source/admin/inspection.rst index 51bf7fc19..3c03406ab 100644 --- a/doc/source/admin/inspection.rst +++ b/doc/source/admin/inspection.rst @@ -86,14 +86,6 @@ enabled to use it: [DEFAULT] enabled_inspect_interfaces = inspector,no-inspect -If using classic drivers supporting in-band inspection, like ``pxe_ipmitool``, -another option has to be set as well: - -.. code-block:: ini - - [inspector] - enabled = True - You must additionally install python-ironic-inspector-client_ to use this functionality. diff --git a/doc/source/admin/report.txt b/doc/source/admin/report.txt index c63ad6373..583c5aef6 100644 --- a/doc/source/admin/report.txt +++ b/doc/source/admin/report.txt @@ -262,10 +262,6 @@ default: enabled_deploy_interfaces = direct iscsi - enabled_drivers = - agent_ipmitool - fake - pxe_ipmitool enabled_hardware_types = ipmi redfish diff --git a/doc/source/install/enabling-drivers.rst b/doc/source/install/enabling-drivers.rst index 9363ade15..5703469f0 100644 --- a/doc/source/install/enabling-drivers.rst +++ b/doc/source/install/enabling-drivers.rst @@ -6,9 +6,8 @@ Introduction The Bare Metal service delegates actual hardware management to **drivers**. Starting with the Ocata release, two types of drivers are supported: -*classic drivers* (for example, ``pxe_ipmitool``, etc.) and -the newer *hardware types* (for example, generic ``redfish`` and ``ipmi`` -or vendor-specific ``ilo`` and ``irmc``). +*classic drivers* and the newer *hardware types* (for example, generic +``redfish`` and ``ipmi`` or vendor-specific ``ilo`` and ``irmc``). Drivers, in turn, consist of *hardware interfaces*: sets of functionality dealing with some aspect of bare metal provisioning in a vendor-specific way. @@ -301,32 +300,6 @@ existing nodes. support the provided default implementation, its users will have to always provide an explicit value for this interface when creating a node. -Enabling classic drivers ------------------------- - -Classic drivers are enabled in the configuration file of the -**ironic-conductor** service by setting the ``enabled_drivers`` configuration -option, for example: - -.. code-block:: ini - - [DEFAULT] - enabled_drivers = pxe_ipmitool - -The names in this comma-separated list are entry point names of the drivers. -They have to be available at conductor start-up, and all dependencies must -be installed locally. For example, - -* drivers starting with ``pxe`` and some drivers starting with ``agent`` - require :doc:`configure-pxe`, - -* drivers starting with ``pxe`` or having ``iscsi`` in their name require - :doc:`configure-iscsi`, - -* drivers ending with ``ipmitool`` require :doc:`configure-ipmi`. - -See :doc:`/admin/drivers` for the required configuration of each driver. - .. _driver composition reform specification: https://specs.openstack.org/openstack/ironic-specs/specs/approved/driver-composition-reform.html .. _setup.cfg: https://git.openstack.org/cgit/openstack/ironic/tree/setup.cfg .. _ironic-inspector: https://docs.openstack.org/ironic-inspector/latest/ diff --git a/doc/source/install/enrollment.rst b/doc/source/install/enrollment.rst index cb7a1e63e..eaad71402 100644 --- a/doc/source/install/enrollment.rst +++ b/doc/source/install/enrollment.rst @@ -42,7 +42,6 @@ to list all drivers enabled on all hosts: | Supported driver(s) | Active host(s) | +---------------------+-----------------------+ | ipmi | localhost.localdomain | - | pxe_ipmitool | localhost.localdomain | +---------------------+-----------------------+ Starting with API version 1.31 (and ``python-ironicclient`` 1.13), you can |