Fixing formatting problems with multinode install document

1 files changed, 56 insertions, 73 deletions

diff --git a/doc/source/adminguide/multi.node.install.rst b/doc/source/adminguide/multi.node.install.rst
index 2b1942282..64286f6ec 100644
--- a/doc/source/adminguide/multi.node.install.rst
+++ b/doc/source/adminguide/multi.node.install.rst
@@ -17,7 +17,6 @@
       under the License.
 
 Installing Nova on Multiple Servers
-
 ===================================
  
 When you move beyond evaluating the technology and into building an actual
@@ -83,33 +82,34 @@ Step 2 Setup configuration file (installed in /etc/nova)
 --state_path=/var/lib/nova
  
 The following items ALSO need to be defined in /etc/nova/nova.conf.  I’ve added some explanation of the variables, as comments CANNOT be in nova.conf.  There seems to be an issue with nova-manage not processing the comments/whitespace correctly:
- 
---sql_connection  ###  Location of Nova SQL DB
- 
+
+--sql_connection ###  Location of Nova SQL DB
+
 --s3_host ###  This is where Nova is hosting the objectstore service, which will contain the VM images and buckets
- 
+
 --rabbit_host ### This is where the rabbit AMQP messaging service is hosted
 
 --cc_host ### This is where the the nova-api service lives
- 
---verbose   ###  Optional but very helpful during initial setup
- 
+
+--verbose ###  Optional but very helpful during initial setup
+
 --ec2_url ### The location to interface nova-api
- 
+
 --network_manager ### Many options here, discussed below.  This is how your controller will communicate with additional Nova nodes and VMs:
- 
-nova.network.manager.FlatManager  # Simple, no-vlan networking type
+
+nova.network.manager.FlatManager # Simple, no-vlan networking type
 nova.network.manager. FlatDHCPManager #  Flat networking with DHCP
 nova.network.manager.VlanManager # Vlan networking with DHCP – /DEFAULT/ if no network manager is defined in nova.conf
- 
---fixed_range=<network/prefix>   ###  This will be the IP network that ALL the projects for future VM guests will reside on.  E.g. 192.168.0.0/12
- 
---network_size=<# of addrs>      ### This is the total number of IP Addrs to use for VM guests, of all projects.  E.g. 5000
- 
+
+--fixed_range=<network/prefix> ###  This will be the IP network that ALL the projects for future VM guests will reside on.  E.g. 192.168.0.0/12
+
+--network_size=<# of addrs> ### This is the total number of IP Addrs to use for VM guests, of all projects.  E.g. 5000
+
 The following code can be cut and paste, and edited to your setup:
 
-## Note: CC_ADDR=<the external IP address of your cloud controller>##
-## Detailed explanation of the following entries are right above this ##
+Note: CC_ADDR=<the external IP address of your cloud controller>
+
+Detailed explanation of the following example is available above.
  
 ::
  
@@ -123,23 +123,20 @@ The following code can be cut and paste, and edited to your setup:
 --fixed_range=<network/prefix>
 --network_size=<# of addrs>     
  
-2. Create a “nova” group, and set permissions:
- 
-::
+2. Create a “nova” group, and set permissions::
+
     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.
- 
-::
+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
  
 Step 3 - Setup the SQL DB (MySQL for this setup)
 ------------------------------------------------
  
-1. First you 'preseed' to bypass all the installation prompts
+1. First you 'preseed' to bypass all the installation prompts::
 
-::
     bash
     MYSQL_PASS=nova
     cat <<MYSQL_PRESEED | debconf-set-selections
@@ -148,14 +145,12 @@ Step 3 - Setup the SQL DB (MySQL for this setup)
     mysql-server-5.1 mysql-server/start_on_boot boolean true
     MYSQL_PRESEED
  
-2. Install MySQL:
+2. Install MySQL::
  
-::
     apt-get install -y mysql-server
  
-3. Edit /etc/mysql/my.cnf to change ‘bind-address’ from localhost to any:
- 
-::
+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
  
@@ -163,9 +158,8 @@ Step 3 - Setup the SQL DB (MySQL for this setup)
  
 If you use FlatManager (as opposed to VlanManager that we set) as your network manager, there are some additional networking changes you’ll have to make to ensure connectivity between your nodes and VMs.  If you chose VlanManager or FlatDHCP, you may skip this section, as it’s set up for you automatically.
  
-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
- 
-::
+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
@@ -187,27 +181,23 @@ Next, restart networking to apply the changes::
 
 4. MySQL DB configuration:
  
-Create NOVA database:  
- 
-::
+Create NOVA database::
+
     mysql -uroot -p$MYSQL_PASS -e 'CREATE DATABASE nova;'
  
- 
-Update the DB to include user 'root'@'%' with super user privileges
- 
-::
+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;"
  
-Set mySQL root password
- 
-::
+Set mySQL root password::
+
     mysql -uroot -p$MYSQL_PASS -e "SET PASSWORD FOR 'root'@'%' = PASSWORD('$MYSQL_PASS');"
  
- 
 Step 4 - Setup Nova environment
 -------------------------------
- 
-::
+
+These are the commands you run to set up a user and 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>
@@ -225,18 +215,20 @@ Note: The nova-manage service assumes that the first IP address is your network
 On running this command, entries are made in the 'networks' and 'fixed_ips' table. However, one of the networks listed in the 'networks' table needs to be marked as bridge in order for the code to know that a bridge exists. The Network is marked as bridged automatically based on the type of network manager selected.  This is ONLY necessary if you chose FlatManager as your network type.  More information can be found at the end of this document discussing setting up the bridge device.
  
  
-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:
+Step 5 - Create Nova certifications
+-----------------------------------
  
+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
  
-2.  Unzip them in your home directory, and add them to your environment:
- 
+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
@@ -244,25 +236,19 @@ Step 5 - Create Nova certs
 Step 6 - Restart all relevant services
 --------------------------------------
 
-Restart all six services in total, just to cover the entire spectrum:
- 
-::
+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
 
-Step 7 - Closing steps, and cleaning up:
-----------------------------------------
+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:
-
-::
+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
 
-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:
-
-::
+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
@@ -270,23 +256,20 @@ Another common issue is you cannot ping or SSH your instances after issusing the
 Step 8 – Testing the installation
 ---------------------------------
 
-You can then use `euca2ools` to test some items:
- 
-::
+You can then use `euca2ools` to test some items::
 
     euca-describe-images
     euca-describe-instances
  
-If you have issues with the API key, you may need to re-source your creds file:
- 
-::
+If you have issues with the API key, you may need to re-source your creds file::
 
     . /root/creds/novarc
  
 If you don’t get any immediate errors, you’re successfully making calls to your cloud!
- 
-Step 9 -- Spinning up a VM for testing 
---------------------------------------
+
+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.