ironic/doc/source/index.rst
Ruby Loo e30e77aefa Link to config reference in our docs
The ironic configuration options for kilo are documented with the rest
of the OpenStack configs at
   http://docs.openstack.org/kilo/config-reference/content/.

This adds a 'Configuration Reference (Kilo)' entry to the index of our developer
documentation with a link to the config-reference URL. The install guide
also has a link to the config reference.

It also removes 'Bare Metal Service' from two entries at
http://docs.openstack.org/developer/ironic/, since it seems redundant.
(Everything there is about Bare Metal Service!)

Change-Id: Idf649641b2108ac6075e7b67c547551bccd9d5f7
2015-05-04 22:22:35 +00:00

1.7 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 developer 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.

Developer Guide

Introduction

dev/architecture dev/states dev/contributing

dev/dev-quickstart dev/vendor-passthru

API References

webapi/v1 dev/drivers

Admin Guide

Overview

deploy/user-guide Installation Guide <deploy/install-guide> Upgrade Guide <deploy/upgrade-guide> Configuration Reference (Kilo) <http://docs.openstack.org/kilo/config-reference/content/ch_configuring-openstack-bare-metal.html> deploy/drivers deploy/cleaning

Commands

cmds/ironic-dbsync

Indices and tables

  • genindex
  • modindex
  • search