Structure test case descriptions
[yardstick.git] / docs / yardstick / opnfv_yardstick_tc009.rst
1 *************************************
2 Yardstick Test Case Description TC009
3 *************************************
4
5 .. _pktgen: https://www.kernel.org/doc/Documentation/networking/pktgen.txt
6
7 +-----------------------------------------------------------------------------+
8 |Packet Loss                                                                  |
9 |                                                                             |
10 +--------------+--------------------------------------------------------------+
11 |test case id  | OPNFV_YARDSTICK_TC009_NW PERF, Packet loss                   |
12 |              |                                                              |
13 +--------------+--------------------------------------------------------------+
14 |metric        | Number of flows, packets lost and throughput                 |
15 |              |                                                              |
16 +--------------+--------------------------------------------------------------+
17 |test purpose  | To evaluate the IaaS network performance with regards to     |
18 |              | flows and throughput, such as if and how different amounts   |
19 |              | of flows matter for the throughput between VMs on different  |
20 |              | compute blades.                                              |
21 |              | 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_tc009.yaml                             |
32 |              |                                                              |
33 |              | Packet size: 64 bytes                                        |
34 |              |                                                              |
35 |              | Number of ports: 1, 10, 50, 100, 500 and 1000. The amount of |
36 |              | configured ports map from 2 up to 1001000 flows,             |
37 |              | respectively. Each port amount is run ten times, for 20      |
38 |              | seconds each. Then the next port_amount is run, and so on.   |
39 |              |                                                              |
40 |              | The client and server are distributed on different HW.       |
41 |              |                                                              |
42 |              | For SLA max_ppm is set to 1000.                              |
43 |              |                                                              |
44 +--------------+--------------------------------------------------------------+
45 |test tool     | pktgen                                                       |
46 |              |                                                              |
47 |              | (Pktgen is not always part of a Linux distribution, hence it |
48 |              | needs to be installed. It is part of the Yardstick Docker    |
49 |              | image.                                                       |
50 |              | As an example see the /yardstick/tools/ directory for how    |
51 |              | to generate a Linux image with pktgen included.)             |
52 |              |                                                              |
53 +--------------+--------------------------------------------------------------+
54 |references    | pktgen_                                                      |
55 |              |                                                              |
56 |              | ETSI-NFV-TST001                                              |
57 |              |                                                              |
58 +--------------+--------------------------------------------------------------+
59 |applicability | Test can be configured with different packet sizes, amount   |
60 |              | of flows and test duration. Default values exist.            |
61 |              |                                                              |
62 |              | SLA (optional): max_ppm: The number of packets per million   |
63 |              | packets sent that are acceptable to loose, not received.     |
64 |              |                                                              |
65 +--------------+--------------------------------------------------------------+
66 |pre-test      | The test case image needs to be installed into Glance        |
67 |conditions    | with pktgen included in it.                                  |
68 |              |                                                              |
69 |              | No POD specific requirements have been identified.           |
70 |              |                                                              |
71 +--------------+--------------------------------------------------------------+
72 |test sequence | description and expected result                              |
73 |              |                                                              |
74 +--------------+--------------------------------------------------------------+
75 |step 1        | The hosts are installed, as server and client. pktgen is     |
76 |              | invoked and logs are produced  and stored.                   |
77 |              |                                                              |
78 |              | Result: logs are stored.                                     |
79 |              |                                                              |
80 +--------------+--------------------------------------------------------------+
81 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
82 |              | execution problem.                                           |
83 |              |                                                              |
84 +--------------+--------------------------------------------------------------+