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