Adds Volume Count and Dynamic Reloadopnfv-6.1.0

Adds a volume_count parameter that allows the user to
change the number of volumes.  Test execution still
uses each volume specified and appends it to the host
ip address in the graphite metrics.

Changes the cache policy of the stack from SNAPS-OO
so that changes made to the stack are refelcted in
StorPerf.

Fixes the documentation path and updates the docs
for the above changes.

Change-Id: I5b9160b469e80d4f7d6906ac270bb3b75411fb5a
JIRA: STORPERF-242
Signed-off-by: mbeierl <mark.beierl@dell.com>
(cherry picked from commit 1942e374fba718d1d4b6bc5388803c75e71aa197)

2 files changed, 131 insertions, 53 deletions

diff --git a/docs/testing/user/installation.rst b/docs/testing/user/installation.rst
index 046da42..b3f0e91 100755
--- a/docs/testing/user/installation.rst
+++ b/docs/testing/user/installation.rst
@@ -78,8 +78,8 @@ Planning
 StorPerf is delivered as a series of Docker containers managed by
 docker-compose.  There are two possible methods for installation:
 
-#. Run container on bare metal
-#. Run container in a VM
+#. Run the containers on bare metal
+#. Run the containers in a VM
 
 Requirements:
 
@@ -142,7 +142,7 @@ which should result in:
 
 .. code-block:: console
 
-     968c0c2d7c0e24f6777c33b37d9b4fd885575155069fb760405ec8214b2eb672  docker-compose.yaml
+    69856e9788bec36308a25303ec9154ed68562e126788a47d54641d68ad22c8b9  docker-compose.yaml
 
 To run, you must specify two environment variables:
 
@@ -175,7 +175,7 @@ which should result in:
 
 .. code-block:: console
 
-     00649e02237d27bf0b40d1a66160a68a56c9f5e1ceb78d7858e30715cf4350e3  create-compose.py
+     327cad2a7b3a3ca37910978005c743799313c2b90709e4a3f142286a06e53f57  create-compose.py
 
 Note: The script will run fine on python3. Install python future package to avoid error on python2.
 
@@ -187,79 +187,123 @@ Note: The script will run fine on python3. Install python future package to avoi
 Docker Exec
 ~~~~~~~~~~~
 
-If needed, the container can be entered with docker exec.  This is not normally
+If needed, any StorPerf container can be entered with docker exec.  This is not normally
 required.
 
 .. code-block:: console
 
-    docker exec -it storperf-master bash
+    docker exec -it storperf-master /bin/bash
 
 
 
-Pulling StorPerf Container
-==========================
+Pulling StorPerf Containers
+===========================
 
-Master (Euphrates)
-~~~~~~~~~~~~~~~~~~
+The tags for StorPerf can be found here: https://hub.docker.com/r/opnfv/storperf-master/tags/
 
-StorPerf has switched to docker-compose in the latest version.  The tag for
-pulling the latest master Euphrates container is:
+Master (latest)
+~~~~~~~~~~~~~~~
 
-.. code-block:: bash
+This tag represents  StorPerf at its most current state of development.  While
+self-tests have been run, there is not a guarantee that all features will be
+functional, or there may be bugs.
 
-   docker pull opnfv/storperf-master:latest
-   docker pull opnfv/storperf-reporting:latest
-   docker pull opnfv/storperf-httpfrontend:latest
-   docker pull opnfv/storperf-swaggerui:latest
-   docker pull opnfv/storperf-graphite:latest
+Documentation for latest can be found using the latest label at:
 
-However, by itself, this will no longer provide full functionality.  Full
-instructions are provided in the Running StorPerf Container section of this
-document.
+http://docs.opnfv.org/en/latest/submodules/storperf/docs/testing/user/index.html
 
+For x86_64 based systems, use:
 
-Danube
-~~~~~~
+.. code-block:: console
 
-The tag for the latest stable Danube is be:
+    TAG=x86_64-latest ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=x86_64-latest ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
 
-.. code-block:: bash
+For 64 bit ARM based systems, use:
 
-   docker pull opnfv/storperf:danube.3.0
+.. code-block:: console
 
-Colorado
-~~~~~~~~
+    TAG=aarch64-latest ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=aarch64-latest ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
 
-The tag for the latest stable Colorado release is:
 
-.. code-block:: bash
+Release (stable)
+~~~~~~~~~~~~~~~~
 
-   docker pull opnfv/storperf:colorado.0.1
+This tag represents StorPerf at its most recent stable release.  There are
+no known bugs and known issues and workarounds are documented in the release
+notes.  Issues found here should be reported in JIRA:
 
-Brahmaputra
-~~~~~~~~~~~
+https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=3
 
-The tag for the latest stable Brahmaputra release is:
+For x86_64 based systems, use:
 
-.. code-block:: bash
+.. code-block:: console
 
-   docker pull opnfv/storperf:brahmaputra.1.2
+    TAG=x86_64-stable ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=x86_64-stable ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
 
-StorPerf on ARM Processors
-==========================
+For 64 bit ARM based systems, use:
 
-StorPerf now supports docker images on ARM processors as well. However, at the moment
-there is no upstream image on DockerHub. The user needs to manually build it. Firstly,
-clone StorPerf repository from GitHub
+.. code-block:: console
 
