Final edits to multi-node doc and install script

25 files changed, 108 insertions, 202 deletions

diff --git a/doc/source/adminguide/multi.node.install.rst b/doc/source/adminguide/multi.node.install.rst
index bc1ce4137..c97a5cddf 100644
--- a/doc/source/adminguide/multi.node.install.rst
+++ b/doc/source/adminguide/multi.node.install.rst
@@ -38,7 +38,7 @@ Requirements for a multi-node installation
 * For performance optimization, split reads and writes to the database. MySQL proxy is the easiest way to make this work if running MySQL.
  
 Assumptions
-------------------------------------
+-----------
  
 * Networking is configured between/through the physical machines on a single subnet.
 * Installation and execution are both performed by ROOT user.
@@ -126,42 +126,38 @@ The following code can be cut and paste, and edited to your setup:
 2. Create a “nova” group, and set permissions:
  
 ::
- 
-addgroup nova
+    addgroup nova
  
 The Nova config file should have its owner set to root:nova, and mode set to 0644, since they contain your MySQL server's root password.
  
 ::
-  
-chown -R root:nova /etc/nova
-chmod 644 /etc/nova/nova.conf
+    chown -R root:nova /etc/nova
+    chmod 644 /etc/nova/nova.conf
  
 Step 3 - Setup the SQL DB (MySQL for this setup)
 ------------------------------------------------
  
 1. First you 'preseed' to bypass all the installation prompts
+
 ::
- 
-bash
-MYSQL_PASS=nova
-cat <<MYSQL_PRESEED | debconf-set-selections
-mysql-server-5.1 mysql-server/root_password password $MYSQL_PASS
-mysql-server-5.1 mysql-server/root_password_again password $MYSQL_PASS
-mysql-server-5.1 mysql-server/start_on_boot boolean true
-MYSQL_PRESEED
+    bash
+    MYSQL_PASS=nova
+    cat <<MYSQL_PRESEED | debconf-set-selections
+    mysql-server-5.1 mysql-server/root_password password $MYSQL_PASS
+    mysql-server-5.1 mysql-server/root_password_again password $MYSQL_PASS
+    mysql-server-5.1 mysql-server/start_on_boot boolean true
+    MYSQL_PRESEED
  
 2. Install MySQL:
  
 ::
- 
-apt-get install -y mysql-server
+    apt-get install -y mysql-server
  
 3. Edit /etc/mysql/my.cnf to change ‘bind-address’ from localhost to any:
  
 ::
- 
-sed -i 's/127.0.0.1/0.0.0.0/g' /etc/mysql/my.cnf
-service mysql restart
+    sed -i 's/127.0.0.1/0.0.0.0/g' /etc/mysql/my.cnf
+    service mysql restart
  
 3.  Network Configuration
  
@@ -170,7 +166,6 @@ If you use FlatManager (as opposed to VlanManager that we set) as your network m
 Nova defaults to a bridge device named 'br100'. This needs to be created and somehow integrated into YOUR network. To keep things as simple as possible, have all the VM guests on the same network as the VM hosts (the compute nodes). To do so, set the compute node's external IP address to be on the bridge and add eth0 to that bridge. To do this, edit your network interfaces config to look like the following
  
 ::
- 
    < begin /etc/network/interfaces >
    # The loopback network interface
    auto lo
@@ -186,47 +181,42 @@ Nova defaults to a bridge device named 'br100'. This needs to be created and som
           bridge_fd       0
    < end /etc/network/interfaces >
  
- 
 Next, restart networking to apply the changes::
  
-sudo /etc/init.d/networking restart
- 
+    sudo /etc/init.d/networking restart
+
 4. MySQL DB configuration:
  
 Create NOVA database:  
  
 ::
- 
-mysql -uroot -p$MYSQL_PASS -e 'CREATE DATABASE nova;'
+    mysql -uroot -p$MYSQL_PASS -e 'CREATE DATABASE nova;'
  
  
 Update the DB to include user 'root'@'%' with super user privileges
  
 ::
- 
-mysql -uroot -p$MYSQL_PASS -e "GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION;"
+    mysql -uroot -p$MYSQL_PASS -e "GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' WITH GRANT OPTION;"
  
 Set mySQL root password
  
 ::
- 
-mysql -uroot -p$MYSQL_PASS -e "SET PASSWORD FOR 'root'@'%' = PASSWORD('$MYSQL_PASS');"
+    mysql -uroot -p$MYSQL_PASS -e "SET PASSWORD FOR 'root'@'%' = PASSWORD('$MYSQL_PASS');"
  
  
 Step 4 - Setup Nova environment
