Add test case description and modify task file for TC004
[yardstick.git] / docs / userguide / opnfv_yardstick_tc005.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, Huawei Technologies Co.,Ltd and others.
5
6 *************************************
7 Yardstick Test Case Description TC005
8 *************************************
9
10 .. _fio: http://www.bluestop.org/fio/HOWTO.txt
11
12 +-----------------------------------------------------------------------------+
13 |Storage Performance                                                          |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC005_Storage Performance                    |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | IOPS, throughput and latency                                 |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | To evaluate the IaaS storage performance with regards to     |
23 |              | IOPS, throughput and latency.                                |
24 |              | The purpose is also to be able to spot trends. Test results, |
25 |              | graphs and similar shall be stored for comparison reasons    |
26 |              | and product evolution understanding between different OPNFV  |
27 |              | versions and/or configurations.                              |
28 |              |                                                              |
29 +--------------+--------------------------------------------------------------+
30 |configuration | file: opnfv_yardstick_tc005.yaml                             |
31 |              |                                                              |
32 |              | IO types: read, write, randwrite, randread, rw               |
33 |              | IO block size: 4KB, 64KB, 1024KB, where each                 |
34 |              | runs for 30 seconds(10 for ramp time, 20 for runtime).       |
35 |              |                                                              |
36 |              | For SLA minimum read/write iops is set to 100, minimum       |
37 |              | read/write throughput is set to 400 KB/s, and maximum        |
38 |              | read/write latency is set to 20000 usec.                     |
39 |              |                                                              |
40 +--------------+--------------------------------------------------------------+
41 |test tool     | fio                                                          |
42 |              |                                                              |
43 |              | (fio is not always part of a Linux distribution, hence it    |
44 |              | needs to be installed. As an example see the                 |
45 |              | /yardstick/tools/ directory for how to generate a Linux      |
46 |              | image with fio included.)                                    |
47 |              |                                                              |
48 +--------------+--------------------------------------------------------------+
49 |references    | fio_                                                         |
50 |              |                                                              |
51 |              | ETSI-NFV-TST001                                              |
52 |              |                                                              |
53 +--------------+--------------------------------------------------------------+
54 |applicability | Test can be configured with different read/write types, IO   |
55 |              | block size, IO depth, ramp time (runtime required for stable |
56 |              | results) and test duration. Default values exist.            |
57 |              |                                                              |
58 +--------------+--------------------------------------------------------------+
59 |pre-test      | The test case image needs to be installed into Glance        |
60 |conditions    | with fio included in it.                                     |
61 |              |                                                              |
62 |              | No POD specific requirements have been identified.           |
63 |              |                                                              |
64 +--------------+--------------------------------------------------------------+
65 |test sequence | description and expected result                              |
66 |              |                                                              |
67 +--------------+--------------------------------------------------------------+
68 |step 1        | The host is installed and fio is invoked and logs are        |
69 |              | produced and stored.                                         |
70 |              |                                                              |
71 |              | Result: Logs are stored.                                     |
72 |              |                                                              |
73 +--------------+--------------------------------------------------------------+
74 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
75 |              | execution problem.                                           |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+