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