Jump to: navigation, search

Difference between revisions of "Ironic/Drivers"

(Drivers)
m
(46 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
== Drivers ==
 
== Drivers ==
  
Ironic supports pluggable back-end drivers for different types of hardware to enable features specific to unique hardware platforms and leverage divergent capabilities via a common API . This API is divided into three sections: core, common, and vendor. While authors of vendor drivers may break new ground in the designated "vendor_passthru" section of the API, they are strongly encouraged to converge on a common API across vendors. More details may be found under the [http://docs.openstack.org/developer/ironic/dev/architecture.html#drivers system architecture] description.
+
Ironic supports pluggable back-end drivers for different types of hardware to enable features specific to unique hardware platforms and leverage divergent capabilities via a common API. Drivers are composed from ''hardware types'' and "hardware interfaces".
 +
* [https://docs.openstack.org/ironic/latest/install/enabling-drivers.html Installation: enabling hardware types and interfaces]
 +
* [https://docs.openstack.org/ironic/latest/admin/drivers.html Available hardware types and interfaces]
 +
* [https://docs.openstack.org/ironic/latest/contributor/drivers.html#writing-a-hardware-type Writing a new hardware type]
  
Hardware drivers must undergo CI testing so as to ensure their continued functionality. Some drivers will be tested upstream, while many will require third-party CI testing due to the unique nature of their hardware (and the unmanageable complexity were a single team required to maintain a test infrastructure encompassing hardware from many diverse vendors). Guidelines on that testing can be found on the [[Ironic/Testing]] wiki page.
 
  
Out-of-tree drivers are supported by Ironic and may be loaded via python entrypoints.
+
Every supported driver is covered either by the standard CI or by a [https://wiki.openstack.org/wiki/ThirdPartySystems Third Party CI]. The [https://github.com/openstack/ironic-staging-drivers ironic-staging-drivers project] hosts a few drivers that are '''unsupported by the community'''.
 
 
The table below describes the CI test coverage of the current set of drivers. Note that drivers are composed of more than one interface (eg, power and deploy). Not all combinations of interfaces are necessarily tested together, but we are striving to get test coverage for each interface in at least one driver.
 
 
 
 
 
{| class="wikitable"
 
|-
 
! Interface Type !! Interface Name !! Test coverage provided by driver name
 
|-
 
| deploy || agent || agent_ssh; agent_ipmitool is used in production for Rackspace OnMetal
 
|-
 
| deploy || pxe || pxe_ssh
 
|-
 
| power || drac || None
 
|-
 
| power || ilo || None
 
|-
 
| power || ipminative || pxe_ipminative (provided by ibm-xcat-ci)
 
|-
 
| power || ipmitool || ** most widely used power driver in production, but lacks upstream CI
 
|-
 
| power || seamicro || None
 
|-
 
| power || snmp || None
 
|-
 
| power || ssh || pxe_ssh
 
|-
 
| power || amt|| None
 
|-
 
| power || irmc|| None
 
|}
 
 
 
 
 
Links to graphs of the CI system's current status should be included in the table below, when available.
 
 
 
{| class="wikitable"
 
|-
 
! Driver Name !! Primary Contact Email and IRC handle !! Testing Status
 
|-
 
| pxe_ssh || devananda (devananda dot vdv at gmail) || [http://no-carrier.net/~adam/openstack/ironic_gate_status.html tested in the upstream gate]
 
|-
 
| pxe_ipminative || linggao (linggao at us dot ibm dot com) / Jarrod Johnson (jjohnson2 at lenovo dot com) || Third-party CI: "ibm-xcat-ci" <xcat@cn.ibm.com>
 
|-
 
| pxe_ipmitool || devananda (devananda dot vdv at gmail) || used by TripleO, but not CI tested
 
|-
 
| agent_ssh || jroll (jim at jimrollenhagen dot com) || [http://no-carrier.net/~adam/openstack/ironic_gate_status.html tested in the upstream gate]
 
|-
 
| agent_ipmitool || jroll (jim at jimrollenhagen dot com) || used by Rackspace OnMetal, not CI tested upstream
 
|-
 
|}
 
 
 
== 3rd Party Drivers ==
 
 
 
iLO drivers: https://wiki.openstack.org/wiki/Ironic/Drivers/iLODrivers
 

Revision as of 17:10, 26 March 2018

Drivers

Ironic supports pluggable back-end drivers for different types of hardware to enable features specific to unique hardware platforms and leverage divergent capabilities via a common API. Drivers are composed from hardware types and "hardware interfaces".


Every supported driver is covered either by the standard CI or by a Third Party CI. The ironic-staging-drivers project hosts a few drivers that are unsupported by the community.