Nova quickstart: move vish's novascript into contrib, and convert reademe.md to a quickstart.rst

1 files changed, 77 insertions, 2 deletions

diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
index 7a41d4be6..91e3c9ccb 100644
--- a/doc/source/quickstart.rst
+++ b/doc/source/quickstart.rst
@@ -16,6 +16,81 @@
       under the License.
 
 Nova Quickstart
-=========================
+===============
 
-http://github.com/vishvananda/novascript
+The `contrib/novascript.sh` file in the source distribution is a script that
+will quickly set up nova to run on a single machine.  It is tested against
+Ubuntu only, but other distributions are forthcoming.
+
+Usage
+-----
+
+Unless you want to spend a lot of time fiddling with permissions and sudoers,
+you should probably run nova as root.
+
+::
+
+    sudo -i
+
+If you are concerned about security, nova runs just fine inside a virtual
+machine.
+
+Use the script to install and run the current trunk. You can also specify a
+specific branch by putting `lp:~someone/nova/some-branch` after the branch
+command
+
+::
+
+    ./nova.sh branch
+    ./nova.sh install
+    ./nova.sh run
+
+The run command will drop you into a screen session with all of the workers
+running in different windows  You can use eucatools to run commands against the
+cloud.
+
+::
+
+    euca-add-keypair test > test.pem
+    euca-run-instances -k test -t m1.tiny ami-tiny
+    euca-describe-instances
+
+To see output from the various workers, switch screen windows
+
+::
+
+    <ctrl-a> "
+
+will give you a list of running windows.
+
+When the instance is running, you should be able to ssh to it.
+
+::
+
+    chmod 600 test.pem
+    ssh -i test.pem root@10.0.0.3
+
+When you exit screen
+
+::
+
+    <ctrl-a> <ctrl-d>
+
+nova will terminate.  It may take a while for nova to finish cleaning up.  If
+you exit the process before it is done because there were some problems in your
+build, you may have to clean up the nova processes manually.  If you had any
+instances running, you can attempt to kill them through the api:
+
+::
+
+    ./nova.sh terminate
+
+Then you can destroy the screen:
+
+::
+
+    ./nova.sh clean
+
+If things get particularly messed up, you might need to do some more intense
+cleanup.  Be careful, the following command will manually destroy all runnning
+virsh instances and attempt to delete all vlans and bridges.