Merge "Extend vBNG PPPoE test cases functionality"
[yardstick.git] / docs / testing / user / userguide / nsb / tc_vfw_rfc2544_correlated.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, 2018 Intel Corporation.
5
6 *************************************************************
7 Yardstick Test Case Description: NSB vFW RFC2544 (correlated)
8 *************************************************************
9
10 +------------------------------------------------------------------------------+
11 | NSB vFW test for VNF characterization using correlated traffic               |
12 |                                                                              |
13 +---------------+--------------------------------------------------------------+
14 | test case id  | tc_{context}_rfc2544_ipv4_1rule_1flow_64B_trex_corelated     |
15 |               |                                                              |
16 |               | * context = baremetal, heat                                  |
17 |               |                                                              |
18 +---------------+--------------------------------------------------------------+
19 | metric        | * Network Throughput;                                        |
20 |               | * TG Packets Out;                                            |
21 |               | * TG Packets In;                                             |
22 |               | * TG Latency;                                                |
23 |               | * VNF Packets Out;                                           |
24 |               | * VNF Packets In;                                            |
25 |               | * VNF Packets Fwd;                                           |
26 |               | * Dropped packets;                                           |
27 |               |                                                              |
28 |               | NOTE: For correlated TCs the TG metrics are available on     |
29 |               | uplink ports.                                                |
30 |               |                                                              |
31 +---------------+--------------------------------------------------------------+
32 | test purpose  | The VFW RFC2544 correlated tests measure performance         |
33 |               | characteristics of the SUT (multiple ports) and sends UDP    |
34 |               | traffic from uplink TG ports to SampleVNF vFW application.   |
35 |               | The application forwards received traffic from uplink ports  |
36 |               | to downlink ports based on rules provided by the user in the |
37 |               | TC configuration and default rules created by vFW. The VNF   |
38 |               | downlink traffic is received by another UDPReplay VNF and it |
39 |               | is mirrored back to the VNF on the same port. Finally, the   |
40 |               | traffic is received back to the TG uplink port.              |
41 |               |                                                              |
42 +---------------+--------------------------------------------------------------+
43 | configuration | The 2 ports RFC2544 correlated test cases are listed below:  |
44 |               |                                                              |
45 |               | * tc_baremetal_rfc2544_ipv4_1rule_1flow_64B_trex_corelated   |
46 |               |   _traffic.yaml                                              |
47 |               |                                                              |
48 |               | Multiple VNF (2, 4, 10) RFC2544 correlated test cases are    |
49 |               | listed below:                                                |
50 |               |                                                              |
51 |               | * tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex_correlated       |
52 |               |   _scale_10.yaml                                             |
53 |               | * tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex_correlated_scale |
54 |               |   _2.yaml                                                    |
55 |               | * tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex_correlated_scale |
56 |               |   _4.yaml                                                    |
57 |               |                                                              |
58 |               | The scale-out RFC2544 test cases are listed below:           |
59 |               |                                                              |
60 |               | * tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex_correlated_scale |
61 |               |   _out.yaml                                                  |
62 |               |                                                              |
63 |               | Test duration is set as 30 sec for each test and default     |
64 |               | number of rules are applied. These can be configured         |
65 |               |                                                              |
66 +---------------+--------------------------------------------------------------+
67 | test tool     | The vFW is a DPDK application that performs basic filtering  |
68 |               | for malformed packets and dynamic packet filtering of        |
69 |               | incoming packets using the connection tracker library.       |
70 |               |                                                              |
71 +---------------+--------------------------------------------------------------+
72 | applicability | The vFW RFC2544 test cases can be configured with different: |
73 |               |                                                              |
74 |               |  * packet sizes;                                             |
75 |               |  * test duration;                                            |
76 |               |  * tolerated loss;                                           |
77 |               |  * traffic flows;                                            |
78 |               |  * rules;                                                    |
79 |               |                                                              |
80 |               | Default values exist.                                        |
81 |               |                                                              |
82 +---------------+--------------------------------------------------------------+
83 | pre-test      | For OpenStack test case image (yardstick-samplevnf) needs    |
84 | conditions    | to be installed into Glance with vFW and DPDK included in    |
85 |               | it (NSB install).                                            |
86 |               |                                                              |
87 |               | For Baremetal tests cases vFW and DPDK must be installed on  |
88 |               | the hosts where the test is executed. The pod.yaml file must |
89 |               | have the necessary system and NIC information.               |
90 |               |                                                              |
91 +---------------+--------------------------------------------------------------+
92 | test sequence | Description and expected result                              |
93 |               |                                                              |
94 +---------------+--------------------------------------------------------------+
95 | step 1        | For Baremetal test: The TG (except IXIA), vFW and UDPReplay  |
96 |               | VNFs are started on the hosts based on the pod file.         |
97 |               |                                                              |
98 |               | For Heat test: Three host VMs are booted, as Traffic         |
99 |               | generator, vFW and UDPReplay VNF(vFW) based on the test      |
100 |               | flavor. In case of scale-out scenario the multiple vFW VNF   |
101 |               | VMs will be started.                                         |
102 |               |                                                              |
103 +---------------+--------------------------------------------------------------+
104 | step 2        | Yardstick is connected with the TG, vFW and UDPReplay VNF by |
105 |               | using ssh (in case of IXIA TG is connected via TCL           |
106 |               | interface). The test will resolve the topology and           |
107 |               | instantiate all VNFs and TG and collect the KPI's/metrics.   |
108 |               |                                                              |
109 +---------------+--------------------------------------------------------------+
110 | step 3        | The TG will send packets to the VNFs. If the number of       |
111 |               | dropped packets is more than the tolerated loss the line     |
112 |               | rate or throughput is halved. This is done until the dropped |
113 |               | packets are within an acceptable tolerated loss.             |
114 |               |                                                              |
115 |               | The KPI is the number of packets per second for 64B packet   |
116 |               | size with an accepted minimal packet loss for the default    |
117 |               | configuration.                                               |
118 |               |                                                              |
119 +---------------+--------------------------------------------------------------+
120 | step 4        | In Baremetal test: The test quits the application and unbind |
121 |               | the DPDK ports.                                              |
122 |               |                                                              |
123 |               | In Heat test: All VNF VMs and TG are deleted on test         |
124 |               | completion.                                                  |
125 |               |                                                              |
126 +---------------+--------------------------------------------------------------+
127 | test verdict  | The test case will achieve a Throughput with an accepted     |
128 |               | minimal tolerated packet loss.                               |
129 +---------------+--------------------------------------------------------------+
130