Adds new test case descriptions
[yardstick.git] / docs / yardstick / opnfv_yardstick_tc002.rst
1 .. image:: ../../etc/opnfv-logo.png
2   :height: 40
3   :width: 200
4   :alt: OPNFV
5   :align: left
6
7 *************************************
8 Yardstick Test Case Description TC002
9 *************************************
10
11 +-----------------------------------------------------------------------------+
12 |Network Latency                                                              |
13 +==============+==============================================================+
14 |test case id  | OPNFV_YARDSTICK_TC002_NW LATENCY                             |
15 +--------------+--------------------------------------------------------------+
16 |metric        | RTT, Round Trip Time                                         |
17 +--------------+--------------------------------------------------------------+
18 |test purpose  | To do a basic verification that network latency is within    |
19 |              | acceptable boundaries when packets travel between hosts      |
20 |              | located on same or different compute blades.                 |
21 |              | The purpose is also to be able to spot trends. Test results, |
22 |              | graphs and similar shall be stored for comparison reasons and|
23 |              | product evolution understanding between different OPNFV      |
24 |              | versions and/or configurations.                              |
25 +--------------+--------------------------------------------------------------+
26 |configuration | file: opnfv_yardstick_tc002.yaml                             |
27 |              |                                                              |
28 |              | Packet size 100 bytes. Total test duration 600 seconds.      |
29 |              | One ping each 10 seconds. SLA RTT is set to maximum 10 ms.   |
30 +--------------+--------------------------------------------------------------+
31 |test tool     | ping                                                         |
32 |              |                                                              |
33 |              | Ping is normally part of any Linux distribution, hence it    |
34 |              | doesn't need to be installed. It is also part of the         |
35 |              | Yardstick Docker image.                                      |
36 |              | (For example also a Cirros image can be downloaded from      |
37 |              | https://download.cirros-cloud.net, it includes ping)         |
38 +--------------+--------------------------------------------------------------+
39 |references    | Ping man page                                                |
40 |              |                                                              |
41 |              | ETSI-NFV-TST001                                              |
42 +--------------+--------------------------------------------------------------+
43 |applicability | Test case can be configured with different packet sizes,     |
44 |              | burst sizes, ping intervals and test duration.               |
45 |              | SLA is optional. The SLA in this test case serves as an      |
46 |              | example. Considerably lower RTT is expected, and             |
47 |              | also normal to achieve in balanced L2 environments. However, |
48 |              | to cover most configurations, both bare metal and fully      |
49 |              | virtualized ones, this value should be possible to achieve   |
50 |              | and acceptable for black box testing. Many real time         |
51 |              | applications start to suffer badly if the RTT time is higher |
52 |              | than this. Some may suffer bad also close to this RTT, while |
53 |              | others may not suffer at all. It is a compromise that may    |
54 |              | have to be tuned for different configuration purposes.       |
55 +--------------+--------------------------------------------------------------+
56 |pre-test      | The test case image needs to be installed into Glance        |
57 |conditions    | with ping 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. Ping is       |                    |
65 |              |      | invoked and logs are produced    |                    |
66 |              |      | and stored.                      |                    |
67 +--------------+------+----------------------------------+--------------------+
68 |test verdict  | Test should not PASS if any RTT is above the optional SLA    |
69 |              | value, or if there is a test case execution problem.         |
70 +--------------+--------------------------------------------------------------+
71