ironic/doc/source/index.rst
Devananda van der Veen 4901e861d4 Fix one typo in index.rst.
Fix a one-char typo in index.rst, to regenerate and publish the docs.

Change-Id: Id8e3f1a6d231be7f9c521f41f8310252626620f1
2013-05-30 16:35:13 -07:00

2.0 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: Hard Hat Required!

Ironic is under rapid initial development, forked from Nova's Baremetal driver. If you're looking for an OpenStack service to provision bare metal today, that is where you want to look.

Developer Docs

For those wishing to develop Ironic itself, or add drivers to extend Ironic's functionality, the following documentation is provided.

dev/architecture dev/contributing dev/dev-quickstart

Client API Reference

dev/api-spec-v1

Python API Quick Reference

dev/api dev/cmd dev/common dev/db dev/drivers dev/manager

Indices and tables

  • genindex
  • modindex
  • search