Merge "Document for Fraser test case results"
[yardstick.git] / docs / testing / user / userguide / nsb / tc_prox_context_acl_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 ACL
8 *********************************************
9
10 +-----------------------------------------------------------------------------+
11 |NSB PROX test for NFVI characterization                                      |
12 |                                                                             |
13 +--------------+--------------------------------------------------------------+
14 |test case id  | tc_prox_{context}_acl-{port_num}                             |
15 |              |                                                              |
16 |              | * context = baremetal or heat_context;                       |
17 |              | * port_num = 2 or 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  | This test allows to measure how well the SUT can exploit     |
29 |              | structures in the list of ACL rules.                         |
30 |              | The ACL rules are matched against a 7-tuple of the input     |
31 |              | packet: the regular 5-tuple and two VLAN tags.               |
32 |              | The rules in the rule set allow the packet to be forwarded   |
33 |              | and the rule set contains a default "match all" rule.        |
34 |              |                                                              |
35 |              | The KPI is measured with the rule set that has a moderate    |
36 |              | number of rules with moderate similarity between the rules & |
37 |              | the fraction of rules that were used.                        |
38 |              |                                                              |
39 |              | The ACL test cases are implemented to run in  baremetal      |
40 |              | and heat context for 2 port and 4 port configuration.        |
41 |              |                                                              |
42 +--------------+--------------------------------------------------------------+
43 |configuration | The ACL test cases are listed below:                         |
44 |              |                                                              |
45 |              | * tc_prox_baremetal_acl-2.yaml                               |
46 |              | * tc_prox_baremetal_acl-4.yaml                               |
47 |              | * tc_prox_heat_context_acl-2.yaml                            |
48 |              | * tc_prox_heat_context_acl-4.yaml                            |
49 |              |                                                              |
50 |              | Test duration is set as 300sec for each test.                |
51 |              | Packet size set as 64 bytes in traffic profile.              |
52 |              | These can be configured                                      |
53 |              |                                                              |
54 +--------------+--------------------------------------------------------------+
55 |test tool     | PROX                                                         |
56 |              | PROX is a DPDK application that can simulate VNF workloads   |
57 |              | and can generate traffic and used for NFVI characterization  |
58 |              |                                                              |
59 +--------------+--------------------------------------------------------------+
60 |applicability | This PROX ACL test cases can be configured with different:   |
61 |              |                                                              |
62 |              |  * packet sizes;                                             |
63 |              |  * test durations;                                           |
64 |              |  * tolerated loss;                                           |
65 |              |                                                              |
66 |              | Default values exist.                                        |
67 |              |                                                              |
68 +--------------+--------------------------------------------------------------+
69 |pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
70 |conditions    | to be installed into Glance with Prox and Dpdk included in   |
71 |              | it. The test need multi-queue enabled in Glance image.       |
72 |              |                                                              |
73 |              | For Baremetal tests cases Prox and Dpdk must be installed in |
74 |              | the hosts where the test is executed. The pod.yaml file must |
75 |              | have the necessary system and NIC information                |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |test sequence | description and expected result                              |
79 |              |                                                              |
80 +--------------+--------------------------------------------------------------+
81 |step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
82 |              | based on the pod file.                                       |
83 |              |                                                              |
84 |              | For Heat test: Two host VMs are booted, as Traffic generator |
85 |              | and VNF(ACL workload) based on the test flavor.              |
86 |              |                                                              |
87 +--------------+--------------------------------------------------------------+
88 |step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
89 |              | The test will resolve the topology and instantiate the VNF   |
90 |              | and TG and collect the KPI's/metrics.                        |
91 |              |                                                              |
92 +--------------+--------------------------------------------------------------+
93 |step 3        | The TG will send packets to the VNF. If the number of        |
94 |              | dropped packets is more than the tolerated loss the line     |
95 |              | rate or throughput is halved. This is done until the dropped |
96 |              | packets are within an acceptable tolerated loss.             |
97 |              |                                                              |
98 |              | The KPI is the number of packets per second for 64 bytes     |
99 |              | packet size with an accepted minimal packet loss for the     |
100 |              | default configuration.                                       |
101 |              |                                                              |
102 +--------------+--------------------------------------------------------------+
103 |step 4        | In Baremetal test: The test quits the application and unbind |
104 |              | the dpdk ports.                                              |
105 |              |                                                              |
106 |              | In Heat test: Two host VMs are deleted on test completion.   |
107 |              |                                                              |
108 +--------------+--------------------------------------------------------------+
109 |test verdict  | The test case will achieve a Throughput with an accepted     |
110 |              | minimal tolerated packet loss.                               |
111 +--------------+--------------------------------------------------------------+
112