Installation Guide

Populate the installation guide

Change-Id: I271ee6d5a38195aaf95a9c821bee8049470d674f
JIRA: DOCS-124
Signed-off-by: mbeierl <mark.beierl@emc.com>

1 files changed, 117 insertions, 0 deletions

diff --git a/docs/userguide/installation.rst b/docs/userguide/installation.rst
new file mode 100755
index 0000000..0cdd9ee
--- /dev/null
+++ b/docs/userguide/installation.rst
@@ -0,0 +1,117 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+===========================
+StorPerf Installation Guide
+===========================
+
+OpenStack Prerequisites
+===========================
+If you do not have an Ubuntu 14.04 image in Glance, you will need to add one.
+A key pair for launching agents is also required.
+
+.. code-block:: console
+
+    # Put an Ubuntu Image in glance
+    wget https://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img
+    glance image-create --name 'Ubuntu 14.04' --visibility public --disk-format=qcow2 --container-format=bare --file=trusty-server-cloudimg-amd64-disk1.img
+
+    # Create a key pair for the agents.
+    nova keypair-add StorPerf > StorPerf.pem
+
+    # Or, if you have access to the StorPerf repository you may import the StorPerf key
+    nova keypair-add --pub_key storperf_rsa.pub StorPerf
+
+
+Planning
+===========================
+
+StorPerf is delivered as a `Docker container
+<https://hub.docker.com/r/opnfv/storperf/tags/>`__.  There are two possible
+methods for installation in your environment:
+   1. Run container on Jump Host
+   2. Run container in a VM
+
+
+Running StorPerf on Jump Host
+=============================
+
+Requirements:
+
+    * Docker must be installed
+    * Jump Host must have access to the OpenStack Controller API
+    * Jump Host must have internet connectivity for downloading docker image
+    * Enough floating IPs must be available to match your agent count
+
+Running StorPerf in a VM
+========================
+
+Requirements:
+
+    * VM has docker installed
+    * VM has OpenStack Controller credentials and can communicate with the Controller API
+    * VM has internet connectivity for downloading the docker image
+    * Enough floating IPs must be available to match your agent count
+
+VM Creation
+~~~~~~~~~~~
+
+The following procedure will create the VM in your environment
+
+.. code-block:: console
+
+    # Create the StorPerf VM itself.  Here we use the network ID generated by OPNFV FUEL.
+    ADMIN_NET_ID=`neutron net-list | grep 'admin_internal_net ' | awk '{print $2}'`
+
+    nova boot --nic net-id=$ADMIN_NET_ID --flavor m1.small --key-name=StorPerf --image 'Ubuntu 14.04' 'StorPerf Master'
+
+At this point, you may associate a floating IP with the StorPerf master VM.
+
+VM Docker Installation
+~~~~~~~~~~~~~~~~~~~~~~
+
+The following procedure will install Docker on Ubuntu 14.04.
+
+.. code-block:: console
+
+    sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
+    cat << EOF | sudo tee /etc/apt/sources.list.d/docker.list
+    deb https://apt.dockerproject.org/repo ubuntu-trusty main
+    EOF
+
+    sudo apt-get update
+    sudo apt-get install -y docker-engine
+    sudo usermod -aG docker ubuntu
+
+Pulling StorPerf Container
+==========================
+
+Colorado
+~~~~~~~~
+
+The tag for the latest stable Colorado release is:
+
+.. code-block: console
+
+    docker pull opnfv/storperf:colorado.0.1
+
+Brahmaputra
+~~~~~~~~~~~
+
+The tag for the latest stable Brahmaputra release is:
+
+.. code-block: console
+
+    docker pull opnfv/storperf:brahmaputra.1.2
+
+Development
+~~~~~~~~~~~
+
+The tag for the latest development version is:
+
+.. code-block: console
+
+    docker pull opnfv/storperf:master
+
+