Merge lp:~annegentle/nova/installdoc into lp:~hudson-openstack/nova/trunk

[Anne Gentle]

Added LiveCD info as well as some changes to reflect consolidation of .conf files.

[Soren Hansen (soren)]

2010/12/7 Anne Gentle <email address hidden>:
> === modified file 'doc/source/adminguide/multi.node.install.rst'
> --- doc/source/adminguide/multi.node.install.rst        2010-12-02 19:48:39 +0000
> +++ doc/source/adminguide/multi.node.install.rst        2010-12-07 22:51:58 +0000
[...]
> -4. Create a nova group
> -
> -::
> +   --fixed_range=<network/prefix>   # ip network to use for VM guests, ex 192.168.2.64/26
> +   --network_size=<# of addrs>      # number of ip addrs to use for VM guests, ex 64
> +
> +   --fixed_range=<network/prefix>   # ip network to use for VM guests, ex 192.168.2.64/26
> +   --network_size=<# of addrs>      # number of ip addrs to use for VM guests, ex 64
> +

I think specifying these once is sufficient :)

--
Soren Hansen
Ubuntu Developer    http://www.ubuntu.com/
OpenStack Developer http://www.openstack.org/

[Anne Gentle (annegentle)]

Heh. Yes. :)

[lp:~annegentle/nova/installdoc]

448. By Anne Gentle on 2010-12-08

removing extraneous config ilnes

[Jonathan Bryce (jbryce)]

looks good now

review: Approve

[lp:~annegentle/nova/installdoc]

449. By Anne Gentle on 2010-12-10

Fixed spelling errors in index.rst

[Soren Hansen (soren)]

Looks great!

review: Approve

[Eric Day (eday)]

lgtm!

review: Approve

=== modified file 'doc/source/adminguide/managing.networks.rst'
--- doc/source/adminguide/managing.networks.rst	2010-11-22 22:43:17 +0000
+++ doc/source/adminguide/managing.networks.rst	2010-12-10 22:07:11 +0000
@@ -23,7 +23,7 @@
 Nova Network Strategies
 -----------------------
 
-Currently, Nova supports three kinds of networks, implemented in three "Network Manager" types respectively: Flat Network Manager, Flat DHCP Network Manager, and VLAN Network Manager. The three kinds of networks can c-exist in a cloud system. However, the scheduler for selecting the type of network for a given project is not yet implemented. Here is a brief description of each of the different network strategies, with a focus on the VLAN Manager in a separate section. 
+Currently, Nova supports three kinds of networks, implemented in three "Network Manager" types respectively: Flat Network Manager, Flat DHCP Network Manager, and VLAN Network Manager. The three kinds of networks can co-exist in a cloud system. However, the scheduler for selecting the type of network for a given project is not yet implemented. Here is a brief description of each of the different network strategies, with a focus on the VLAN Manager in a separate section. 
 
 Read more about Nova network strategies here:
 

=== modified file 'doc/source/adminguide/multi.node.install.rst'
--- doc/source/adminguide/multi.node.install.rst	2010-12-02 19:48:39 +0000
+++ doc/source/adminguide/multi.node.install.rst	2010-12-10 22:07:11 +0000
@@ -35,7 +35,6 @@
 * For a recommended HA setup, consider a MySQL master/slave replication, with as many slaves as you like, and probably a heartbeat to kick one of the slaves into being a master if it dies.
 * For performance optimization, split reads and writes to the database. MySQL proxy is the easiest way to make this work if running MySQL.
 
-
 Assumptions
 ^^^^^^^^^^^
 
@@ -69,14 +68,14 @@
 
 It is highly likely that there will be errors when the nova services come up since they are not yet configured. Don't worry, you're only at step 1!
 
-Step 2 Setup configuration files (installed in /etc/nova)
+Step 2 Setup configuration file (installed in /etc/nova)
 ---------------------------------------------------------
 
 Note: CC_ADDR=<the external IP address of your cloud controller>
 
-1. These need to be defined in EACH configuration file
+Nova development has consolidated all .conf files to nova.conf as of November 2010. References to specific .conf files may be ignored.
 
-::
+#. These need to be defined in the nova.conf configuration file::
 
    --sql_connection=mysql://root:nova@$CC_ADDR/nova # location of nova sql db
    --s3_host=$CC_ADDR  # This is where nova is hosting the objectstore service, which
@@ -87,31 +86,14 @@
    --ec2_url=http://$CC_ADDR:8773/services/Cloud
    --network_manager=nova.network.manager.FlatManager # simple, no-vlan networking type
 
-
-2. nova-manage specific flags
-
-::
-
-   --fixed_range=<network/prefix>   # ip network to use for VM guests, ex 192.168.2.64/26
-   --network_size=<# of addrs>      # number of ip addrs to use for VM guests, ex 64
-
-
-3. nova-network specific flags
-
-::
-
-   --fixed_range=<network/prefix>   # ip network to use for VM guests, ex 192.168.2.64/26
-   --network_size=<# of addrs>      # number of ip addrs to use for VM guests, ex 64
-
-4. Create a nova group
-
-::
+   --fixed_range=<network/prefix>   # ip network to use for VM guests, ex 192.168.2.64/26
+   --network_size=<# of addrs>      # number of ip addrs to use for VM guests, ex 64
+
+#. Create a nova group::
 
    sudo addgroup nova
 
-5. nova-objectstore specific flags < no specific config needed >
-
-Config files should be have their owner set to root:nova, and mode set to 0640, 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 0640, since they contain your MySQL server's root password.
 
 ::
 
