Add test case description and modify task file for TC004
[yardstick.git] / docs / userguide / opnfv_yardstick_tc070.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, Huawei Technologies Co.,Ltd and others.
5
6 *************************************
7 Yardstick Test Case Description TC070
8 *************************************
9
10 .. _cirros: https://download.cirros-cloud.net
11 .. _pktgen: https://www.kernel.org/doc/Documentation/networking/pktgen.txt
12 .. _free: http://manpages.ubuntu.com/manpages/trusty/en/man1/free.1.html
13
14 +-----------------------------------------------------------------------------+
15 |Latency, Memory Utilization, Throughput, Packet Loss                         |
16 |                                                                             |
17 +--------------+--------------------------------------------------------------+
18 |test case id  | OPNFV_YARDSTICK_TC070_Latency, Memory Utilization,           |
19 |              | Throughput,Packet Loss                                       |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |metric        | Number of flows, latency, throughput, Memory Utilization,    |
23 |              | packet loss                                                  |
24 |              |                                                              |
25 +--------------+--------------------------------------------------------------+
26 |test purpose  | To evaluate the IaaS network performance with regards to     |
27 |              | flows and throughput, such as if and how different amounts   |
28 |              | of flows matter for the throughput between hosts on different|
29 |              | compute blades. Typically e.g. the performance of a vSwitch  |
30 |              | depends on the number of flows running through it. Also      |
31 |              | performance of other equipment or entities can depend        |
32 |              | on the number of flows or the packet sizes used.             |
33 |              | The purpose is also to be able to spot trends.               |
34 |              | Test results, graphs and similar shall be stored for         |
35 |              | comparison reasons and product evolution understanding       |
36 |              | between different OPNFV versions and/or configurations.      |
37 |              |                                                              |
38 +--------------+--------------------------------------------------------------+
39 |configuration | file: opnfv_yardstick_tc070.yaml                             |
40 |              |                                                              |
41 |              | Packet size: 64 bytes                                        |
42 |              | Number of ports: 1, 10, 50, 100, 300, 500, 750 and 1000.     |
43 |              | The amount configured ports map from 2 up to 1001000 flows,  |
44 |              | respectively. Each port amount is run two times, for 20      |
45 |              | seconds each. Then the next port_amount is run, and so on.   |
46 |              | During the test Memory Utilization on both client and server,|
47 |              | and the network latency between the client and server are    |
48 |              | measured.                                                    |
49 |              | The client and server are distributed on different HW.       |
50 |              | For SLA max_ppm is set to 1000.                              |
51 |              |                                                              |
52 +--------------+--------------------------------------------------------------+
53 |test tool     | pktgen                                                       |
54 |              |                                                              |
55 |              | Pktgen is not always part of a Linux distribution, hence it  |
56 |              | needs to be installed. It is part of the Yardstick Glance    |
57 |              | image.                                                       |
58 |              | (As an example see the /yardstick/tools/ directory for how   |
59 |              | to generate a Linux image with pktgen included.)             |
60 |              |                                                              |
61 |              | ping                                                         |
62 |              |                                                              |
63 |              | Ping is normally part of any Linux distribution, hence it    |
64 |              | doesn't need to be installed. It is also part of the         |
65 |              | Yardstick Glance image.                                      |
66 |              | (For example also a cirros_ image can be downloaded, it      |
67 |              | includes ping)                                               |
68 |              |                                                              |
69 |              | free                                                         |
70 |              |                                                              |
71 |              | free provides information about unused and used memory and   |
72 |              | swap space on any computer running Linux or another Unix-like|
73 |              | operating system.                                            |
74 |              | free is normally part of a Linux distribution, hence it      |
75 |              | doesn't needs to be installed.                               |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |references    | Ping and free man pages                                      |
79 |              |                                                              |
80 |              | pktgen_                                                      |
81 |              |                                                              |
82 |              | ETSI-NFV-TST001                                              |
83 |              |                                                              |
84 +--------------+--------------------------------------------------------------+
85 |applicability | Test can be configured with different packet sizes, amount   |
86 |              | of flows and test duration. Default values exist.            |
87 |              |                                                              |
88 |              | SLA (optional): max_ppm: The number of packets per million   |
89 |              | packets sent that are acceptable to lose, not received.      |
90 |              |                                                              |
91 +--------------+--------------------------------------------------------------+
92 |pre-test      | The test case image needs to be installed into Glance        |
93 |conditions    | with pktgen included in it.                                  |
94 |              |                                                              |
95 |              | No POD specific requirements have been identified.           |
96 |              |                                                              |
97 +--------------+--------------------------------------------------------------+
98 |test sequence | description and expected result                              |
99 |              |                                                              |
100 +--------------+--------------------------------------------------------------+
101 |step 1        | The hosts are installed, as server and client. pktgen is     |
102 |              | invoked and logs are produced and stored.                    |
103 |              |                                                              |
104 |              | Result: Logs are stored.                                     |
105 |              |                                                              |
106 +--------------+--------------------------------------------------------------+
107 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
108 |              | execution problem.                                           |
109 |              |                                                              |
110 +--------------+--------------------------------------------------------------+