Addition of NSB Prox test documentation of vPE and LW-AFTR test cases

YARDSTICK-840

NSB Prox test documentation of vPE and LW-AFTR test cases documenation.

Change-Id: Ic6da6546faf0494fdee71962a515083e6e10a410
Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
(cherry picked from commit db6083d91499521bf3a486623e985cc3b1703524)

3 files changed, 217 insertions, 0 deletions

diff --git a/docs/testing/user/userguide/nsb/nsb-list-of-tcs.rst b/docs/testing/user/userguide/nsb/nsb-list-of-tcs.rst
index 43aa3d69a..895837283 100644
--- a/docs/testing/user/userguide/nsb/nsb-list-of-tcs.rst
+++ b/docs/testing/user/userguide/nsb/nsb-list-of-tcs.rst
@@ -26,3 +26,5 @@ NSB PROX Test Case Descriptions
    tc_prox_context_mpls_tagging_port
    tc_prox_context_buffering_port
    tc_prox_context_load_balancer_port
+   tc_prox_context_vpe_port
+   tc_prox_context_lw_after_port
diff --git a/docs/testing/user/userguide/nsb/tc_prox_context_lw_aftr_port.rst b/docs/testing/user/userguide/nsb/tc_prox_context_lw_aftr_port.rst
new file mode 100644
index 000000000..5a1fada05
--- /dev/null
+++ b/docs/testing/user/userguide/nsb/tc_prox_context_lw_aftr_port.rst
@@ -0,0 +1,107 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, 2017 Intel Corporation.
+
+************************************************
+Yardstick Test Case Description: NSB PROX LwAFTR
+************************************************
+
++-----------------------------------------------------------------------------+
+|NSB PROX test for NFVI characterization                                      |
+|                                                                             |
++--------------+--------------------------------------------------------------+
+|test case id  | tc_prox_{context}_lw_aftr-{port_num}                         |
+|              |                                                              |
+|              | * context = baremetal or heat_context;                       |
+|              | * port_num = 4;                                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|metric        | * Network Throughput;                                        |
+|              | * TG Packets Out;                                            |
+|              | * TG Packets In;                                             |
+|              | * VNF Packets Out;                                           |
+|              | * VNF Packets In;                                            |
+|              | * Dropped packets;                                           |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test purpose  | The PROX LW_AFTR test will take packets in from one          |
+|              | port and remove the ipv6 encapsulation and forward them to   |
+|              | another port. While forwarded packets in other direction     |
+|              | will be encapsulated in an ipv6 header.                      |
+|              |                                                              |
+|              | The lw_aftr test cases are implemented to run in baremetal   |
+|              | and heat context an require 4 port topology to run the       |
+|              | default configuration.                                       |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|configuration | The LW_AFTR test cases are listed below:                     |
+|              |                                                              |
+|              | * tc_prox_baremetal_lw_aftr-4.yaml                           |
+|              | * tc_prox_heat_context_lw_aftr-4.yaml                        |
+|              |                                                              |
+|              | Test duration is set as 300sec for each test.                |
+|              | The minimum packet size for MPLS test is 68 bytes. This is   |
+|              | set in the traffic profile and can be configured to use      |
+|              | higher packet sizes.                                         |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test tool     | PROX                                                         |
+|              | PROX is a DPDK application that can simulate VNF workloads   |
+|              | and can generate traffic and used for NFVI characterization  |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|applicability | The PROX lwAFTR test cases can be configured with            |
+|              | different:                                                   |
+|              |                                                              |
+|              |  * packet sizes;                                             |
+|              |  * test durations;                                           |
+|              |  * tolerated loss;                                           |
+|              |                                                              |
+|              | Default values exist.                                        |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
+|conditions    | to be installed into Glance with Prox and Dpdk included in   |
+|              | it.                                                          |
+|              |                                                              |
+|              | For Baremetal tests cases Prox and Dpdk must be installed in |
+|              | the hosts where the test is executed. The pod.yaml file must |
+|              | have the necessary system and NIC information                |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
+|              | based on the pod file.                                       |
+|              |                                                              |
+|              | For Heat test: Two host VMs are booted, as Traffic generator |
+|              | and VNF(LW_AFTR workload) based on the test flavor.          |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
+|              | The test will resolve the topology and instantiate the VNF   |
+|              | and TG and collect the KPI's/metrics.                        |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 3        | The TG will send packets to the VNF. If the number of        |
+|              | dropped packets is more than the tolerated loss the line     |
+|              | rate or throughput is halved. This is done until the dropped |
+|              | packets are within an acceptable tolerated loss.             |
+|              |                                                              |
+|              | The KPI is the number of packets per second for 86 bytes     |
+|              | packet size with an accepted minimal packet loss for the     |
+|              | default configuration.                                       |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 4        | In Baremetal test: The test quits the application and unbind |
+|              | the dpdk ports.                                              |
+|              |                                                              |
+|              | In Heat test: Two host VMs are deleted on test completion.   |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test verdict  | The test case will achieve a Throughput with an accepted     |
+|              | minimal tolerated packet loss.                               |
++--------------+--------------------------------------------------------------+
+
diff --git a/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst b/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst
new file mode 100644
index 000000000..6827b0525
--- /dev/null
+++ b/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst
@@ -0,0 +1,108 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, 2017 Intel Corporation.
+
+**********************************************
+Yardstick Test Case Description: NSB PROXi VPE
+**********************************************
+
++-----------------------------------------------------------------------------+
+|NSB PROX test for NFVI characterization                                      |
+|                                                                             |
++--------------+--------------------------------------------------------------+
+|test case id  | tc_prox_{context}_vpe-{port_num}                             |
+|              |                                                              |
+|              | * context = baremetal or heat_context;                       |
+|              | * port_num = 4;                                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|metric        | * Network Throughput;                                        |
+|              | * TG Packets Out;                                            |
+|              | * TG Packets In;                                             |
+|              | * VNF Packets Out;                                           |
+|              | * VNF Packets In;                                            |
+|              | * Dropped packets;                                           |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test purpose  | The PROX VPE test handles packet processing, routing, QinQ   |
+|              | encapsulation, flows, ACL rules, adds/removes MPLS tagging   |
+|              | and performs QoS before forwarding packet to another port.   |
+|              | The reverse applies to forwarded packets in the other        |
+|              | direction.                                                   |
+|              |                                                              |
+|              | The VPE test cases are implemented to run in baremetal       |
+|              | and heat context an require 4 port topology to run the       |
+|              | default configuration.                                       |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|configuration | The VPE test cases are listed below:                         |
+|              |                                                              |
+|              | * tc_prox_baremetal_vpe-4.yaml                               |
+|              | * tc_prox_heat_context_vpe-4.yaml                            |
+|              |                                                              |
+|              | Test duration is set as 300sec for each test.                |
+|              | The minimum packet size for VPE test is 68 bytes. This is    |
+|              | set in the traffic profile and can be configured to use      |
+|              | higher packet sizes.                                         |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test tool     | PROX                                                         |
+|              | PROX is a DPDK application that can simulate VNF workloads   |
+|              | and can generate traffic and used for NFVI characterization  |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|applicability | The PROX VPE  test cases can be configured with              |
+|              | different:                                                   |
+|              |                                                              |
+|              |  * packet sizes;                                             |
+|              |  * test durations;                                           |
+|              |  * tolerated loss;                                           |
+|              |                                                              |
+|              | Default values exist.                                        |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
+|conditions    | to be installed into Glance with Prox and Dpdk included in   |
+|              | it.                                                          |
+|              |                                                              |
+|              | For Baremetal tests cases Prox and Dpdk must be installed in |
+|              | the hosts where the test is executed. The pod.yaml file must |
+|              | have the necessary system and NIC information                |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test sequence | description and expected result                              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
+|              | based on the pod file.                                       |
+|              |                                                              |
+|              | For Heat test: Two host VMs are booted, as Traffic generator |
+|              | and VNF(VPE workload) based on the test flavor.              |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
+|              | The test will resolve the topology and instantiate the VNF   |
+|              | and TG and collect the KPI's/metrics.                        |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 3        | The TG will send packets to the VNF. If the number of        |
+|              | dropped packets is more than the tolerated loss the line     |
+|              | rate or throughput is halved. This is done until the dropped |
+|              | packets are within an acceptable tolerated loss.             |
+|              |                                                              |
+|              | The KPI is the number of packets per second for 68 bytes     |
+|              | packet size with an accepted minimal packet loss for the     |
+|              | default configuration.                                       |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|step 4        | In Baremetal test: The test quits the application and unbind |
+|              | the dpdk ports.                                              |
+|              |                                                              |
+|              | In Heat test: Two host VMs are deleted on test completion.   |
+|              |                                                              |
++--------------+--------------------------------------------------------------+
+|test verdict  | The test case will achieve a Throughput with an accepted     |
+|              | minimal tolerated packet loss.                               |
++--------------+--------------------------------------------------------------+
+