ironic-python-agent/README.rst
Flavio Percoco f98c245c0d 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/3227bdf4c083e27e5f14134e8c111241\n'

Change-Id: Idb47f0b2fa2de111e2c1215e698a79eabbdc54d4
2016-11-25 13:34:58 +01:00

58 lines
1.8 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/ironic-python-agent.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
ironic-python-agent
===================
An agent for controlling and deploying Ironic controlled baremetal nodes.
The ironic-python-agent works with the agent driver in Ironic to provision
the node. Starting with ironic-python-agent running on a ramdisk on the
unprovisioned node, Ironic makes API calls to ironic-python-agent to provision
the machine. This allows for greater control and flexibility of the entire
deployment process.
The ironic-python-agent may also be used with the original Ironic pxe drivers
as of the Kilo OpenStack release.
Building the IPA deployment ramdisk
===================================
For more information see the `Image Builder <http://docs.openstack.org/developer/ironic-python-agent/#image-builders>`_ section of the Ironic Python Agent
developer guide.
Using IPA with devstack
=======================
This is covered in the `Deploying Ironic with DevStack <http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack>`_
section of the Ironic dev-quickstart guide.
Project Resources
=================
Project status, bugs, and blueprints are tracked on Launchpad:
http://launchpad.net/ironic-python-agent
Developer documentation can be found here:
http://docs.openstack.org/developer/ironic-python-agent
Additional resources are linked from the project wiki page:
https://wiki.openstack.org/wiki/Ironic-python-agent
IRC channel:
#openstack-ironic
To contribute, start here: `Openstack: How to
contribute <http://docs.openstack.org/infra/manual/developers.html>`_.