ironic/doc/source/index.rst
Dmitry Tantsur f049cfd188 Update the inspection documentation
This change moves inspection documentation to its own file
(similar to RAID and cleaning).

It also adds a list of capabilities we *might* discover during inspection.
It's partly based on the iLO spec [1], partly - on the in-band capabilities
discovery RFE [2]. The vendor-specific bits are missing on purpose.

The goal here is to have a common subset of capabilities to be discovered
by all (or the majority) of the drivers (including in-band inspection).

[1] http://specs.openstack.org/openstack/ironic-specs/specs/kilo-implemented/ilo-properties-capabilities-discovery.html#proposed-change
[2] https://bugs.launchpad.net/ironic-python-agent/+bug/1571580

Related-Bug: #1571580
Change-Id: If5d466a2c331674abb30d30dc39871f25a84de88
2016-04-20 14:46:13 +02:00

2.0 KiB

Welcome to Ironic's developer documentation!

Introduction

Ironic is an OpenStack project which provisions bare 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.

If one thinks of traditional hypervisor functionality (eg, creating a VM, enumerating virtual devices, managing the power state, loading an OS onto the VM, and so on), then Ironic may be thought of as a hypervisor API gluing together multiple drivers, each of which implement some portion of that functionality with respect to physical hardware.

The documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any specific prior release.

For information on any current or prior version of Ironic, see the release notes.

Administrator's Guide

deploy/user-guide Installation Guide <deploy/install-guide> Upgrade Guide <deploy/upgrade-guide> Configuration Reference (Liberty) <http://docs.openstack.org/liberty/config-reference/content/ch_configuring-openstack-bare-metal.html> drivers/ipa deploy/drivers deploy/cleaning deploy/raid deploy/inspection deploy/troubleshooting Release Notes <http://docs.openstack.org/releasenotes/ironic/>

Commands and API References

cmds/ironic-dbsync webapi/v1 dev/drivers

Developer's Guide

dev/architecture dev/states dev/contributing dev/code-contribution-guide dev/dev-quickstart dev/vendor-passthru dev/faq

Indices and tables

  • genindex
  • modindex
  • search