add yardstick iruya 9.0.0 release notes
[yardstick.git] / docs / testing / user / userguide / nsb / tc_prox_context_buffering_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 PROX Packet Buffering
8 **********************************************************
9
10 +-----------------------------------------------------------------------------+
11 |NSB PROX test for NFVI characterization                                      |
12 |                                                                             |
13 +--------------+--------------------------------------------------------------+
14 |test case id  | tc_prox_{context}_buffering-{port_num}                       |
15 |              |                                                              |
16 |              | * context = baremetal or heat_context                        |
17 |              | * port_num = 1                                               |
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  | This test measures the impact of the condition when packets  |
29 |              | get buffered, thus they stay in memory for the extended      |
30 |              | period of time, 125ms in this case.                          |
31 |              |                                                              |
32 |              | The Packet Buffering test cases are implemented to run in    |
33 |              | baremetal and heat context.                                  |
34 |              |                                                              |
35 |              | The test runs only on the first port of the SUT.             |
36 |              |                                                              |
37 +--------------+--------------------------------------------------------------+
38 |configuration | The Packet Buffering test cases are listed below:            |
39 |              |                                                              |
40 |              | * tc_prox_baremetal_buffering-1.yaml                         |
41 |              | * tc_prox_heat_context_buffering-1.yaml                      |
42 |              |                                                              |
43 |              | Test duration is set as 300sec for each test.                |
44 |              | The minimum packet size for Buffering test is 64 bytes. This |
45 |              | is set in the traffic profile and can be configured to use   |
46 |              | a higher packet size for the test.                           |
47 |              |                                                              |
48 +--------------+--------------------------------------------------------------+
49 |test tool     | PROX                                                         |
50 |              | PROX is a DPDK application that can simulate VNF workloads   |
51 |              | and can generate traffic and used for NFVI characterization  |
52 |              |                                                              |
53 +--------------+--------------------------------------------------------------+
54 |applicability | The PROX Packet Buffering test cases can be configured with  |
55 |              |  different:                                                  |
56 |              |                                                              |
57 |              |  * packet sizes;                                             |
58 |              |  * test durations;                                           |
59 |              |  * tolerated loss;                                           |
60 |              |                                                              |
61 |              | Default values exist.                                        |
62 |              |                                                              |
63 +--------------+--------------------------------------------------------------+
64 |pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
65 |conditions    | to be installed into Glance with Prox and Dpdk included in   |
66 |              | it. The test need multi-queue enabled in Glance image.       |
67 |              |                                                              |
68 |              | For Baremetal tests cases Prox and Dpdk must be installed in |
69 |              | the hosts where the test is executed. The pod.yaml file must |
70 |              | have the necessary system and NIC information                |
71 |              |                                                              |
72 +--------------+--------------------------------------------------------------+
73 |test sequence | description and expected result                              |
74 |              |                                                              |
75 +--------------+--------------------------------------------------------------+
76 |step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
77 |              | based on the pod file.                                       |
78 |              |                                                              |
79 |              | For Heat test: Two host VMs are booted, as Traffic generator |
80 |              | and VNF(Packet Buffering workload) based on the test flavor. |
81 |              |                                                              |
82 +--------------+--------------------------------------------------------------+
83 |step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
84 |              | The test will resolve the topology and instantiate the VNF   |
85 |              | and TG and collect the KPI's/metrics.                        |
86 |              |                                                              |
87 +--------------+--------------------------------------------------------------+
88 |step 3        | The TG will send packets to the VNF. If the number of        |
89 |              | dropped packets is more than the tolerated loss the line     |
90 |              | rate or throughput is halved. This is done until the dropped |
91 |              | packets are within an acceptable tolerated loss.             |
92 |              |                                                              |
93 |              | The KPI in this test is the maximum number of packets that   |
94 |              | can be forwarded given the requirement that the latency of   |
95 |              | each packet is at least 125 millisecond.                     |
96 |              |                                                              |
97 +--------------+--------------------------------------------------------------+
98 |step 4        | In Baremetal test: The test quits the application and unbind |
99 |              | the dpdk ports.                                              |
100 |              |                                                              |
101 |              | In Heat test: Two host VMs are deleted on test completion.   |
102 |              |                                                              |
103 +--------------+--------------------------------------------------------------+
104 |test verdict  | The test case will achieve a Throughput with an accepted     |
105 |              | minimal tolerated packet loss.                               |
106 +--------------+--------------------------------------------------------------+
107