Create an ironic Datasource Driver

Include the URL of your launchpad blueprint:

This ironic driver will allow Congress to interact with the Openstack ironic API for orchestration. The first version will provide data from ironic’s read API calls until Congress does have infrastructure to handle writing to drivers. Subsequent versions may be able to send requests and write to the ironic API.

Problem description

Today, there is no Congress driver for ironic, either for reading or writing. This driver will give Congress eyes into ironic so that a policy writer can inspect Bare Metal state such as details about enabled drivers, each chassis, each node, each port, supported boot devices of a node.

Proposed change

This driver will be similar to other existing drivers like and The ironic driver will read data from the following ironic API calls and convert the responses to Congress tables:

  • list enabled drivers

  • show driver detail

  • list driver properties

  • list chassis

  • show chassis detail

  • list nodes contained in a chassis

  • list registered nodes

  • show node detail

  • list supported boot devices for a node

  • list ports assocaited with a node

  • list all registered ports

  • show port detail


The alternative is to have no driver for ironic, which is not a good option for those admins that use ironic in their cloud to manage bare metal servers.



Policy actions


Data sources

Openstack ironic

Data model impact


REST API impact


Security impact

The ironic driver will need to authenticate to the ironic API just like all the other datasource drivers.

Notifications impact


Other end user impact


Performance impact

It is possible that the API calls will be expensive. We will need to measure the impact of the API calls on ironic and Congress performance.

Other deployer impact


Developer impact




Primary assignee:


Work items

  • Write unit test

  • Write tempest test

  • Write API client code

  • Write translators for tables




This work must include a unit test and a tempest test. The driver translator infrastructure makes most of the translation code robust, but the driver is still dependent on the ironic API, so the tempest test is particularly important as an integration test.

Documentation impact