ironic-python-agent/README.rst

========================
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>`_.
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-24 13:03:40 +01:00			`========================`
			`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`

Converted documentation in md format to rst Change-Id: I88c642a24fb032b6e0920c8ba378127f8e12116c Closes-Bug: 1332741 2014-06-25 09:04:26 +01:00			`ironic-python-agent`
			`===================`

Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00			`An agent for controlling and deploying Ironic controlled baremetal nodes.`

Use doc8 style checker This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. The README was modified because it had several lines that were were longer than 79 characters, and some links were fixed. Change-Id: Ia21b680ec227357ada58326fea104696561475d5 2015-09-30 23:48:46 +00:00			`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.`
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00
Use doc8 style checker This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. The README was modified because it had several lines that were were longer than 79 characters, and some links were fixed. Change-Id: Ia21b680ec227357ada58326fea104696561475d5 2015-09-30 23:48:46 +00:00			`The ironic-python-agent may also be used with the original Ironic pxe drivers`
			`as of the Kilo OpenStack release.`
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00

			`Building the IPA deployment ramdisk`
Use doc8 style checker This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. The README was modified because it had several lines that were were longer than 79 characters, and some links were fixed. Change-Id: Ia21b680ec227357ada58326fea104696561475d5 2015-09-30 23:48:46 +00:00			`===================================`
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00
Add DIB ironic-agent element to readme for IPA Adding Diskimage Builder ironic-agent element link to README.rst Change-Id: Ie4bb500edd265ece0b3c31179d309a7c270d2004 2016-01-26 17:03:18 -06:00			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.`
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00

			`Using IPA with devstack`
			`=======================`

Use doc8 style checker This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. The README was modified because it had several lines that were were longer than 79 characters, and some links were fixed. Change-Id: Ia21b680ec227357ada58326fea104696561475d5 2015-09-30 23:48:46 +00:00			This is covered in the `Deploying Ironic with DevStack <http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack>`_
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00			`section of the Ironic dev-quickstart guide.`


			`Project Resources`
			`=================`
Adds project resources links to Readme Includes links for launchpad, wiki and dev docs. Closes-Bug:1495668 Change-Id: Ic0559d50425b3ab68fe34d9e88e78c599c29100a 2015-09-14 11:31:43 -07:00			`Project status, bugs, and blueprints are tracked on Launchpad:`

Update the launchpad link for IPA We use now use http://launchpad.net/ironic-python-agent. Change-Id: Id055bc460919f0b81a75fa10b4ff1160a8d2e19d 2015-10-06 13:48:58 -04:00			`http://launchpad.net/ironic-python-agent`
Adds project resources links to Readme Includes links for launchpad, wiki and dev docs. Closes-Bug:1495668 Change-Id: Ic0559d50425b3ab68fe34d9e88e78c599c29100a 2015-09-14 11:31:43 -07:00
			`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`
Update README file README file had very little information in it. This adds some basic information and formating. Change-Id: Ibde19ec7f89b474fd51dacdcd030aaa92d3364a2 2015-03-25 16:41:57 -07:00
			`IRC channel:`
			`#openstack-ironic`

			To contribute, start here: `Openstack: How to
Use doc8 style checker This uses the doc8 style checker to check that document files conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. The README was modified because it had several lines that were were longer than 79 characters, and some links were fixed. Change-Id: Ia21b680ec227357ada58326fea104696561475d5 2015-09-30 23:48:46 +00:00			contribute <http://docs.openstack.org/infra/manual/developers.html>`_.