2013-05-25 18:26:02 -07:00
|
|
|
============================================
|
2013-05-25 08:03:45 +02:00
|
|
|
Welcome to Ironic's developer documentation!
|
|
|
|
============================================
|
|
|
|
|
2013-05-29 11:02:04 -07:00
|
|
|
Introduction
|
|
|
|
============
|
|
|
|
|
|
|
|
Ironic is an Incubated OpenStack project which aims to provision bare
|
2013-05-25 18:26:02 -07:00
|
|
|
metal (as opposed to virtual) machines by leveraging common technologies such
|
|
|
|
as PXE boot and IPMI to cover a wide range of hardware, while supporting
|
|
|
|
pluggable drivers to allow vendor-specific functionality to be added.
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2013-05-25 18:26:02 -07:00
|
|
|
If one thinks of traditional hypervisor functionality (eg, creating a VM,
|
|
|
|
enumerating virtual devices, managing the power state, loading an OS onto the
|
2013-05-30 16:35:07 -07:00
|
|
|
VM, and so on), then Ironic may be thought of as a *hypervisor API* gluing
|
2013-05-25 18:26:02 -07:00
|
|
|
together multiple drivers, each of which implement some portion of that
|
|
|
|
functionality with respect to physical hardware.
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
Ironic should be considered Beta quality as of the Icehouse release, and will
|
|
|
|
make the best effort to maintain backwards compatibility from this point
|
|
|
|
forward. Release notes are available here:
|
|
|
|
https://wiki.openstack.org/wiki/Ironic/ReleaseNotes/Icehouse
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
The developer documentation provided here is continually kept up-to-date based
|
|
|
|
on the latest code, and may not represent the state of our APIs at any given
|
|
|
|
release.
|
2013-05-25 08:03:45 +02:00
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
Developer Guide
|
|
|
|
===============
|
2013-05-25 18:26:02 -07:00
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
Introduction
|
|
|
|
------------
|
2013-05-29 11:02:04 -07:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2014-02-06 11:21:26 -08:00
|
|
|
dev/architecture
|
|
|
|
dev/contributing
|
2013-05-29 11:02:04 -07:00
|
|
|
|
|
|
|
.. toctree::
|
2014-04-15 12:08:13 -07:00
|
|
|
dev/dev-quickstart
|
2013-05-29 11:02:04 -07:00
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
API References
|
|
|
|
--------------
|
2013-05-29 11:02:04 -07:00
|
|
|
|
|
|
|
.. toctree::
|
2014-01-15 16:05:46 -08:00
|
|
|
:maxdepth: 1
|
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
webapi/v1
|
2014-02-06 11:21:26 -08:00
|
|
|
dev/common
|
|
|
|
dev/db
|
|
|
|
dev/drivers
|
2013-05-29 11:02:04 -07:00
|
|
|
|
2014-03-27 16:12:28 +05:30
|
|
|
Admin Guide
|
2014-04-15 12:08:13 -07:00
|
|
|
===========
|
2014-03-27 16:12:28 +05:30
|
|
|
|
|
|
|
Overview
|
2014-09-23 13:19:43 -04:00
|
|
|
--------
|
2014-03-27 16:12:28 +05:30
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2014-04-15 12:08:13 -07:00
|
|
|
deploy/user-guide
|
|
|
|
deploy/install-guide
|
2014-06-10 12:28:29 +02:00
|
|
|
deploy/drivers
|
2014-03-19 21:50:13 +00:00
|
|
|
|
2014-09-23 13:19:43 -04:00
|
|
|
Commands
|
|
|
|
--------
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
cmds/ironic-dbsync
|
|
|
|
|
2013-05-25 08:03:45 +02:00
|
|
|
Indices and tables
|
|
|
|
==================
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
* :ref:`modindex`
|
|
|
|
* :ref:`search`
|