07d7fbfea81aef93a82e0967ca28286cd6d77df6
[yardstick.git] / docs / yardstick / opnfv_yardstick_tc009.rst
1 *************************************
2 Yardstick Test Case Description TC009
3 *************************************
4 +-----------------------------------------------------------------------------+
5 |Network Performance                                                          |
6 +==============+==============================================================+
7 |test case id  | OPNFV_YARDSTICK_TC009_NW PERF, Packet loss                   |
8 +--------------+--------------------------------------------------------------+
9 |metric        | Number of flows and throughput                               |
10 +--------------+--------------------------------------------------------------+
11 |test purpose  | To evaluate the IaaS network performance with regards to     |
12 |              | flows and throughput, such as if and how different amounts   |
13 |              | of flows matter for the throughput between VMs on different  |
14 |              | compute blades.                                              |
15 |              | Typically e.g. the performance of a vSwitch                  |
16 |              | depends on the number of flows running through it. Also      |
17 |              | performance of other equipment or entities can depend        |
18 |              | on the number of flows or the packet sizes used.             |
19 |              | The purpose is also to be able to spot trends. Test results, |
20 |              | graphs ans similar shall be stored for comparison reasons and|
21 |              | product evolution understanding between different OPNFV      |
22 |              | versions and/or configurations.                              |
23 +--------------+--------------------------------------------------------------+
24 |configuration | file: opnfv_yardstick_tc009.yaml                             |
25 |              |                                                              |
26 |              | Packet size: 64 bytes                                        |
27 |              |                                                              |
28 |              | Number of ports: 1, 10, 50, 100, 500 and 1000. The amount of |
29 |              | configured ports map from 2 up to 1001000 flows,             |
30 |              | respectively. Each port amount is run ten times, for 20      |
31 |              | seconds each. Then the next port_amount is run, and so on.   |
32 |              |                                                              |
33 |              | The client and server are distributed on different HW.       |
34 |              |                                                              |
35 |              | For SLA max_ppm is set to 1000.                              |
36 +--------------+--------------------------------------------------------------+
37 |test tool     | pktgen                                                       |
38 |              |                                                              |
39 |              | (Pktgen is not always part of a Linux distribution, hence it |
40 |              | needs to be installed. It is part of the Yardstick Docker    |
41 |              | image.                                                       |
42 |              | As an example see the /yardstick/tools/ directory for how    |
43 |              | to generate a Linux image with pktgen included.)             |
44 +--------------+--------------------------------------------------------------+
45 |references    |https://www.kernel.org/doc/Documentation/networking/pktgen.txt|
46 |              |                                                              |
47 |              |ETSI-NFV-TST001                                               |
48 +--------------+--------------------------------------------------------------+
49 |applicability | Test can be configured with different packet sizes, amount   |
50 |              | of flows and test duration. Default values exist.            |
51 |              |                                                              |
52 |              |SLA (optional):                                               |
53 |              |    max_ppm: The number of packets per million packets sent   |
54 |              |             that are acceptable to lose, i.e. not received.  |
55 +--------------+--------------------------------------------------------------+
56 |pre-test      | The test case image needs to be installed into Glance        |
57 |conditions    | with pktgen included in it.                                  |
58 |              |                                                              |
59 |              | No POD specific requirements have been identified.           |
60 +--------------+------+----------------------------------+--------------------+
61 |test sequence | step | description                      | result             |
62 |              +------+----------------------------------+--------------------+
63 |              |  1   | The hosts are installed, as      | Logs are stored    |
64 |              |      | server and client. pktgen is     |                    |
65 |              |      | invoked and logs are produced    |                    |
66 |              |      | and stored.                      |                    |
67 +--------------+------+----------------------------------+--------------------+
68 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
69 |              | execution problem.                                           |
70 +--------------+--------------------------------------------------------------+