Adding scale up feature to prox MPLS Tagging OvS-DPDK & SRIOV
[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc006.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 TC006
8 *************************************
9
10 .. _fio: http://bluestop.org/files/fio/HOWTO.txt
11
12 +-----------------------------------------------------------------------------+
13 |Volume storage Performance                                                   |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC006_VOLUME STORAGE PERFORMANCE             |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | IOPS (Average IOs performed per second),                     |
20 |              | Throughput (Average disk read/write bandwidth rate),         |
21 |              | Latency (Average disk read/write latency)                    |
22 |              |                                                              |
23 +--------------+--------------------------------------------------------------+
24 |test purpose  | The purpose of TC006 is to evaluate the IaaS volume storage  |
25 |              | performance with regards to IOPS, throughput and latency.    |
26 |              |                                                              |
27 |              | The purpose is also to be able to spot the trends.           |
28 |              | Test results, graphs and similar shall be stored for         |
29 |              | comparison reasons and product evolution understanding       |
30 |              | between different OPNFV versions and/or configurations.      |
31 |              |                                                              |
32 +--------------+--------------------------------------------------------------+
33 |test tool     | fio                                                          |
34 |              |                                                              |
35 |              | fio is an I/O tool meant to be used both for benchmark and   |
36 |              | stress/hardware verification. It has support for 19          |
37 |              | different types of I/O engines (sync, mmap, libaio,          |
38 |              | posixaio, SG v3, splice, null, network, syslet, guasi,       |
39 |              | solarisaio, and more), I/O priorities (for newer Linux       |
40 |              | kernels), rate I/O, forked or threaded jobs, and much more.  |
41 |              |                                                              |
42 |              | (fio is not always part of a Linux distribution, hence it    |
43 |              | needs to be installed. As an example see the                 |
44 |              | /yardstick/tools/ directory for how to generate a Linux      |
45 |              | image with fio included.)                                    |
46 |              |                                                              |
47 +--------------+--------------------------------------------------------------+
48 |test          | fio test is invoked in a host VM with a volume attached on a |
49 |description   | compute blade, a job file as well as parameters are passed   |
50 |              | to fio and fio will start doing what the job file tells it   |
51 |              | to do.                                                       |
52 |              |                                                              |
53 +--------------+--------------------------------------------------------------+
54 |configuration | file: opnfv_yardstick_tc006.yaml                             |
55 |              |                                                              |
56 |              | Fio job file is provided to define the benchmark process     |
57 |              | Target volume is mounted at /FIO_Test directory              |
58 |              |                                                              |
59 |              | For SLA, minimum read/write iops is set to 100,              |
60 |              | minimum read/write throughput is set to 400 KB/s,            |
61 |              | and maximum read/write latency is set to 20000 usec.         |
62 |              |                                                              |
63 +--------------+--------------------------------------------------------------+
64 |applicability | This test case can be configured with different:             |
65 |              |                                                              |
66 |              |   * Job file;                                                |
67 |              |   * Volume mount directory.                                  |
68 |              |                                                              |
69 |              | SLA is optional. The SLA in this test case serves as an      |
70 |              | example. Considerably higher throughput and lower latency    |
71 |              | are expected. However, to cover most configurations, both    |
72 |              | baremetal and fully virtualized  ones, this value should be  |
73 |              | possible to achieve and acceptable for black box testing.    |
74 |              | Many heavy IO applications start to suffer badly if the      |
75 |              | read/write bandwidths are lower than this.                   |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |usability     | This test case is one of Yardstick's generic test. Thus it   |
79 |              | is runnable on most of the scenarios.                        |
80 |              |                                                              |
81 +--------------+--------------------------------------------------------------+
82 |references    | fio_                                                         |
83 |              |                                                              |
84 |              | ETSI-NFV-TST001                                              |
85 |              |                                                              |
86 +--------------+--------------------------------------------------------------+
87 |pre-test      | The test case image needs to be installed into Glance        |
88 |conditions    | with fio included in it.                                     |
89 |              |                                                              |
90 |              | No POD specific requirements have been identified.           |
91 |              |                                                              |
92 +--------------+--------------------------------------------------------------+
93 |test sequence | description and expected result                              |
94 |              |                                                              |
95 +--------------+--------------------------------------------------------------+
96 |step 1        | A host VM with fio installed is booted.                      |
97 |              | A 200G volume is attached to the host VM                     |
98 |              |                                                              |
99 +--------------+--------------------------------------------------------------+
100 |step 2        | Yardstick is connected with the host VM by using ssh.        |
101 |              | 'job_file.ini' is copyied from Jump Host to the host VM via  |
102 |              | the ssh tunnel. The attached volume is formated and mounted. |
103 |              |                                                              |
104 +--------------+--------------------------------------------------------------+
105 |step 3        | Fio benchmark is invoked. Simulated IO operations are        |
106 |              | started. IOPS, disk read/write bandwidth and latency are     |
107 |              | recorded and checked against the SLA. Logs are produced and  |
108 |              | stored.                                                      |
109 |              |                                                              |
110 |              | Result: Logs are stored.                                     |
111 |              |                                                              |
112 +--------------+--------------------------------------------------------------+
113 |step 4        | The host VM is deleted.                                      |
114 |              |                                                              |
115 +--------------+--------------------------------------------------------------+
116 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
117 |              | execution problem.                                           |
118 |              |                                                              |
119 +--------------+--------------------------------------------------------------+