-.. code-block:: bash
+    TAG=aarch64-stable ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=aarch64-stable ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
+
+
+
+Fraser (opnfv-6.0.0)
+~~~~~~~~~~~~~~~~~~
+
+This tag represents the 6th OPNFV release and the 5th StorPerf release.  There
+are no known bugs and known issues and workarounds are documented in the release
+notes.  Documentation can be found under the Fraser label at:
+
+http://docs.opnfv.org/en/stable-fraser/submodules/storperf/docs/testing/user/index.html
+
+Issues found here should be reported against release 6.0.0 in JIRA:
+
+https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=3
+
+For x86_64 based systems, use:
+
+.. code-block:: console
+
+    TAG=x86_64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=x86_64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
+
+For 64 bit ARM based systems, use:
+
+.. code-block:: console
+
+    TAG=aarch64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=aarch64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
+
+
+
+Euphrates (opnfv-5.0.0)
+~~~~~~~~~~~~~~~~~
+
+This tag represents the 5th OPNFV release and the 4th StorPerf release.  There
+are no known bugs and known issues and workarounds are documented in the release
+notes.  Documentation can be found under the Euphrates label at:
+
+http://docs.opnfv.org/en/stable-euphrates/submodules/storperf/docs/testing/user/index.html
+
+Issues found here should be reported against release 6.0.0 in JIRA:
+
+https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=3
+
+For x86_64 based systems, use:
+
+.. code-block:: console
 
-  git clone https://git.opnfv.org/storperf
-  cd storperf/docker/
+    TAG=x86_64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=x86_64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
 
-Next, build and setup the docker images
+For 64 bit ARM based systems, use:
 
 .. code-block:: console
 
-  TAG=aarch64 ENV_FILE=./admin.rc CARBON_DIR=./carbon docker-compose -f local-docker-compose.yaml build
-  TAG=aarch64 ENV_FILE=./admin.rc CARBON_DIR=./carbon docker-compose -f local-docker-compose.yaml up -d
+    TAG=aarch64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose pull
+    TAG=aarch64-opnfv-6.0.0 ENV_FILE=./admin.rc CARBON_DIR=./carbon/ docker-compose up -d
diff --git a/docs/testing/user/test-usage.rst b/docs/testing/user/test-usage.rst
index 8048cff..78bee4e 100644
--- a/docs/testing/user/test-usage.rst
+++ b/docs/testing/user/test-usage.rst
@@ -36,16 +36,31 @@ Configure The Environment
 
 The following pieces of information are required to prepare the environment:
 
-- The number of VMs/Cinder volumes to create
-- The Glance image that holds the VM operating system to use.  StorPerf has
-  only been tested with Ubuntu 16.04
-- The OpenStack flavor to use when creating the VMs
-- The name of the public network that agents will use
-- The size, in gigabytes, of the Cinder volumes to create
+- The number of VMs/Cinder volumes to create.
+- The Glance image that holds the VM operating system to use.
+- The OpenStack flavor to use when creating the VMs.
+- The name of the public network that agents will use.
+- The size, in gigabytes, of the Cinder volumes to create.
+- The number of the Cinder volumes to attach to each VM.
 - The availability zone (optional) in which the VM is to be launched. Defaults to **nova**.
 - The username (optional) if we specify a custom image.
 - The password (optional) for the above image.
 
+**Note**: on ARM based platforms there exists a bug in the kernel which can prevent
+VMs from properly attaching Cinder volumes.  There are two known workarounds:
+
+#. Create the environment with 0 Cinder volumes attached, and after the VMs
+  have finished booting, modify the stack to have 1 or more Cinder volumes.
+  See section on Changing Stack Parameters later in this guide.
+#. Add the following image metadata to Glance.  This will cause the Cinder
+  volume to be mounted as a SCSI device, and therefore your target will be
+  /dev/sdb, etc, instead of /dev/vdb.  You will need to specify this in your
+  warm up and workload jobs.
+
+.. code-block:
+  --property hw_disk_bus=scsi --property hw_scsi_model=virtio-scsi
+
+
 The ReST API is a POST to http://StorPerf:5000/api/v1.0/configurations and
 takes a JSON payload as follows.
 
@@ -57,6 +72,7 @@ takes a JSON payload as follows.
      "agent_image": string,
      "public_network": string,
      "volume_size": int,
+     "volume_count": int,
      "availability_zone": string,
      "username": string,
      "password": string
@@ -165,6 +181,24 @@ is required in order to push results to the OPNFV Test Results DB:
           "test_case": "snia_steady_state"
       }
 
+Changing Stack Parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~
+While StorPerf currently does not support changing the parameters of the
+stack directly, it is possible to change the stack using the OpenStack client
+library.  The following parameters can be changed:
+
+- agent_count: to increase or decrease the number of VMs.
+- volume_count: to change the number of Cinder volumes per VM.
+- volume_size: to increase the size of each volume.  Note: Cinder cannot shrink volumes.
+
+Increasing the number of agents or volumes, or increasing the size of the volumes
+will require you to kick off a new _warm_up job to initialize the newly
+allocated volumes.
+
+The following is an example of how to change the stack using the heat client:
+
+.. code-block::
+  heat stack-update StorPerfAgentGroup --existing -P "volume_count=2"
 
 
 Query Jobs Information