Merge "Add prox test case for SRIOV & 4 ports."

[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc074.rst

diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc074.rst b/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
index 261a8bd..8d025ee 100644 (file)
--- a/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
+++ b/docs/testing/user/userguide/opnfv_yardstick_tc074.rst
@@ -91,12 +91,15 @@ Yardstick Test Case Description TC074
 |              | * workload=[workload module]                                 |
 |              |   If not specified, the default is to run all workloads. The |
 |              |   workload types are:                                        |
+|              |                                                              |
 |              |      - rs: 100% Read, sequential data                        |
 |              |      - ws: 100% Write, sequential data                       |
 |              |      - rr: 100% Read, random access                          |
 |              |      - wr: 100% Write, random access                         |
 |              |      - rw: 70% Read / 30% write, random access               |
+|              |                                                              |
 |              |   measurements.                                              |
+|              |                                                              |
 |              | * workloads={json maps}                                      |
 |              |   This parameter supercedes the workload and calls the V2.0  |
 |              |   API in StorPerf. It allows for greater control of the      |
@@ -111,6 +114,17 @@ Yardstick Test Case Description TC074
 |              |   Query the status of the supplied job_id and report on      |
 |              |   metrics. If a workload is supplied, will report on only    |
 |              |   that subset.                                               |
+|              | * availability_zone: Specify the availability zone which     |
+|              |   the stack will use to create instances.                    |
+|              | * volume_type:                                               |
+|              |   Cinder volumes can have different types, for example       |
+|              |   encrypted vs. not encrypted.                               |
+|              |   To be able to profile the difference between the two.      |
+|              | * subnet_CIDR: Specify subnet CIDR of private network        |
+|              | * stack_name: Specify the name of the stack that will be     |
+|              |   created, the default: "StorperfAgentGroup"                 |
+|              | * volume_count: Specify the number of volumes per            |
+|              |   virtual machines                                           |
 |              |                                                              |
 |              |   There are default values for each above-mentioned option.  |
 |              |                                                              |
@@ -120,11 +134,13 @@ Yardstick Test Case Description TC074
 |              |                                                              |
 |              | Storperf is required to be installed in the environment.     |
 |              | There are two possible methods for Storperf installation:    |
-|              |     Run container on Jump Host                               |
-|              |     Run container in a VM                                    |
+|              |                                                              |
+|              |     - Run container on Jump Host                             |
+|              |     - 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                                                    |
@@ -135,6 +151,7 @@ Yardstick Test Case Description TC074
 |              |                                                              |
 |              | Running StorPerf in a VM                                     |
 |              | Requirements:                                                |
+|              |                                                              |
 |              |     - VM has docker installed                                |
 |              |     - VM has OpenStack Controller credentials and can        |
 |              |       communicate with the Controller API                    |