← Back to branch summary

~0x44/nova/bug838466

« back to all changes in this revision

Viewing changes to doc/source/index.rst

  • Committer: Brian Waldon
  • Date: 2011-07-29 16:54:55 UTC
  • mto: This revision was merged to the branch mainline in revision 1364.
  • Revision ID: brian.waldon@rackspace.com-20110729165455-4ebqwv8s5pkscmmg
one last change

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/index.rst
1
1
..
2
 
      Copyright 2010 United States Government as represented by the
 
2
      Copyright 2010-2011 United States Government as represented by the
3
3
      Administrator of the National Aeronautics and Space Administration. 
4
4
      All Rights Reserved.
5
5
 
15
15
      License for the specific language governing permissions and limitations
16
16
      under the License.
17
17
 
18
 
Welcome to nova's documentation!
 
18
Welcome to Nova's documentation!
19
19
================================
20
20
 
21
 
Nova is a cloud computing fabric controller (the main part of an IaaS system) built to match the popular AWS EC2 and S3 APIs. 
22
 
It is written in Python, using the Tornado and Twisted frameworks, and relies on the standard AMQP messaging protocol, 
23
 
and the Redis distributed KVS.
24
 
Nova is intended to be easy to extend, and adapt. For example, it currently uses 
25
 
an LDAP server for users and groups, but also includes a fake LDAP server,
26
 
that stores data in Redis. It has extensive test coverage, and uses the 
27
 
Sphinx toolkit (the same as Python itself) for code and user documentation.
28
 
While Nova is currently in Beta use within several organizations, the codebase
29
 
is very much under active development - there are bugs!
30
 
 
31
 
Contents:
32
 
 
33
 
.. toctree::
34
 
   :maxdepth: 2
35
 
                   
36
 
   getting.started  
37
 
   architecture
38
 
   network      
39
 
   storage
40
 
   auth  
41
 
   compute
42
 
   endpoint
43
 
   nova
44
 
   fakes
45
 
   binaries
46
 
   modules
47
 
   packages
 
21
Nova is a cloud computing fabric controller, the main part of an IaaS system.   
 
22
Individuals and organizations can use Nova to host and manage their own cloud 
 
23
computing systems. Nova originated as a project out of NASA Ames Research Laboratory.
 
24
 
 
25
Nova is written with the following design guidelines in mind:
 
26
 
 
27
* **Component based architecture**: Quickly add new behaviors
 
28
* **Highly available**: Scale to very serious workloads
 
29
* **Fault-Tolerant**: Isolated processes avoid cascading failures
 
30
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
 
31
* **Open Standards**: Be a reference implementation for a community-driven api
 
32
* **API Compatibility**: Nova strives to provide API-compatible with popular systems like Amazon EC2
 
33
 
 
34
This documentation is generated by the Sphinx toolkit and lives in the source
 
35
tree. Additional draft and project documentation on Nova and other components of OpenStack can
 
36
be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_. 
 
37
 
 
38
Also see the :doc:`community` page for other ways to interact with the community.
 
39
 
 
40
.. _`OpenStack wiki`: http://wiki.openstack.org
 
41
.. _`docs.openstack.org`: http://docs.openstack.org
 
42
 
 
43
 
 
44
Key Concepts
 
45
============
 
46
.. toctree::
 
47
   :maxdepth: 1
 
48
 
 
49
   cloud101
 
50
   nova.concepts
 
51
   swift.concepts
 
52
   service.architecture
 
53
   nova.object.model
 
54
   swift.object.model
 
55
   runnova/index
 
56
 
 
57
Developer Docs
 
58
==============
 
59
 
 
60
.. toctree::
 
61
   :maxdepth: 1
 
62
 
 
63
   quickstart
 
64
   devref/index
 
65
   community
 
66
 
 
67
Outstanding Documentation Tasks
 
68
===============================
 
69
 
 
70
.. todolist::
48
71
 
49
72
Indices and tables
50
73
==================