Merge "Fix UDPReplay VNF statistic parsing"
[yardstick.git] / docs / testing / user / userguide / nsb / tc_prox_context_vpe_port.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, 2017 Intel Corporation.
5
6 **********************************************
7 Yardstick Test Case Description: NSB PROXi VPE
8 **********************************************
9
10 +-----------------------------------------------------------------------------+
11 |NSB PROX test for NFVI characterization                                      |
12 |                                                                             |
13 +--------------+--------------------------------------------------------------+
14 |test case id  | tc_prox_{context}_vpe-{port_num}                             |
15 |              |                                                              |
16 |              | * context = baremetal or heat_context;                       |
17 |              | * port_num = 4;                                              |
18 |              |                                                              |
19 +--------------+--------------------------------------------------------------+
20 |metric        | * Network Throughput;                                        |
21 |              | * TG Packets Out;                                            |
22 |              | * TG Packets In;                                             |
23 |              | * VNF Packets Out;                                           |
24 |              | * VNF Packets In;                                            |
25 |              | * Dropped packets;                                           |
26 |              |                                                              |
27 +--------------+--------------------------------------------------------------+
28 |test purpose  | The PROX VPE test handles packet processing, routing, QinQ   |
29 |              | encapsulation, flows, ACL rules, adds/removes MPLS tagging   |
30 |              | and performs QoS before forwarding packet to another port.   |
31 |              | The reverse applies to forwarded packets in the other        |
32 |              | direction.                                                   |
33 |              |                                                              |
34 |              | The VPE test cases are implemented to run in baremetal       |
35 |              | and heat context an require 4 port topology to run the       |
36 |              | default configuration.                                       |
37 |              |                                                              |
38 +--------------+--------------------------------------------------------------+
39 |configuration | The VPE test cases are listed below:                         |
40 |              |                                                              |
41 |              | * tc_prox_baremetal_vpe-4.yaml                               |
42 |              | * tc_prox_heat_context_vpe-4.yaml                            |
43 |              |                                                              |
44 |              | Test duration is set as 300sec for each test.                |
45 |              | The minimum packet size for VPE test is 68 bytes. This is    |
46 |              | set in the traffic profile and can be configured to use      |
47 |              | higher packet sizes.                                         |
48 |              |                                                              |
49 +--------------+--------------------------------------------------------------+
50 |test tool     | PROX                                                         |
51 |              | PROX is a DPDK application that can simulate VNF workloads   |
52 |              | and can generate traffic and used for NFVI characterization  |
53 |              |                                                              |
54 +--------------+--------------------------------------------------------------+
55 |applicability | The PROX VPE  test cases can be configured with              |
56 |              | different:                                                   |
57 |              |                                                              |
58 |              |  * packet sizes;                                             |
59 |              |  * test durations;                                           |
60 |              |  * tolerated loss;                                           |
61 |              |                                                              |
62 |              | Default values exist.                                        |
63 |              |                                                              |
64 +--------------+--------------------------------------------------------------+
65 |pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
66 |conditions    | to be installed into Glance with Prox and Dpdk included in   |
67 |              | it.                                                          |
68 |              |                                                              |
69 |              | For Baremetal tests cases Prox and Dpdk must be installed in |
70 |              | the hosts where the test is executed. The pod.yaml file must |
71 |              | have the necessary system and NIC information                |
72 |              |                                                              |
73 +--------------+--------------------------------------------------------------+
74 |test sequence | description and expected result                              |
75 |              |                                                              |
76 +--------------+--------------------------------------------------------------+
77 |step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
78 |              | based on the pod file.                                       |
79 |              |                                                              |
80 |              | For Heat test: Two host VMs are booted, as Traffic generator |
81 |              | and VNF(VPE workload) based on the test flavor.              |
82 |              |                                                              |
83 +--------------+--------------------------------------------------------------+
84 |step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
85 |              | The test will resolve the topology and instantiate the VNF   |
86 |              | and TG and collect the KPI's/metrics.                        |
87 |              |                                                              |
88 +--------------+--------------------------------------------------------------+
89 |step 3        | The TG will send packets to the VNF. If the number of        |
90 |              | dropped packets is more than the tolerated loss the line     |
91 |              | rate or throughput is halved. This is done until the dropped |
92 |              | packets are within an acceptable tolerated loss.             |
93 |              |                                                              |
94 |              | The KPI is the number of packets per second for 68 bytes     |
95 |              | packet size with an accepted minimal packet loss for the     |
96 |              | default configuration.                                       |
97 |              |                                                              |
98 +--------------+--------------------------------------------------------------+
99 |step 4        | In Baremetal test: The test quits the application and unbind |
100 |              | the dpdk ports.                                              |
101 |              |                                                              |
102 |              | In Heat test: Two host VMs are deleted on test completion.   |
103 |              |                                                              |
104 +--------------+--------------------------------------------------------------+
105 |test verdict  | The test case will achieve a Throughput with an accepted     |
106 |              | minimal tolerated packet loss.                               |
107 +--------------+--------------------------------------------------------------+
108