Updated documentation

doc/source/getting.started.rst

@@ -18,23 +18,20 @@
 Getting Started with Nova
 =========================
 
+This code base is continually changing so dependencies also change. 
 
-GOTTA HAVE A nova.pth file added or it WONT WORK (will write setup.py file soon)
-
-Create a file named nova.pth in your python libraries directory
-(usually /usr/local/lib/python2.6/dist-packages) with a single line that points
-to the directory where you checked out the source (that contains the nova/
-directory).
-
-DEPENDENCIES
+Dependencies
 ------------
 
 Related servers we rely on
 
 * RabbitMQ: messaging queue, used for all communication between components
-* OpenLDAP: users, groups (maybe cut)
+* OpenLDAP: users, groups 
+
+Optional servers
+
 * ReDIS: Remote Dictionary Store (for fast, shared state data)
-* nginx: HTTP server to handle serving large files (because Tornado can't)
+* nginx: HTTP server to handle serving large files 
 
 Python libraries we don't vendor
 
@@ -44,7 +41,6 @@ Python libraries we don't vendor
 
 Vendored python libaries (don't require any installation)
 
-* Tornado: scalable non blocking web server for api requests
 * Twisted: just for the twisted.internet.defer package
 * boto: python api for aws api
 * IPy: library for managing ip addresses
@@ -60,35 +56,14 @@ Installation
 --------------
 ::
 
-    # system libraries and tools
-    apt-get install -y aoetools vlan curl
-    modprobe aoe
-
-    # python libraries
-    apt-get install -y python-setuptools python-dev python-pycurl python-m2crypto
-
-    # ON THE CLOUD CONTROLLER
-    apt-get install -y rabbitmq-server dnsmasq nginx
-    # build redis from 2.0.0-rc1 source
-    # setup ldap (slap.sh as root will remove ldap and reinstall it)
-    NOVA_PATH/nova/auth/slap.sh
-    /etc/init.d/rabbitmq-server start
-
-    # ON VOLUME NODE:
-    apt-get install -y vblade-persist
-
-    # ON THE COMPUTE NODE:
-    apt-get install -y python-libvirt
-    apt-get install -y kpartx kvm libvirt-bin
-    modprobe kvm
-
-    # optional packages
-    apt-get install -y euca2ools
+    Due to many changes it's best to rely on the 'OpenStack wiki <http://wiki.openstack.org>' for installation instructions.
 
 Configuration
 ---------------
 
-ON CLOUD CONTROLLER
+These instructions are incomplete, but we are actively updating the 'OpenStack wiki <http://wiki.openstack.org>' with more configuration information.
+
+On the cloud controller
 
 * Add yourself to the libvirtd group, log out, and log back in
 * fix hardcoded ec2 metadata/userdata uri ($IP is the IP of the cloud), and masqurade all traffic from launched instances
@@ -137,7 +112,7 @@ Running
 Launch servers
 
 * rabbitmq
-* redis
+* redis (optional)
 * slapd
 * nginx
 

doc/source/index.rst

@@ -15,18 +15,21 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-Welcome to nova's documentation!
+Welcome to Nova's documentation!
 ================================
 
-Nova is a cloud computing fabric controller (the main part of an IaaS system) built to match the popular AWS EC2 and S3 APIs. 
-It is written in Python, using the Tornado and Twisted frameworks, and relies on the standard AMQP messaging protocol, 
-and the Redis distributed KVS.
-Nova is intended to be easy to extend, and adapt. For example, it currently uses 
+Nova is a cloud computing fabric controller (the main part of an IaaS system). 
+It is written in Python and relies on the standard AMQP messaging protocol, uses the Twisted framework,
+and optionally uses the Redis distributed key value store for authorization.
+
+Nova is intended to be easy to extend and adapt. For example, it currently uses 
 an LDAP server for users and groups, but also includes a fake LDAP server,
 that stores data in Redis. It has extensive test coverage, and uses the 
-Sphinx toolkit (the same as Python itself) for code and user documentation.
+Sphinx toolkit (the same as Python itself) for code and developer documentation. 
+Additional documentation is available on the 
+'OpenStack wiki <http://wiki.openstack.org>'_.
 While Nova is currently in Beta use within several organizations, the codebase
-is very much under active development - there are bugs!
+is very much under active development - please test it and log bugs!
 
 Contents: