ironic-python-agent/README.rst
lidong 493527ae78 Update links in README
Change the outdated links to the latest links in README

Change-Id: Ibb323d7305f2e58a697cc6ea461e3e645e75800c
2017-08-11 00:48:07 +00:00

58 lines
1.8 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/ironic-python-agent.svg
:target: https://governance.openstack.org/tc/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 <https://docs.openstack.org/ironic-python-agent/latest/install/index.html#image-builders>`_ section of the Ironic Python Agent
developer guide.
Using IPA with devstack
=======================
This is covered in the `Deploying Ironic with DevStack <https://docs.openstack.org/ironic/latest/contributor/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:
https://launchpad.net/ironic-python-agent
Developer documentation can be found here:
https://docs.openstack.org/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 <https://docs.openstack.org/infra/manual/developers.html>`_.