docs/testing/user/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://bluestop.org/files/fio/HOWTO.txt
  11
  12 +-----------------------------------------------------------------------------+
  13 |Storage Performance                                                          |
  14 |                                                                             |
  15 +--------------+--------------------------------------------------------------+
  16 |test case id  | OPNFV_YARDSTICK_TC005_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 TC005 is to evaluate the IaaS 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 on a compute blade, a job   |
  49 |description   | file as well as parameters are passed to fio and fio will    |
  50 |              | start doing what the job file tells it to do.                |
  51 |              |                                                              |
  52 +--------------+--------------------------------------------------------------+
  53 |configuration | file: opnfv_yardstick_tc005.yaml                             |
  54 |              |                                                              |
  55 |              | IO types is set to read, write, randwrite, randread, rw.     |
  56 |              | IO block size is set to 4KB, 64KB, 1024KB.                   |
  57 |              | fio is run for each IO type and IO block size scheme,        |
  58 |              | each iteration runs for 30 seconds (10 for ramp time, 20 for |
  59 |              | runtime).                                                    |
  60 |              |                                                              |
  61 |              | For SLA, minimum read/write iops is set to 100,              |
  62 |              | minimum read/write throughput is set to 400 KB/s,            |
  63 |              | and maximum read/write latency is set to 20000 usec.         |
  64 |              |                                                              |
  65 +--------------+--------------------------------------------------------------+
  66 |applicability | This test case can be configured with different:             |
  67 |              |                                                              |
  68 |              |   * IO types;                                                |
  69 |              |   * IO block size;                                           |
  70 |              |   * IO depth;                                                |
  71 |              |   * ramp time;                                               |
  72 |              |   * test duration.                                           |
  73 |              |                                                              |
  74 |              | Default values exist.                                        |
  75 |              |                                                              |
  76 |              | SLA is optional. The SLA in this test case serves as an      |
  77 |              | example. Considerably higher throughput and lower latency    |
  78 |              | are expected. However, to cover most configurations, both    |
  79 |              | baremetal and fully virtualized  ones, this value should be  |
  80 |              | possible to achieve and acceptable for black box testing.    |
  81 |              | Many heavy IO applications start to suffer badly if the      |
  82 |              | read/write bandwidths are lower than this.                   |
  83 |              |                                                              |
  84 +--------------+--------------------------------------------------------------+
  85 |usability     | This test case is one of Yardstick's generic test. Thus it   |
  86 |              | is runnable on most of the scenarios.                        |
  87 |              |                                                              |
  88 +--------------+--------------------------------------------------------------+
  89 |references    | fio_                                                         |
  90 |              |                                                              |
  91 |              | ETSI-NFV-TST001                                              |
  92 |              |                                                              |
  93 +--------------+--------------------------------------------------------------+
  94 |pre-test      | The test case image needs to be installed into Glance        |
  95 |conditions    | with fio included in it.                                     |
  96 |              |                                                              |
  97 |              | No POD specific requirements have been identified.           |
  98 |              |                                                              |
  99 +--------------+--------------------------------------------------------------+
 100 |test sequence | description and expected result                              |
 101 |              |                                                              |
 102 +--------------+--------------------------------------------------------------+
 103 |step 1        | A host VM with fio installed is booted.                      |
 104 |              |                                                              |
 105 +--------------+--------------------------------------------------------------+
 106 |step 2        | Yardstick is connected with the host VM by using ssh.        |
 107 |              | 'fio_benchmark' bash script is copyied from Jump Host to     |
 108 |              | the host VM via the ssh tunnel.                              |
 109 |              |                                                              |
 110 +--------------+--------------------------------------------------------------+
 111 |step 3        | 'fio_benchmark' script is invoked. Simulated IO operations   |
 112 |              | are started. IOPS, disk read/write bandwidth and latency are |
 113 |              | recorded and checked against the SLA. Logs are produced and  |
 114 |              | stored.                                                      |
 115 |              |                                                              |
 116 |              | Result: Logs are stored.                                     |
 117 |              |                                                              |
 118 +--------------+--------------------------------------------------------------+
 119 |step 4        | The host VM is deleted.                                      |
 120 |              |                                                              |
 121 +--------------+--------------------------------------------------------------+
 122 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
 123 |              | execution problem.                                           |
 124 |              |                                                              |
 125 +--------------+--------------------------------------------------------------+