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