ironic/doc/source/index.rst
Devananda van der Veen 943585600d Fix broken doc links on the index page
Commit 017f99120b did not move documentation from dev/ to developer/.
The links on the index page were updated incorrectly.
This change reverts that and fixes the broken links.

Change-Id: Ia2f3703589c469bfc2a5204bdd3becc4b09efd0d
2014-02-06 11:21:26 -08:00

2.2 KiB

Welcome to Ironic's developer documentation!

Introduction

Ironic is an Incubated OpenStack project which aims to provision 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.

For an in-depth look at the project's scope and structure, see the dev/architecture page.

Status: Alpha Quality

Ironic is targeting inclusion in the OpenStack Icehouse release. The current codebase should be considered "alpha" quality. All major functional components exist but there are many known bugs which will prevent general use at this time. Additionally, usage documentation still needs to be written.

If you are looking for the preceding baremetal service, which was included in OpenStack Grizzly and Havana releases, please see Nova's Baremetal driver.

Developer Documentation

Overview

dev/architecture dev/contributing dev/dev-quickstart

Client API Reference

webapi/v1

Python API Quick Reference

dev/api dev/common dev/db dev/drivers dev/conductor

Indices and tables

  • genindex
  • modindex
  • search