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