nova/doc/source/index.rst

..
      Copyright 2010 United States Government as represented by the
      Administrator of the National Aeronautics and Space Administration. 
      All Rights Reserved.

      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

Welcome to Nova's documentation!
================================

Nova is a cloud computing fabric controller, the main part of an IaaS system.   Individuals and organizations can use it to host and manage their own cloud computing systems.  Nova originated as a project out of NASA Ames Research Laboratory.

Nova is written with the following design guidelines in mind:

* **Component based architecture**: Quickly add new behaviors
* **Highly available**: Scale to very serious workloads
* **Fault-Tollerant**: Isloated processes avoid cascading failures
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
* **Open Standards**: Be a reference implementation for a community-driven api
* **API Compatibility**: Nova strives to provide API-compatible with popular systems like Amazon EC2

This documentation is generated by the Sphinx toolkit and lives in the source
tree.  Additional documentation on Nova and other components of OpenStack can
be found on the `OpenStack wiki`_.  Also see the :doc:`reaching.out` page for
other ways to interact with the community.

.. _`OpenStack wiki`: http://wiki.openstack.org


Contents
========

.. toctree::
   :maxdepth: 1

   concepts.and.introduction
   adminguide/index
   devguide/index
   reaching.out

Recommended System Configuration
================================

Although Nova can be run on a variety of system architectures, for most users the following will be simplest:

* Ubuntu Lucid
* 10GB Hard Disk Space
* 512MB RAM

For development, Nova can run from within a VM.

.. include:: adminguide/quickstart.rst


Outstanding Documentation Tasks
===============================

.. todolist::

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`