openstack/ironic
Code Issues Proposed changes
1ebbb7f19b
ironic/doc/source/index.rst
Bruno Cornec 5c888986bc Update documentation index.rst 
Reorder the index doc to place Admin guide first (before the dev doc) so
that users/newcomers have a more easy entry point

Change-Id: Id9de3e02877c539da973d38734afbb8f5ac0a7e5
2015-05-27 19:56:01 +09:00

1.7 KiB
Raw Blame History

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.

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

Developer Guide

Introduction

dev/architecture dev/states dev/contributing

dev/dev-quickstart dev/vendor-passthru

API References

webapi/v1 dev/drivers

Indices and tables

  • genindex
  • modindex
  • search