Doug Hellmann
c16cd04cf6
blueprint sphinx-doc-cleanup bug 944385 - Fix formatting and markup issues that produce error messages - Update TOC lists for missing/new files - Fix a few links - Update instructions with dependencies for building the documentation - Updated base on review comments from oubiwann to fix trailing whitespace in modified files Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
88 lines
2.5 KiB
ReStructuredText
88 lines
2.5 KiB
ReStructuredText
..
|
|
Copyright 2010-2011 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 Nova 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-Tolerant**: Isolated 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 draft and project documentation on Nova and other components of OpenStack can
|
|
be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_.
|
|
|
|
Also see the :doc:`community` page for other ways to interact with the community.
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
|
.. _`docs.openstack.org`: http://docs.openstack.org
|
|
|
|
|
|
Key Concepts
|
|
============
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
cloud101
|
|
nova.concepts
|
|
service.architecture
|
|
object.model
|
|
runnova/index
|
|
|
|
.. swift.concepts
|
|
.. swift.object.model
|
|
|
|
Developer Docs
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
quickstart
|
|
devref/index
|
|
community
|
|
|
|
API Extensions
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
api_ext/index
|
|
|
|
Outstanding Documentation Tasks
|
|
===============================
|
|
|
|
.. todolist::
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|