------------------------------
+-------------------------------
  
 ::
+    /usr/bin/python /usr/bin/nova-manage user admin <user_name>
+    /usr/bin/python /usr/bin/nova-manage project create <project_name> <user_name>
+    /usr/bin/python /usr/bin/nova-manage network create <project-network> <number-of-networks-in-project> <IPs in project>
  
-/usr/bin/python /usr/bin/nova-manage user admin <user_name>
-/usr/bin/python /usr/bin/nova-manage project create <project_name> <user_name>
-/usr/bin/python /usr/bin/nova-manage network create <project-network> <number-of-networks-in-project> <IPs in project>
- 
-Here is an example of what this looks like with real data:
- 
-/usr/bin/python /usr/bin/nova-manage user admin dub
-/usr/bin/python /usr/bin/nova-manage project create dubproject dub
-/usr/bin/python /usr/bin/nova-manage network create 192.168.0.0/24 1 255
+Here is an example of what this looks like with real data::
+
+    /usr/bin/python /usr/bin/nova-manage user admin dub
+    /usr/bin/python /usr/bin/nova-manage project create dubproject dub
+    /usr/bin/python /usr/bin/nova-manage network create 192.168.0.0/24 1 255
  
 (I chose a /24 since that falls inside my /12 range I set in ‘fixed-range’ in nova.conf.  Currently, there can only be one network, and I am using the max IP’s available in a  /24.  You can choose to use any valid amount that you would like.)
  
@@ -241,62 +231,117 @@ Step 5 - Create Nova certs
 1.  Generate the certs as a zip file.  These are the certs you will use to launch instances, bundle images, and all the other assorted api functions:
  
 ::
- 
-mkdir –p /root/creds
-/usr/bin/python /usr/bin/nova-manage project zipfile $NOVA_PROJECT $NOVA_PROJECT_USER /root/creds/novacreds.zip
+    mkdir –p /root/creds
+    /usr/bin/python /usr/bin/nova-manage project zipfile $NOVA_PROJECT $NOVA_PROJECT_USER /root/creds/novacreds.zip
  
 2.  Unzip them in your home directory, and add them to your environment:
  
 ::
- 
-unzip /root/creds/novacreds.zip -d /root/creds/ 
-cat /root/creds/novarc >> ~/.bashrc
-source ~/.bashrc
- 
+    unzip /root/creds/novacreds.zip -d /root/creds/ 
+    cat /root/creds/novarc >> ~/.bashrc
+    source ~/.bashrc
+
 Step 6 - Restart all relevant services
-------------------------------------
+--------------------------------------
+
 Restart all six services in total, just to cover the entire spectrum:
  
 ::
  
-libvirtd restart; service nova-network restart; service nova-compute restart; service nova-api restart; service nova-objectstore restart; service nova-scheduler restart
+    libvirtd restart; service nova-network restart; service nova-compute restart; service nova-api restart; service nova-objectstore restart; service nova-scheduler restart
 
 Step 7 - Closing steps, and cleaning up:
-------------------------------------
+----------------------------------------
 
 One of the most commonly missed configuration areas is not allowing the proper access to VMs. Use the 'euca-authorize' command to enable access.  Below, you will find the commands to allow 'ping' and 'ssh' to your VMs:
 
 ::
 
-euca-authorize -P icmp -t -1:-1 default
-euca-authorize -P tcp -p 22 default
+    euca-authorize -P icmp -t -1:-1 default
+    euca-authorize -P tcp -p 22 default
 
 Another common issue is you cannot ping or SSH your instances after issusing the 'euca-authorize' commands.  Something to look at is the amount of 'dnsmasq' processes that are running.  If you have a running instance, check to see that TWO 'dnsmasq' processes are running.  If not, perform the following:
 
 ::
 
-killall dnsmasq
-service nova-network restart
+    killall dnsmasq
+    service nova-network restart
 
 Step 8 – Testing the installation
-------------------------------------
+---------------------------------
 
 You can then use `euca2ools` to test some items:
  
 ::
- 
-euca-describe-images
-euca-describe-instances
+
+    euca-describe-images
+    euca-describe-instances
  
 If you have issues with the API key, you may need to re-source your creds file:
  
 ::
- 
-. /root/creds/novarc
+
+    . /root/creds/novarc
  
 If you don’t get any immediate errors, you’re successfully making calls to your cloud!
  
