update of the architecture and fix some links

4 files changed, 56 insertions, 39 deletions

diff --git a/doc/source/administration.guide.rst b/doc/source/administration.guide.rst
index 789e97381..8c36d3d44 100644
--- a/doc/source/administration.guide.rst
+++ b/doc/source/administration.guide.rst
@@ -1,6 +1,6 @@
 ..
       Copyright 2010 United States Government as represented by the
-      Administrator of the National Aeronautics and Space Administration. 
+      Administrator of the National Aeronautics and Space Administration.
       All Rights Reserved.
 
       Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -30,6 +30,5 @@ Contents
    quickstart
    getting.started
    multi.node.install
-   services
    flags
    monitoring
diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst
index eba6cbfb8..1e23e1361 100644
--- a/doc/source/architecture.rst
+++ b/doc/source/architecture.rst
@@ -15,36 +15,38 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-nova System Architecture
+Nova System Architecture
 ========================
 
 Nova is built on a shared-nothing, messaging-based architecture. All of the major nova components can be run on multiple servers. This means that most component to component communication must go via message queue. In order to avoid blocking each component while waiting for a response, we use deferred objects, with a callback that gets triggered when a response is received.
 
-In order to achieve shared-nothing with multiple copies of the same component (especially when the component is an API server that needs to reply with state information in a timely fashion), we need to keep all of our system state in a distributed data system. Updates to system state are written into this system, using atomic transactions when necessary. Requests for state are read out of this system. In limited cases, these read calls are memoized within controllers for short periods of time. (Such a limited case would be, for instance, the current list of system users.)
-
+Nova recently moved to using a sql-based central database that is shared by all components in the system.  The amount and depth of the data fits into a sql database quite well.  For small deployments this seems like an optimal solution.  For larger deployments, and especially if security is a concern, nova will be moving towards multiple data stores with some kind of aggregation system.
 
 Components
 ----------
 
-Below you will find a helpful explanation.
+Below you will find a helpful explanation of the different components.
 
 ::
 
-                    [ Auth  Manager ] ---- ( LDAP )
-                            |
-                            |
-                            |
-                            |                / [ Storage ] - ( ATAoE/iSCSI )
-  [ Web Dashboard ] -> [ nova-api ]  < AMQP > -
-                            |                \ [ Nodes ]   - ( libvirt/kvm )
-                         < HTTP >
-                            |
-                    [ nova-objectstore ]
-
-
-* API: receives http requests from boto, converts commands to/from API format, and sending requests to cloud controller
-* Cloud Controller: global state of system, talks to ldap, s3, and node/storage workers through a queue
-* Nodes: worker that spawns instances
-* S3: tornado based http/s3 server
-* User Manager: create/manage users, which are stored in ldap
-* Network Controller: allocate and deallocate IPs and VLANs
+                                      /- ( LDAP )
+                  [ Auth Manager ] ---
+                          |           \- ( DB )
+                          |
+                          |       [ scheduler ] - [ volume ]  - ( ATAoE/iSCSI )
+                          |                /
+  [ Web Dashboard ] -> [ api ] -- < AMQP > ------ [ network ] - ( Flat/Vlan )
+                          |                \
+                       < HTTP >   [ scheduler ] - [ compute ] - ( libvirt/xen )
+                          |                           |
+                   [ objectstore ] < - retrieves images
+
+* DB: sql database for data storage. Used by all components (LINKS NOT SHOWN)
+* Web Dashboard: potential external component that talks to the api
+* api: component that receives http requests, converts commands and communicates with other components via the queue or http (in the case of objectstore)
+* Auth Manager: component responsible for users/projects/and roles.  Can backend to DB or LDAP.  This is not a separate binary, but rather a python class that is used by most components in the system.
+* objectstore: twisted http server that replicates s3 api and allows storage and retrieval of images
+* scheduler: decides which host gets each vm and volume
+* volume: manages dynamically attachable block devices.
+* network: manages ip forwarding, bridges, and vlans
+* compute: manages communication with hypervisor and virtual machines.
diff --git a/doc/source/development.guide.rst b/doc/source/development.guide.rst
index 261059d9b..45ebe2f10 100644
--- a/doc/source/development.guide.rst
+++ b/doc/source/development.guide.rst
@@ -1,6 +1,6 @@
 ..
       Copyright 2010 United States Government as represented by the
