summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAnne Gentle <anne@openstack.org>2010-12-07 16:48:42 -0600
committerAnne Gentle <anne@openstack.org>2010-12-07 16:48:42 -0600
commitd647d6b070e0a910a9f20cfc1106027c86858f30 (patch)
tree2f86f533e5e88d1a3586462861b7aa27dc7ac77f /doc
parenta1b28afb30026be1e8c545b45c14fd94f5403c10 (diff)
downloadnova-d647d6b070e0a910a9f20cfc1106027c86858f30.tar.gz
nova-d647d6b070e0a910a9f20cfc1106027c86858f30.tar.xz
nova-d647d6b070e0a910a9f20cfc1106027c86858f30.zip
Added livecd instructions plus fixed references to .conf files
Diffstat (limited to 'doc')
-rw-r--r--doc/source/adminguide/managing.networks.rst2
-rw-r--r--doc/source/adminguide/multi.node.install.rst27
-rw-r--r--doc/source/adminguide/single.node.install.rst4
-rw-r--r--doc/source/cloud101.rst9
-rw-r--r--doc/source/images/novascreens.pngbin0 -> 27949 bytes
-rw-r--r--doc/source/images/novashvirtually.pngbin0 -> 39000 bytes
-rw-r--r--doc/source/index.rst2
-rw-r--r--doc/source/livecd.rst46
8 files changed, 62 insertions, 28 deletions
diff --git a/doc/source/adminguide/managing.networks.rst b/doc/source/adminguide/managing.networks.rst
index b8563637e..38c1cba78 100644
--- a/doc/source/adminguide/managing.networks.rst
+++ b/doc/source/adminguide/managing.networks.rst
@@ -23,7 +23,7 @@ In Nova, users organize their cloud resources in projects. A Nova project consis
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:
diff --git a/doc/source/adminguide/multi.node.install.rst b/doc/source/adminguide/multi.node.install.rst
index 1eed30c5b..3b06d7d91 100644
--- a/doc/source/adminguide/multi.node.install.rst
+++ b/doc/source/adminguide/multi.node.install.rst
@@ -35,7 +35,6 @@ Requirements for a multi-node installation
* 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 @@ Step 1 Use apt-get to get the latest code
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,17 @@ Note: CC_ADDR=<the external IP address of your cloud controller>
--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
-
-::
+#. 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 +106,7 @@ Config files should be have their owner set to root:nova, and mode set to 0640,
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.
::
diff --git a/doc/source/adminguide/single.node.install.rst b/doc/source/adminguide/single.node.install.rst
index f6b2290bc..8572c5a4a 100644
--- a/doc/source/adminguide/single.node.install.rst
+++ b/doc/source/adminguide/single.node.install.rst
@@ -9,7 +9,7 @@ The fastest way to get a test cloud running is through our :doc:`../quickstart`.
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 @@ Type or copy/paste the following to source the novarc file in your current worki
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.
diff --git a/doc/source/cloud101.rst b/doc/source/cloud101.rst
index 87db5af1e..7c79d2a70 100644
--- a/doc/source/cloud101.rst
+++ b/doc/source/cloud101.rst
@@ -54,6 +54,8 @@ 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/.
+
SaaS - Software as a Service
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -72,12 +74,15 @@ 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.
-.. 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
------------------
diff --git a/doc/source/images/novascreens.png b/doc/source/images/novascreens.png
new file mode 100644
index 000000000..0fe3279cf
--- /dev/null
+++ b/doc/source/images/novascreens.png
Binary files differ
diff --git a/doc/source/images/novashvirtually.png b/doc/source/images/novashvirtually.png
new file mode 100644
index 000000000..02c7e767c
--- /dev/null
+++ b/doc/source/images/novashvirtually.png
Binary files differ
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9b2c8e1f8..dd01b2060 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -62,8 +62,6 @@ Administrator's Documentation
adminguide/single.node.install
adminguide/multi.node.install
-.. todo:: add swiftadmin
-
Developer Docs
==============
diff --git a/doc/source/livecd.rst b/doc/source/livecd.rst
index 82cf4658a..b355fa180 100644
--- a/doc/source/livecd.rst
+++ b/doc/source/livecd.rst
@@ -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
+