-The next thing you are going to need is an image to test.  There will soon be an update on how to capture an image and use it as a bootable AMI so you can ping, ssh, show instances spinning up, etc.
- 
+Step 9 -- Spinning up a VM for testing 
+--------------------------------------
+(This excerpt is from Thierry Carrez's blog, with reference to http://wiki.openstack.org/GettingImages.) 
+
+The image that you will use here will be a ttylinux image, so this is a limited function server. You will be able to ping and SSH to this instance, but it is in no way a full production VM.  
+
+UPDATE: Due to `bug 661159 <https://bugs.launchpad.net/nova/+bug/661159>`_, we can’t use images without ramdisks yet, so we can’t use the classic Ubuntu cloud images from http://uec-images.ubuntu.com/releases/ yet. For the sake of this tutorial, we’ll use the `ttylinux images from Scott Moser instead <http://smoser.brickies.net/ubuntu/ttylinux-uec/>`_.
+
+Download the image, and publish to your bucket:
+
+::
+
+    image="ttylinux-uec-amd64-12.1_2.6.35-22_1.tar.gz"
+    wget http://smoser.brickies.net/ubuntu/ttylinux-uec/$image
+    uec-publish-tarball $image mybucket
+
+This will output three references, an "emi", an "eri" and an "eki."  (Image, ramdisk, and kernel)  The emi is the one we use to launch instances, so take note of this.
+
+Create a keypair to SSH to the server:
+
+::
+
+    euca-add-keypair mykey > mykey.priv
+
+    chmod 0600 mykey.priv
+
+Boot your instance:
+
+::
+
+    euca-run-instances $emi -k mykey -t m1.tiny 
+
+($emi is replaced with the output from the previous command)
+
+Checking status, and confirming communication:
+
+Once you have booted the instance, you can check the status the the `euca-describe-instances` command.  Here you can view the instance ID, IP, and current status of the VM.  
+
+::
+
+    euca-describe-instances
+
+Once in a "running" state, you can use your SSH key connect:
+
+::
+
+    ssh -i mykey.priv root@$ipaddress
+
+When you are ready to terminate the instance, you may do so with the `euca-terminate-instances` command:
+
+::
+
+    euca-terminate-instances $instance-id
+
+You can determine the instance-id with `euca-describe-instances`, and the format is "i-" with a series of letter and numbers following:  e.g. i-a4g9d.
+
+For more information in creating you own custom (production ready) instance images, please visit http://wiki.openstack.org/GettingImages for more information!
+
 Enjoy your new private cloud, and play responsibly!
 
diff --git a/doc/source/api/nova..api.cloud.rst b/doc/source/api/nova..api.cloud.rst
deleted file mode 100644
index 413840185..000000000
--- a/doc/source/api/nova..api.cloud.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..api.cloud` Module
-==============================================================================
-.. automodule:: nova..api.cloud
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..api.ec2.images.rst b/doc/source/api/nova..api.ec2.images.rst
deleted file mode 100644
index 012d800e4..000000000
--- a/doc/source/api/nova..api.ec2.images.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..api.ec2.images` Module
-==============================================================================
-.. automodule:: nova..api.ec2.images
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..process.rst b/doc/source/api/nova..process.rst
deleted file mode 100644
index 91eff8379..000000000
--- a/doc/source/api/nova..process.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..process` Module
-==============================================================================
-.. automodule:: nova..process
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..server.rst b/doc/source/api/nova..server.rst
deleted file mode 100644
index 7cb2cfa54..000000000
--- a/doc/source/api/nova..server.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..server` Module
-==============================================================================
-.. automodule:: nova..server
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.access_unittest.rst b/doc/source/api/nova..tests.access_unittest.rst
deleted file mode 100644
index 89554e430..000000000
--- a/doc/source/api/nova..tests.access_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.access_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.access_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.api_integration.rst b/doc/source/api/nova..tests.api_integration.rst
deleted file mode 100644
index fd217acf7..000000000
--- a/doc/source/api/nova..tests.api_integration.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.api_integration` Module
-==============================================================================
-.. automodule:: nova..tests.api_integration
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.api_unittest.rst b/doc/source/api/nova..tests.api_unittest.rst
deleted file mode 100644
index 44a65d48c..000000000
--- a/doc/source/api/nova..tests.api_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.api_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.api_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.auth_unittest.rst b/doc/source/api/nova..tests.auth_unittest.rst
deleted file mode 100644
index 5805dcf38..000000000
--- a/doc/source/api/nova..tests.auth_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.auth_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.auth_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.cloud_unittest.rst b/doc/source/api/nova..tests.cloud_unittest.rst
deleted file mode 100644
index d2ca3b013..000000000
--- a/doc/source/api/nova..tests.cloud_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.cloud_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.cloud_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.compute_unittest.rst b/doc/source/api/nova..tests.compute_unittest.rst
deleted file mode 100644
index 6a30bf744..000000000
--- a/doc/source/api/nova..tests.compute_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.compute_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.compute_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.flags_unittest.rst b/doc/source/api/nova..tests.flags_unittest.rst
deleted file mode 100644
index 61087e683..000000000
--- a/doc/source/api/nova..tests.flags_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.flags_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.flags_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.network_unittest.rst b/doc/source/api/nova..tests.network_unittest.rst
deleted file mode 100644
index df057d813..000000000
--- a/doc/source/api/nova..tests.network_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.network_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.network_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.process_unittest.rst b/doc/source/api/nova..tests.process_unittest.rst
deleted file mode 100644
index 30d1e129c..000000000
--- a/doc/source/api/nova..tests.process_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.process_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.process_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.quota_unittest.rst b/doc/source/api/nova..tests.quota_unittest.rst
deleted file mode 100644
index 6ab813104..000000000
--- a/doc/source/api/nova..tests.quota_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.quota_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.quota_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.rpc_unittest.rst b/doc/source/api/nova..tests.rpc_unittest.rst
deleted file mode 100644
index e6c7ceb2e..000000000
--- a/doc/source/api/nova..tests.rpc_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.rpc_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.rpc_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.scheduler_unittest.rst b/doc/source/api/nova..tests.scheduler_unittest.rst
deleted file mode 100644
index ae3a06616..000000000
--- a/doc/source/api/nova..tests.scheduler_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.scheduler_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.scheduler_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.service_unittest.rst b/doc/source/api/nova..tests.service_unittest.rst
deleted file mode 100644
index c7c746d17..000000000
--- a/doc/source/api/nova..tests.service_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.service_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.service_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.twistd_unittest.rst b/doc/source/api/nova..tests.twistd_unittest.rst
deleted file mode 100644
index ce88202e1..000000000
--- a/doc/source/api/nova..tests.twistd_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.twistd_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.twistd_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.validator_unittest.rst b/doc/source/api/nova..tests.validator_unittest.rst
deleted file mode 100644
index 980284327..000000000
--- a/doc/source/api/nova..tests.validator_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.validator_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.validator_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.virt_unittest.rst b/doc/source/api/nova..tests.virt_unittest.rst
deleted file mode 100644
index 2189be41e..000000000
--- a/doc/source/api/nova..tests.virt_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.virt_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.virt_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..tests.volume_unittest.rst b/doc/source/api/nova..tests.volume_unittest.rst
deleted file mode 100644
index 791e192f5..000000000
--- a/doc/source/api/nova..tests.volume_unittest.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..tests.volume_unittest` Module
-==============================================================================
-.. automodule:: nova..tests.volume_unittest
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..validate.rst b/doc/source/api/nova..validate.rst
deleted file mode 100644
index 1d142f103..000000000
--- a/doc/source/api/nova..validate.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..validate` Module
-==============================================================================
-.. automodule:: nova..validate
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/api/nova..virt.xenapi.rst b/doc/source/api/nova..virt.xenapi.rst
deleted file mode 100644
index 2e396bf06..000000000
--- a/doc/source/api/nova..virt.xenapi.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-The :mod:`nova..virt.xenapi` Module
-==============================================================================
-.. automodule:: nova..virt.xenapi
-  :members:
-  :undoc-members:
-  :show-inheritance:
diff --git a/doc/source/cloud101.rst b/doc/source/cloud101.rst
index 864cdda9b..2406e0056 100644
--- a/doc/source/cloud101.rst
+++ b/doc/source/cloud101.rst
@@ -54,7 +54,7 @@ Cloud computing offers different service models depending on the capabilities a
 The US-based National Institute of Standards and Technology offers definitions for cloud computing
 and the service models that are emerging. 
 
-These definitions are summarized from http://csrc.nist.gov/groups/SNS/cloud-computing/.
+These definitions are summarized from the `U.S. National Institute of Standards and Technology (NIST) cloud computing research group <http://csrc.nist.gov/groups/SNS/cloud-computing/>`_.
 
 SaaS - Software as a Service
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -74,7 +74,6 @@ IaaS - Infrastructure as a Service
 Provides infrastructure such as computer instances, network connections, and storage so that people 
 can run any software or operating system.
 
-
 Types of Cloud Deployments
 --------------------------