-      Administrator of the National Aeronautics and Space Administration. 
+      Administrator of the National Aeronautics and Space Administration.
       All Rights Reserved.
 
       Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -31,11 +31,13 @@ Contents
 .. toctree::
    :maxdepth: 1
 
+   architecture
+   services
    database
    volume
    compute
-   network      
-   auth  
+   network
+   auth
    api
    scheduler
    fakes
diff --git a/doc/source/getting.started.rst b/doc/source/getting.started.rst
index 70f26038f..a0148e4b6 100644
--- a/doc/source/getting.started.rst
+++ b/doc/source/getting.started.rst
@@ -29,24 +29,37 @@ Related servers we rely on
 
 Optional servers
 
-* OpenLDAP: By default, the auth server uses the RDBMS-backed datastore by setting FLAGS.auth_driver to 'nova.auth.dbdriver.DbDriver'. But OpenLDAP (or LDAP) could be configured.
-* ReDIS: By default, this is not enabled as the auth driver.
+* OpenLDAP: By default, the auth server uses the RDBMS-backed datastore by setting FLAGS.auth_driver to 'nova.auth.dbdriver.DbDriver'. But OpenLDAP (or LDAP) could be configured by specifying 'nova.auth.ldapdriver.LdapDriver'.  There is a script in the sources(nova/auth/slap.sh) to install a very basic openldap server on ubuntu.
+* ReDIS: There is a fake ldap driver that backends to redis. This was created for testing ldap implementation on systems that don't have an easy means to install ldap.
 
-Python libraries we don't vendor
+Python libraries that we use (from pip-requires):
+
+.. literalinclude:: ../../tools/pip-requires
+
+Other libraries:
 
-* M2Crypto: python library interface for openssl
-* curl
 * XenAPI: Needed only for Xen Cloud Platform or XenServer support. Available from http://wiki.xensource.com/xenwiki/XCP_SDK or http://community.citrix.com/cdn/xs/sdks.
 
-Vendored python libaries (don't require any installation)
+External unix tools that are required:
+
+* iptables
+* ebtables
+* gawk
+* curl
+* kvm
+* libvirt
+* dnsmasq
+* vlan
+* open-iscsi and iscsitarget (if you use iscsi volumes)
+* aoetools and vblade-persist (if you use aoe-volumes)
+
+Nova uses cutting-edge versions of many packages. There are ubuntu packages in the nova-core ppa.  You can use add this ppa to your sources list on an ubuntu machine with the following commands::
 
-* Twisted: just for the twisted.internet.defer package
-* Tornado: scalable non blocking web server for api requests
-* boto: python api for aws api
-* IPy: library for managing ip addresses
+  sudo apt-get install -y python-software-properties
+  sudo add-apt-repository ppa:nova-core/ppa
 
 Recommended
------------------
+-----------
 
 * euca2ools: python implementation of aws ec2-tools and ami tools
 * build tornado to use C module for evented section
@@ -55,7 +68,7 @@ Recommended
 Installation
 --------------
 
-    Due to many changes it's best to rely on the `OpenStack wiki <http://wiki.openstack.org>`_ for installation instructions.
+Due to many changes it's best to rely on the `OpenStack wiki <http://wiki.openstack.org>`_ for installation instructions.
 
 Configuration
 ---------------
@@ -88,3 +101,4 @@ Launch nova components
 * nova-compute
 * nova-objectstore
 * nova-volume
+* nova-scheduler