merged trunk

14 files changed, 444 insertions, 156 deletions

diff --git a/doc/source/_templates/layout.html b/doc/source/_ga/layout.html
index 0b72a77ac..0b72a77ac 100644
--- a/doc/source/_templates/layout.html
+++ b/doc/source/_ga/layout.html
diff --git a/doc/source/_templates/.DS_Store b/doc/source/_templates/.DS_Store
new file mode 100644
index 000000000..5008ddfcf
--- /dev/null
+++ b/doc/source/_templates/.DS_Store
diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 000000000..3f1c69a15
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,163 @@
+..
+      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.
+
+API Endpoint Programming Guide
+==============================
+
+::
+
+    TODO(todd): get actual docstrings from ec2/osapi_verions instead of @wsgify
+
+Nova has a system for managing multiple APIs on different subdomains.
+Currently there is support for the OpenStack API, as well as the Amazon EC2
+API.
+
+Common Components
+-----------------
+
+The :mod:`nova.api` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`cloud` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.cloud
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+OpenStack API
+-------------
+
+The :mod:`openstack` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`auth` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`backup_schedules` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.backup_schedules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`faults` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.faults
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`flavors` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.flavors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`images` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.images
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`ratelimiting` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.ratelimiting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`servers` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.servers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`sharedipgroups` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.sharedipgroups
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+EC2 API
+-------
+
+The :mod:`nova.api.ec2` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`admin` Module
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2.admin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`apirequest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2.apirequest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`cloud` Module
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2.cloud
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`images` Module
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2.images
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`metadatarequesthandler` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.ec2.metadatarequesthandler
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/auth.rst b/doc/source/auth.rst
index 0230ec5c4..61db39ec3 100644
--- a/doc/source/auth.rst
+++ b/doc/source/auth.rst
@@ -17,21 +17,76 @@
 
 .. _auth:
 
-Authentication and Authorization Development Guide
+Authentication and Authorization Programming Guide
 ==================================================
 
 ::
 
-    TOOD(todd);
-        * Authentication
-            * Manager
-            * Driver
-                * ldap
-                * fakeldap
-                * redisectomy
-        * Authorizztion
-            * RBAC
-            * Quotas
+    TOOD(todd): * Authorizztion
+                    * RBAC
+                    * Quotas
+
+
+Auth Manager
+------------
+
+The :mod:`manager` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.auth.manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Drivers
+-------
+
+The :mod:`ldapdriver` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.auth.ldapdriver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`dbdriver` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.auth.dbdriver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+API Integration
+---------------
+
+The :mod:`signer` Module
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.auth.signer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Related Tests
+-------------
+
+The :mod:`auth_unittest` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.tests.auth_unittest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`access_unittest` Module
+---------------------------------
+
+.. automodule:: nova.tests.access_unittest
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 
 legacy docs
@@ -194,59 +249,3 @@ Further Challenges
 
 
 
-The :mod:`signer` Module
-------------------------
-
-.. automodule:: nova.auth.signer
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`manager` Module
--------------------------
-
-.. automodule:: nova.auth.manager
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`ldapdriver` Module
-----------------------------
-
-.. automodule:: nova.auth.ldapdriver
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`dbdriver` Module
-----------------------------
-
-.. automodule:: nova.auth.dbdriver
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`auth_unittest` Module
---------------------------------
-
-.. automodule:: nova.tests.auth_unittest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`access_unittest` Module
----------------------------------
-
-.. automodule:: nova.tests.access_unittest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`ec2` Module
----------------------
-
-.. automodule:: nova.api.ec2
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
diff --git a/doc/source/compute.rst b/doc/source/compute.rst
index 9b4d10227..e9e37ebf8 100644
--- a/doc/source/compute.rst
+++ b/doc/source/compute.rst
@@ -24,7 +24,7 @@ This page contains the Compute Package documentation.
 
 ::
 
-    TODO(todd): Document drivers
+    TODO(todd): * document instance_types and power_states
 
 
 Manager
@@ -42,6 +42,13 @@ The :mod:`manager` Module
     :undoc-members:
     :show-inheritance:
 
+The :mod:`connection` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.virt.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 The :mod:`disk` Module
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -51,6 +58,14 @@ The :mod:`disk` Module
     :undoc-members:
     :show-inheritance:
 
+The :mod:`images` Module
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.virt.images
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 The :mod:`instance_types` Module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -73,40 +88,37 @@ The :mod:`power_state` Module
 Drivers
 -------
 
-
 Libvirt Implementations
 ~~~~~~~~~~~~~~~~~~~~~~~
 
+The libvirt driver is capable of supporting KVM, QEMU, and UML.
 
-Libvirt: KVM
-^^^^^^^^^^^^
-
-KVM Driver
-
-
-Libvirt: QEMU
-^^^^^^^^^^^^^
-
-QEMU Driver
-
-
-Libvirt: UML
-^^^^^^^^^^^^
-
-User Mode Linux Driver
+The :mod:`libvirt_conn` Module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. automodule:: nova.virt.libvirt_conn
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 XEN
 ~~~
 
-Xen Driver
+The :mod:`xenapi` Module
+^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. automodule:: nova.virt.xenapi
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-Hyper-V
-~~~~~~~
-
-Hyper-V Driver
+FAKE
+~~~~
 
+.. automodule:: nova.virt.fake
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 Monitoring
 ----------
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e91860536..27bc4ea6c 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -27,7 +27,13 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
 todo_include_todos = True
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+# Changing the path so that the Hudson build output contains GA code and the source
+# docs do not contain the code so local, offline sphinx builds are "clean."
+templates_path = []
+if os.getenv('HUDSON_PUBLISH_DOCS'):
+  templates_path = ['_ga', '_templates']
+else:
+  templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
diff --git a/doc/source/database.rst b/doc/source/database.rst
index 41b362d19..b58ea147d 100644
--- a/doc/source/database.rst
+++ b/doc/source/database.rst
@@ -18,12 +18,6 @@
 Database Programming Guide
 ==========================
 
-::
-
-    TODO(todd): should sqlalchemy.api be here?
-                pep-256 on db/api.py and models.py (periods)
-                document register_models (where should it be called from?)
-
 The :mod:`api` Module
 ---------------------
 
@@ -36,17 +30,32 @@ The :mod:`api` Module
 Drivers
 -------
 
-The :mod:`sqlalchemy` Driver
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Driver: Sqlalchemy
+~~~~~~~~~~~~~~~~~~
+
+The :mod:`sqlalchemy.api` Module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. automodule:: nova.db.sqlalchemy.api
+
+The :mod:`sqlalchemy.models` Module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: nova.db.sqlalchemy.models
     :members:
     :undoc-members:
     :show-inheritance:
 
+The :mod:`sqlalchemy.session` Module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: nova.db.sqlalchemy.models
+.. automodule:: nova.db.sqlalchemy.session
     :members:
     :undoc-members:
     :show-inheritance:
 
+Tests
+-----
+
+Tests are lacking for the db api layer and for the sqlalchemy driver.
+Failures in the drivers would be dectected in other test cases, though.
diff --git a/doc/source/development.guide.rst b/doc/source/development.guide.rst
index d9a7c46f9..261059d9b 100644
--- a/doc/source/development.guide.rst
+++ b/doc/source/development.guide.rst
@@ -18,7 +18,11 @@
 Nova Development Guide
 ======================
 
-Nova is written in python
+Nova is written in python.
+
+::
+
+    TODO(todd): * Building packages
 
 
 Contents
@@ -32,26 +36,11 @@ Contents
    compute
    network      
    auth  
-
-
-Older Contents
---------------
-
-.. toctree::
-   :maxdepth: 1
-
-   architecture
-   nova
+   api
+   scheduler
    fakes
-   binaries
-   modules
-   packages
-
-
-Removed
--------
+   nova
 
-* endpoint
 
 Indices and tables
 ------------------
diff --git a/doc/source/fakes.rst b/doc/source/fakes.rst
index eccd4ab43..5988e2ab8 100644
--- a/doc/source/fakes.rst
+++ b/doc/source/fakes.rst
@@ -15,8 +15,13 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-Nova Fakes
-==========
+Fakes Programming Guide
+=======================
+
+::
+
+    TODO(todd): * document general info about fakes
+
 
 The :mod:`virt.fake` Module
 ---------------------------
@@ -25,6 +30,7 @@ The :mod:`virt.fake` Module
     :members:
     :undoc-members:
     :show-inheritance:
+    :noindex:
     
 The :mod:`fakeldap` Module
 --------------------------
@@ -41,3 +47,28 @@ The :mod:`fakerabbit` Module
     :members:
     :undoc-members:
     :show-inheritance:
+
+The :class:`FakeAOEDriver` Class
+--------------------------------
+
+.. autoclass:: nova.volume.driver.FakeAOEDriver
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :class:`service_unittest.FakeManager` Class
+-----------------------------------------------
+
+.. autoclass:: nova.tests.service_unittest.FakeManager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`api.openstack.fakes` Module
+------------------------------------------------
+
+.. automodule:: nova.tests.api.openstack.fakes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 54cfea05a..261919629 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -22,11 +22,11 @@ Nova is a cloud computing fabric controller, the main part of an IaaS system.
 
 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
+* **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
 
 This documentation is generated by the Sphinx toolkit and lives in the source
 tree.  Additional documentation on Nova and other components of OpenStack can
diff --git a/doc/source/network.rst b/doc/source/network.rst
index f53360bd7..b044c6413 100644
--- a/doc/source/network.rst
+++ b/doc/source/network.rst
@@ -25,6 +25,7 @@ Networking Programming Guide
         * document backend (linux-net)
         * document hardware specific commands
         * pep 257
+        * document flags
 
 The :mod:`Manager` module
 -------------------------
diff --git a/doc/source/nova.rst b/doc/source/nova.rst
index 4b9c44a5f..59fd56c85 100644
--- a/doc/source/nova.rst
+++ b/doc/source/nova.rst
@@ -15,29 +15,29 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-NOVA Libraries
-===============
+Nova Libraries Programming Guide
+================================
 
-The :mod:`crypto` Module
-------------------------
+The :mod:`adminclient` Module
+-----------------------------
 
-.. automodule:: nova.crypto
+.. automodule:: nova.adminclient
     :members:
     :undoc-members:
     :show-inheritance:
-    
-The :mod:`adminclient` Module
------------------------------
 
-.. automodule:: nova.adminclient
+The :mod:`context` Module
+-------------------------
+
+.. automodule:: nova.context
     :members:
     :undoc-members:
     :show-inheritance:
 
-The :mod:`datastore` Module
----------------------------
+The :mod:`crypto` Module
+------------------------
 
-.. automodule:: nova.datastore
+.. automodule:: nova.crypto
     :members:
     :undoc-members:
     :show-inheritance:
@@ -49,43 +49,99 @@ The :mod:`exception` Module
     :members:
     :undoc-members:
     :show-inheritance:
-    
+
 The :mod:`flags` Module
----------------------------
+-----------------------
 
 .. automodule:: nova.flags
     :members:
     :undoc-members:
     :show-inheritance:
 
+The :mod:`manager` Module
+-------------------------
+
+.. automodule:: nova.manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`process` Module
+-------------------------
+
+.. automodule:: nova.process
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`quota` Module
+-----------------------
+
+.. automodule:: nova.quota
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 The :mod:`rpc` Module
----------------------------
+---------------------
 
 .. automodule:: nova.rpc
     :members:
     :undoc-members:
     :show-inheritance:
-    
+
 The :mod:`server` Module
----------------------------
+------------------------
 
 .. automodule:: nova.server
     :members:
     :undoc-members:
     :show-inheritance:
-    
+
+The :mod:`service` Module
+-------------------------
+
+.. automodule:: nova.service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 The :mod:`test` Module
----------------------------
+----------------------
 
 .. automodule:: nova.test
     :members:
     :undoc-members:
     :show-inheritance:  
-      
+
+The :mod:`twistd` Module
+------------------------
+
+.. automodule:: nova.twistd
+    :members:
+    :undoc-members:
+    :show-inheritance:  
+
 The :mod:`utils` Module
----------------------------
+-----------------------
 
 .. automodule:: nova.utils
     :members:
     :undoc-members:
     :show-inheritance:
+
+The :mod:`validate` Module
+--------------------------
+
+.. automodule:: nova.validate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`wsgi` Module
+----------------------
+
+.. automodule:: nova.wsgi
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/packages.rst b/doc/source/scheduler.rst
index 6029ad7d7..e809b0c54 100644
--- a/doc/source/packages.rst
+++ b/doc/source/scheduler.rst
@@ -15,15 +15,37 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-nova Packages & Dependencies
-============================
+Scheduler Programming Guide
+===========================
 
-Nova is being built on Ubuntu Lucid.
+The :mod:`manager` Module
+-------------------------
 
-The following packages are required:
+.. automodule:: nova.scheduler.manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-  apt-get install python-ipy, python-libvirt, python-boto, python-pycurl, python-twisted, python-daemon, python-redis, python-carrot, python-lockfile
+The :mod:`driver` Module
+------------------------
 
-In addition you need to install python:
+.. automodule:: nova.scheduler.driver
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
- * python-gflags - http://code.google.com/p/python-gflags/
+The :mod:`chance` Module
+------------------------
+
+.. automodule:: nova.scheduler.chance
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`simple` Module
+------------------------
+
+.. automodule:: nova.scheduler.simple
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/source/volume.rst b/doc/source/volume.rst
index f4162560c..39b33a500 100644
--- a/doc/source/volume.rst
+++ b/doc/source/volume.rst
@@ -20,8 +20,7 @@ Volume Programming Guide
 
 ::
 
-    TODO(todd): document for iSCSI & AoE (see 'Old Docs')
-                pep-257
+    TODO(todd): rework after iSCSI merge (see 'Old Docs')
 
 
 The :mod:`nova.volume.manager` Module
@@ -39,6 +38,7 @@ The :mod:`nova.volume.driver` Module
     :members:
     :undoc-members:
     :show-inheritance:
+    :exclude-members: FakeAOEDriver
 
 Tests
 -----