Rename folders in yardstick/docs
[yardstick.git] / docs / configguide / yardstick_testcases / opnfv_yardstick_tc002.rst
1 *************************************
2 Yardstick Test Case Description TC002
3 *************************************
4
5 .. _cirros-image: https://download.cirros-cloud.net
6
7 +-----------------------------------------------------------------------------+
8 |Network Latency                                                              |
9 |                                                                             |
10 +--------------+--------------------------------------------------------------+
11 |test case id  | OPNFV_YARDSTICK_TC002_NW LATENCY                             |
12 |              |                                                              |
13 +--------------+--------------------------------------------------------------+
14 |metric        | RTT, Round Trip Time                                         |
15 |              |                                                              |
16 +--------------+--------------------------------------------------------------+
17 |test purpose  | To do a basic verification that network latency is within    |
18 |              | acceptable boundaries when packets travel between hosts      |
19 |              | located on same or different compute blades.                 |
20 |              | The purpose is also to be able to spot trends. Test results, |
21 |              | graphs and similar shall be stored for comparison reasons and|
22 |              | product evolution understanding between different OPNFV      |
23 |              | versions and/or configurations.                              |
24 |              |                                                              |
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 +--------------+--------------------------------------------------------------+
32 |test tool     | ping                                                         |
33 |              |                                                              |
34 |              | Ping is normally part of any Linux distribution, hence it    |
35 |              | doesn't need to be installed. It is also part of the         |
36 |              | Yardstick Docker image.                                      |
37 |              | (For example also a Cirros image can be downloaded from      |
38 |              | cirros-image_, it includes ping)                             |
39 |              |                                                              |
40 +--------------+--------------------------------------------------------------+
41 |references    | Ping man page                                                |
42 |              |                                                              |
43 |              | ETSI-NFV-TST001                                              |
44 |              |                                                              |
45 +--------------+--------------------------------------------------------------+
46 |applicability | Test case can be configured with different packet sizes,     |
47 |              | burst sizes, ping intervals and test duration.               |
48 |              | SLA is optional. The SLA in this test case serves as an      |
49 |              | example. Considerably lower RTT is expected, and             |
50 |              | also normal to achieve in balanced L2 environments. However, |
51 |              | to cover most configurations, both bare metal and fully      |
52 |              | virtualized ones, this value should be possible to achieve   |
53 |              | and acceptable for black box testing. Many real time         |
54 |              | applications start to suffer badly if the RTT time is higher |
55 |              | than this. Some may suffer bad also close to this RTT, while |
56 |              | others may not suffer at all. It is a compromise that may    |
57 |              | have to be tuned for different configuration purposes.       |
58 |              |                                                              |
59 +--------------+--------------------------------------------------------------+
60 |pre-test      | The test case image needs to be installed into Glance        |
61 |conditions    | with ping included in it.                                    |
62 |              |                                                              |
63 |              | No POD specific requirements have been identified.           |
64 |              |                                                              |
65 +--------------+--------------------------------------------------------------+
66 |test sequence | description and expected result                              |
67 |              |                                                              |
68 +--------------+--------------------------------------------------------------+
69 |step 1        | The hosts are installed, as server and client. Ping is       |
70 |              | invoked and logs are produced and stored.                    |
71 |              |                                                              |
72 |              | Result: Logs are stored.                                     |
73 |              |                                                              |
74 +--------------+--------------------------------------------------------------+
75 |test verdict  | Test should not PASS if any RTT is above the optional SLA    |
76 |              | value, or if there is a test case execution problem.         |
77 |              |                                                              |
78 +--------------+--------------------------------------------------------------+