← Back to branch summary

~citrix-openstack/nova/xenapi

« back to all changes in this revision

Viewing changes to doc/source/index.rst

  • Committer: Tarmac
  • Author(s): Todd Willey, root, Vishvananda Ishaya, Joe Heck, root, Andy Smith, Anne Gentle, Dean Troyer, Devin Carlen
  • Date: 2010-11-16 02:34:47 UTC
  • mfrom: (386.2.71 trunkdoc)
  • Revision ID: hudson@openstack.org-20101116023447-pz7n6ps5rf0fnjea
Lots of documentation and docstring updates.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/index.rst
18
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). 
22
 
It is written in Python and relies on the standard AMQP messaging protocol, uses the Twisted framework,
23
 
and optionally uses the Redis distributed key value store for authorization.
24
 
 
25
 
Nova is intended to be easy to extend and adapt. For example, authentication and authorization
26
 
requests by default use an RDBMS-backed datastore driver.  However, there is already support
27
 
for using LDAP backing authentication (slapd) and if you wish to "fake" LDAP, there is a module
28
 
available that uses ReDIS to store authentication information in an LDAP-like backing datastore. 
29
 
It has extensive test coverage, and uses the Sphinx toolkit (the same as Python itself) for code 
30
 
and developer documentation. Additional documentation is available on the 
31
 
'OpenStack wiki <http://wiki.openstack.org>'_.
32
 
While Nova is currently in Beta use within several organizations, the codebase
33
 
is very much under active development - please test it and log bugs!
34
 
 
35
 
Contents:
36
 
 
37
 
.. toctree::
38
 
   :maxdepth: 2
39
 
                   
40
 
   getting.started  
41
 
   architecture
42
 
   network      
43
 
   storage
44
 
   auth  
45
 
   compute
46
 
   endpoint
47
 
   nova
48
 
   fakes
49
 
   binaries
50
 
   modules
51
 
   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-Tollerant**: Isloated 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 documentation on Nova and other components of OpenStack can
 
36
be found on the `OpenStack wiki`_.  Also see the :doc:`community` page for
 
37
other ways to interact with the community.
 
38
 
 
39
.. _`OpenStack wiki`: http://wiki.openstack.org
 
40
 
 
41
 
 
42
Key Concepts
 
43
============
 
44
.. toctree::
 
45
   :maxdepth: 1
 
46
 
 
47
   cloud101
 
48
   nova.concepts
 
49
   swift.concepts
 
50
   service.architecture
 
51
   nova.object.model
 
52
   swift.object.model
 
53
 
 
54
Administrator's Documentation
 
55
=============================
 
56
 
 
57
.. toctree::
 
58
   :maxdepth: 1
 
59
 
 
60
   livecd
 
61
   adminguide/index
 
62
   adminguide/single.node.install
 
63
   adminguide/multi.node.install
 
64
 
 
65
.. todo:: add swiftadmin
 
66
 
 
67
Developer Docs
 
68
==============
 
69
 
 
70
.. toctree::
 
71
   :maxdepth: 1
 
72
 
 
73
   quickstart
 
74
   devref/index
 
75
   community
 
76
 
 
77
Outstanding Documentation Tasks
 
78
===============================
 
79
 
 
80
.. todolist::
52
81
 
53
82
Indices and tables
54
83
==================