openstack/ironic-python-agent
Code Issues Proposed changes
A Python agent for provisioning and deprovisioning Bare Metal servers.
2,006 Commits 13 Branches 82 Tags 34 MiB
Python 99.9%
Shell 0.1%
3faf13bbb4
Go to file
Dmitry Tantsur 3faf13bbb4 Refactor and fix documentation 
Currently the index page contains a brief introduction and 3 links.
Expand the table of contents to show more subheadings.

Clean up the install, admin and contributing docs of unnecessary
and wrong content and redundant headings.

Update URLs throughout the text.

Change-Id: I03279ffc9faf387b08f727dee3b8898a69918460
2020-08-24 15:27:45 +02:00
doc Refactor and fix documentation 2020-08-24 15:27:45 +02:00
examples Examples: add deploy_steps examples 2020-08-04 16:51:54 +02:00
imagebuild Remove imagebuild/common, it's not longer used by IPA-builder 2019-10-16 14:14:13 +02:00
ironic_python_agent Enable the logs collection by default 2020-08-19 17:25:24 +02:00
releasenotes Enable the logs collection by default 2020-08-19 17:25:24 +02:00
tools Adds bandit template and exclude some of tests 2019-06-20 14:39:36 +08:00
zuul.d Remove experimental jobs 2020-08-22 11:39:11 +00:00
.gitignore Remove the configuration sample file 2019-12-02 12:11:58 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:56 +00:00
.stestr.conf Migrate to stestr as unit tests runner 2017-09-26 09:23:53 -07:00
bindep.txt Add ffi development lib to bindep 2020-06-05 14:34:40 +02:00
CONTRIBUTING.rst Change launchpad to StoryBoard 2018-03-28 14:15:29 +00:00
LICENSE add license file 2013-09-17 13:41:59 -07:00
lower-constraints.txt Update version of hacking 2020-07-27 15:15:56 +02:00
plugin-requirements.txt Update hardware to 0.24,0 2020-01-15 12:44:31 +01:00
proxy.sh Add support for proxy servers during image build 2016-02-04 14:27:49 -08:00
README.rst Replace git.openstack.org URLs with opendev.org URLs 2019-04-25 09:23:11 +08:00
requirements.txt Allow specifying target devices for software RAID 2020-03-17 13:03:24 +01:00
setup.cfg Adds poll mode deployment support 2020-06-21 16:44:00 +08:00
setup.py Cleanup py27 support 2020-04-05 10:46:10 +02:00
test-requirements.txt Update version of hacking 2020-07-27 15:15:56 +02:00
tox.ini Import example hardware managers from ipa-example-hardware-managers 2020-07-31 13:35:34 +02:00

README.rst

Ironic Python Agent

Team and repository tags

image

Overview

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 section of the Ironic Python Agent developer guide.

Using IPA with devstack

This is covered in the Deploying Ironic with DevStack section of the Ironic dev-quickstart guide.

Project Resources

Project status, features, and bugs are tracked on StoryBoard:

https://storyboard.openstack.org/#!/project/947

Developer documentation can be found here:

https://docs.openstack.org/ironic-python-agent/latest/

Release notes for the project are available at:

https://docs.openstack.org/releasenotes/ironic-python-agent/

Source code repository for the project is located at:

https://opendev.org/openstack/ironic-python-agent/

IRC channel:

#openstack-ironic

To contribute, start here: Openstack: How to contribute.