ironic-inspector/README.rst
Flavio Percoco 715f4e29b2 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/97af6096980fd1e7aee0412831aa7441\n'

Change-Id: I9a5c5b26a770d714e1a48adea5dc38b28cfff505
2016-12-01 12:12:42 +02:00

34 lines
1.4 KiB
ReStructuredText

===============================================
Hardware introspection for OpenStack Bare Metal
===============================================
Team and repository tags
------------------------
.. image:: http://governance.openstack.org/badges/ironic-inspector.svg
:target: http://governance.openstack.org/reference/tags/index.html
This is an auxiliary service for discovering hardware properties for a
node managed by `Ironic`_. Hardware introspection or hardware
properties discovery is a process of getting hardware parameters required for
scheduling from a bare metal node, given it's power management credentials
(e.g. IPMI address, user name and password).
* Free software: Apache license
* Source: http://git.openstack.org/cgit/openstack/ironic-inspector
* Bugs: http://bugs.launchpad.net/ironic-inspector
* Blueprints: https://blueprints.launchpad.net/ironic-inspector
* Downloads: https://pypi.python.org/pypi/ironic-inspector
* Documentation: http://docs.openstack.org/developer/ironic-inspector
* Python client library and CLI tool: `python-ironic-inspector-client
<https://pypi.python.org/pypi/python-ironic-inspector-client>`_.
.. _Ironic: https://wiki.openstack.org/wiki/Ironic
.. note::
**ironic-inspector** was called *ironic-discoverd* before version 2.0.0.
For information on any current or prior version, see `the release notes`_.
.. _the release notes: http://docs.openstack.org/releasenotes/ironic-inspector/