@@ -121,7 +103,7 @@
 Step 3 Setup the sql db
 -----------------------
 
-1. First you 'preseed' (using vishy's :doc:`../quickstart`). Run this as root.
+1. First you 'preseed' (using the Quick Start method :doc:`../quickstart`). Run this as root.
 
 ::
 

=== modified file 'doc/source/adminguide/single.node.install.rst'
--- doc/source/adminguide/single.node.install.rst	2010-12-02 19:48:39 +0000
+++ doc/source/adminguide/single.node.install.rst	2010-12-10 22:07:11 +0000
@@ -9,7 +9,7 @@
 Step 1 and 2: Get the latest Nova code system software
 ------------------------------------------------------
 
-Depending on your system, the mehod for accomplishing this varies
+Depending on your system, the method for accomplishing this varies
 
 .. toctree::
    :maxdepth: 1
@@ -139,7 +139,7 @@
 
 Step 9: Pat yourself on the back :)
 -----------------------------------
-Congratulations, your cloud is up and running, you’ve created an admin user, retrieved the user's credentials and put them in your environment.
+Congratulations, your cloud is up and running, you’ve created an admin user, created a network, retrieved the user's credentials and put them in your environment.
 
 Now you need an image.
 

=== modified file 'doc/source/cloud101.rst'
--- doc/source/cloud101.rst	2010-11-11 22:32:24 +0000
+++ doc/source/cloud101.rst	2010-12-10 22:07:11 +0000
@@ -54,6 +54,8 @@
 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/.
+
 SaaS - Software as a Service
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -72,12 +74,15 @@
 Provides infrastructure such as computer instances, network connections, and storage so that people 
 can run any software or operating system.
 
-.. todo:: Use definitions from http://csrc.nist.gov/groups/SNS/cloud-computing/ and attribute NIST
 
 Types of Cloud Deployments
 --------------------------
-.. todo:: describe public/private/hybrid/etc
-
+
+When you hear terms such as public cloud or private cloud, these refer to the deployment model for the cloud. A private cloud operates for a single organization, but can be managed on-premise or off-premise. A public cloud has an infrastructure that is available to the general public or a large industry group and is likely owned by a cloud services company. 
+
+The NIST also defines community cloud as shared by several organizations supporting a specific community with shared concerns. 
+
+A hybrid cloud can be a deployment model, as a composition of both public and private clouds, or a hybrid model for cloud computing may involve both virtual and physical servers.
 
 Work in the Clouds
 ------------------

=== added file 'doc/source/images/novascreens.png'
Binary files doc/source/images/novascreens.png	1970-01-01 00:00:00 +0000 and doc/source/images/novascreens.png	2010-12-10 22:07:11 +0000 differ
=== added file 'doc/source/images/novashvirtually.png'
Binary files doc/source/images/novashvirtually.png	1970-01-01 00:00:00 +0000 and doc/source/images/novashvirtually.png	2010-12-10 22:07:11 +0000 differ
=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2010-11-11 19:43:32 +0000
+++ doc/source/index.rst	2010-12-10 22:07:11 +0000
@@ -26,7 +26,7 @@
 
 * **Component based architecture**: Quickly add new behaviors
 * **Highly available**: Scale to very serious workloads
-* **Fault-Tollerant**: Isloated processes avoid cascading failures
+* **Fault-Tolerant**: Isolated 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
 * **API Compatibility**: Nova strives to provide API-compatible with popular systems like Amazon EC2
@@ -62,8 +62,6 @@
    adminguide/single.node.install
    adminguide/multi.node.install
 
-.. todo:: add swiftadmin
-
 Developer Docs
 ==============
 

=== modified file 'doc/source/livecd.rst'
--- doc/source/livecd.rst	2010-11-11 19:07:47 +0000
+++ doc/source/livecd.rst	2010-12-10 22:07:11 +0000
@@ -1,2 +1,48 @@
 Installing the Live CD
 ======================
+
+If you'd like to set up a sandbox installation of Nova, you can use one of these Live CD images. 
+
+If you don't already have VirtualBox installed, you can download it from http://www.virtualbox.org/wiki/Downloads.
+ 
+Download the zip or iso file and then follow these steps to try Nova in a virtual environment.
+
+http://c0047913.cdn1.cloudfiles.rackspacecloud.com/OpenStackNova.x86_64-2010.1.2.iso (OpenSUSE image; root password is "linux" for this image)
+
+http://c0028699.cdn1.cloudfiles.rackspacecloud.com/nova-vm.zip (~900 MB) (log in information is nova/nova)
+
+Once a VM is configured and started, here are the basics:
+
+ #. Login to Ubuntu using ID nova and Password nova.
+
+ #. Switch to running as sudo (enter nova when prompted for the password)::
+
+    sudo -s
+
+ #. To run Nova for the first time, enter::
+
+    cd /var/openstack/
+
+ #. Now that you're in the correct directory, enter::
+
+    ./nova.sh run
+
+    .. image:: images/novashvirtually.png
+
+If it's already running, use screen -ls, and when the nova screen is presented,then enter screen -d -r nova.
+
+These are the steps to get an instance running (the image is already provided in this environment). Enter these commands in the "test" screen.
+
+::
+
+ euca-add-keypair test > test.pem
+ chmod 600 test.pem
+ euca-run-instances -k test -t m1.tiny ami-tiny
+ euca-describe-instances
+
+ ssh -i test.pem root@10.0.0.3
+
+To see output from the various workers, switch screen windows with Ctrl+A " (quotation mark). 
+
+    .. image:: images/novascreens.png 
+