Merge "Fix Malformed Table in User Guide docs" into stable/euphrates
[yardstick.git] / docs / testing / user / userguide / nsb / tc_prox_context_l3fwd_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 L3FWD
8 ***********************************************
9
10 +-----------------------------------------------------------------------------+
11 |NSB PROX test for NFVI characterization                                      |
12 |                                                                             |
13 +--------------+--------------------------------------------------------------+
14 |test case id  | tc_prox_{context}_l3fwd-{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  | The PROX L3FWD application performs basic routing of packets |
29 |              | with LPM based look-up method.                               |
30 |              |                                                              |
31 |              | The L3FWD test cases are implemented for baremetal and heat  |
32 |              | context for 2 port and 4 port configuration.                 |
33 |              |                                                              |
34 +--------------+--------------------------------------------------------------+
35 |configuration | The L3FWD test cases are listed below:                       |
36 |              |                                                              |
37 |              | * tc_prox_baremetal_l3fwd-2.yaml                             |
38 |              | * tc_prox_baremetal_l3fwd-4.yaml                             |
39 |              | * tc_prox_heat_context_l3fwd-2.yaml                          |
40 |              | * tc_prox_heat_context_l3fwd-4.yaml                          |
41 |              |                                                              |
42 |              | Test duration is set as 300sec for each test.                |
43 |              | The minimum packet size for L3FWD test is 64 bytes. This is  |
44 |              | set in the traffic profile and can be configured to use      |
45 |              | a higher packet size for the test.                           |
46 |              |                                                              |
47 +--------------+--------------------------------------------------------------+
48 |test tool     | PROX                                                         |
49 |              | PROX is a DPDK application that can simulate VNF workloads   |
50 |              | and can generate traffic and used for NFVI characterization  |
51 |              |                                                              |
52 +--------------+--------------------------------------------------------------+
53 |applicability | This PROX L3FWD test cases can be configured with different: |
54 |              |                                                              |
55 |              |  * packet sizes;                                             |
56 |              |  * test durations;                                           |
57 |              |  * tolerated loss;                                           |
58 |              |                                                              |
59 |              | Default values exist.                                        |
60 |              |                                                              |
61 +--------------+--------------------------------------------------------------+
62 |pre-test      | For Openstack test case image (yardstick-samplevnfs) needs   |
63 |conditions    | to be installed into Glance with Prox and Dpdk included in   |
64 |              | it. The test need multi-queue enabled in Glance image.       |
65 |              |                                                              |
66 |              | For Baremetal tests cases Prox and Dpdk must be installed in |
67 |              | the hosts where the test is executed. The pod.yaml file must |
68 |              | have the necessary system and NIC information                |
69 |              |                                                              |
70 +--------------+--------------------------------------------------------------+
71 |test sequence | description and expected result                              |
72 |              |                                                              |
73 +--------------+--------------------------------------------------------------+
74 |step 1        | For Baremetal test: The TG and VNF are started on the hosts  |
75 |              | based on the pod file.                                       |
76 |              |                                                              |
77 |              | For Heat test: Two host VMs are booted, as Traffic generator |
78 |              | and VNF(L3FWD workload) based on the test flavor.            |
79 |              |                                                              |
80 +--------------+--------------------------------------------------------------+
81 |step 2        | Yardstick is connected with the TG and VNF by using ssh.     |
82 |              | The test will resolve the topology and instantiate the VNF   |
83 |              | and TG and collect the KPI's/metrics.                        |
84 |              |                                                              |
85 +--------------+--------------------------------------------------------------+
86 |step 3        | The TG will send packet to the VNF. If the number of dropped |
87 |              | packets is more than the tolerated loss the line rate        |
88 |              | or throughput is halved. This is done until the dropped      |
89 |              | packets are within an acceptable tolerated loss.             |
90 |              |                                                              |
91 |              | The KPI is the number of packets per second for 64 byte      |
92 |              | packets with an accepted minimal packet loss for the default |
93 |              | configuration.                                               |
94 |              |                                                              |
95 +--------------+--------------------------------------------------------------+
96 |step 4        | In Baremetal test: The test quits the application and unbind |
97 |              | the dpdk ports.                                              |
98 |              |                                                              |
99 |              | In Heat test: Two host VMs are deleted on test completion.   |
100 |              |                                                              |
101 +--------------+--------------------------------------------------------------+
102 |test verdict  | The test case will achieve a Throughput with an accepted     |
103 |              | minimal tolerated packet loss.                               |
104 +--------------+--------------------------------------------------------------+
105