summaryrefslogtreecommitdiffstats
path: root/docs/userguide/opnfv_yardstick_tc005.rst
diff options
context:
space:
mode:
authorJingLu5 <lvjing5@huawei.com>2016-11-15 11:42:10 +0800
committerJingLu5 <lvjing5@huawei.com>2016-12-05 08:39:24 +0800
commit8272a44abd449661e78b9a9945f9ca9677fe98a8 (patch)
tree88f6a6032c28abe973e1419390ee92775f8c9c5c /docs/userguide/opnfv_yardstick_tc005.rst
parenteeeca4f0cdeff152ec061bb9b40ae305547c027e (diff)
enhance test cases description and provide more info(in progress)
JIRA: YARDSTICK-389 This work is about to improve test case.rst to provide more info Change-Id: If27fe462a43f6344a06e61944b72e912d2a516b7 Signed-off-by: JingLu5 <lvjing5@huawei.com>
Diffstat (limited to 'docs/userguide/opnfv_yardstick_tc005.rst')
-rw-r--r--docs/userguide/opnfv_yardstick_tc005.rst102
1 files changed, 75 insertions, 27 deletions
diff --git a/docs/userguide/opnfv_yardstick_tc005.rst b/docs/userguide/opnfv_yardstick_tc005.rst
index a181aa9f7..1c2d71d81 100644
--- a/docs/userguide/opnfv_yardstick_tc005.rst
+++ b/docs/userguide/opnfv_yardstick_tc005.rst
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International
+. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
@@ -7,53 +7,88 @@
Yardstick Test Case Description TC005
*************************************
-.. _fio: http://www.bluestop.org/fio/HOWTO.txt
+.. _fio: http://bluestop.org/files/fio/HOWTO.txt
+-----------------------------------------------------------------------------+
|Storage Performance |
| |
+--------------+--------------------------------------------------------------+
-|test case id | OPNFV_YARDSTICK_TC005_Storage Performance |
+|test case id | OPNFV_YARDSTICK_TC005_STORAGE PERFORMANCE |
| | |
+--------------+--------------------------------------------------------------+
-|metric | IOPS, throughput and latency |
+|metric | IOPS (Average IOs performed per second), |
+| | Throughput (Average disk read/write bandwidth rate), |
+| | Latency (Average disk read/write latency) |
| | |
+--------------+--------------------------------------------------------------+
-|test purpose | To evaluate the IaaS storage performance with regards to |
-| | IOPS, throughput and latency. |
-| | The purpose is also to be able to spot trends. Test results, |
-| | graphs and similar shall be stored for comparison reasons |
-| | and product evolution understanding between different OPNFV |
-| | versions and/or configurations. |
+|test purpose | The purpose of TC005 is to evaluate the IaaS storage |
+| | performance with regards to IOPS, throughput and latency. |
| | |
-+--------------+--------------------------------------------------------------+
-|configuration | file: opnfv_yardstick_tc005.yaml |
-| | |
-| | IO types: read, write, randwrite, randread, rw |
-| | IO block size: 4KB, 64KB, 1024KB, where each |
-| | runs for 30 seconds(10 for ramp time, 20 for runtime). |
-| | |
-| | For SLA minimum read/write iops is set to 100, minimum |
-| | read/write throughput is set to 400 KB/s, and maximum |
-| | read/write latency is set to 20000 usec. |
+| | The purpose is also to be able to spot the trends. |
+| | Test results, graphs and similar shall be stored for |
+| | comparison reasons and product evolution understanding |
+| | between different OPNFV versions and/or configurations. |
| | |
+--------------+--------------------------------------------------------------+
|test tool | fio |
| | |
+| | fio is an I/O tool meant to be used both for benchmark and |
+| | stress/hardware verification. It has support for 19 |
+| | different types of I/O engines (sync, mmap, libaio, |
+| | posixaio, SG v3, splice, null, network, syslet, guasi, |
+| | solarisaio, and more), I/O priorities (for newer Linux |
+| | kernels), rate I/O, forked or threaded jobs, and much more. |
+| | |
| | (fio is not always part of a Linux distribution, hence it |
| | needs to be installed. As an example see the |
| | /yardstick/tools/ directory for how to generate a Linux |
| | image with fio included.) |
| | |
+--------------+--------------------------------------------------------------+
-|references | fio_ |
+|test | fio test is invoked in a host VM on a compute blade, a job |
+|description | file as well as parameters are passed to fio and fio will |
+| | start doing what the job file tells it to do. |
| | |
-| | ETSI-NFV-TST001 |
++--------------+--------------------------------------------------------------+
+|configuration | file: opnfv_yardstick_tc005.yaml |
+| | |
+| | IO types is set to read, write, randwrite, randread, rw. |
+| | IO block size is set to 4KB, 64KB, 1024KB. |
+| | fio is run for each IO type and IO block size scheme, |
+| | each iteration runs for 30 seconds (10 for ramp time, 20 for |
+| | runtime). |
+| | |
+| | For SLA, minimum read/write iops is set to 100, |
+| | minimum read/write throughput is set to 400 KB/s, |
+| | and maximum read/write latency is set to 20000 usec. |
| | |
+--------------+--------------------------------------------------------------+
-|applicability | Test can be configured with different read/write types, IO |
-| | block size, IO depth, ramp time (runtime required for stable |
-| | results) and test duration. Default values exist. |
+|applicability | This test case can be configured with different: |
+| | |
+| | * IO types; |
+| | * IO block size; |
+| | * IO depth; |
+| | * ramp time; |
+| | * test duration. |
+| | |
+| | Default values exist. |
+| | |
+| | SLA is optional. The SLA in this test case serves as an |
+| | example. Considerably higher throughput and lower latency |
+| | are expected. However, to cover most configurations, both |
+| | baremetal and fully virtualized ones, this value should be |
+| | possible to achieve and acceptable for black box testing. |
+| | Many heavy IO applications start to suffer badly if the |
+| | read/write bandwidths are lower than this. |
+| | |
++--------------+--------------------------------------------------------------+
+|usability | This test case is one of Yardstick's generic test. Thus it |
+| | is runnable on most of the scenarios. |
+| | |
++--------------+--------------------------------------------------------------+
+|references | fio_ |
+| | |
+| | ETSI-NFV-TST001 |
| | |
+--------------+--------------------------------------------------------------+
|pre-test | The test case image needs to be installed into Glance |
@@ -65,12 +100,25 @@ Yardstick Test Case Description TC005
|test sequence | description and expected result |
| | |
+--------------+--------------------------------------------------------------+
-|step 1 | The host is installed and fio is invoked and logs are |
-| | produced and stored. |
+|step 1 | A host VM with fio installed is booted. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 2 | Yardstick is connected with the host VM by using ssh. |
+| | 'fio_benchmark' bash script is copyied from Jump Host to |
+| | the host VM via the ssh tunnel. |
+| | |
++--------------+--------------------------------------------------------------+
+|step 3 | 'fio_benchmark' script is invoked. Simulated IO operations |
+| | are started. IOPS, disk read/write bandwidth and latency are |
+| | recorded and checked against the SLA. Logs are produced and |
+| | stored. |
| | |
| | Result: Logs are stored. |
| | |
+--------------+--------------------------------------------------------------+
+|step 4 | The host VM is deleted. |
+| | |
++--------------+--------------------------------------------------------------+
|test verdict | Fails only if SLA is not passed, or if there is a test case |
| | execution problem. |
| | |