docs/userguide/opnfv_yardstick_tc011.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 TC011
   8 *************************************
   9
  10 .. _iperf3: https://iperf.fr/
  11
  12 +-----------------------------------------------------------------------------+
  13 |Packet delay variation between VMs                                           |
  14 |                                                                             |
  15 +--------------+--------------------------------------------------------------+
  16 |test case id  | OPNFV_YARDSTICK_TC011_Packet delay variation between VMs     |
  17 |              |                                                              |
  18 +--------------+--------------------------------------------------------------+
  19 |metric        | jitter: packet delay variation (ms)                          |
  20 |              |                                                              |
  21 +--------------+--------------------------------------------------------------+
  22 |test purpose  | Measure the packet delay variation sending the packets from  |
  23 |              | one VM to the other.                                         |
  24 |              |                                                              |
  25 +--------------+--------------------------------------------------------------+
  26 |configuration | File: opnfv_yardstick_tc011.yaml                             |
  27 |              |                                                              |
  28 |              | * options:                                                   |
  29 |              |   protocol: udp # The protocol used by iperf3 tools          |
  30 |              |   bandwidth: 20m # It will send the given number of packets  |
  31 |              |                    without pausing                           |
  32 |              | * runner:                                                    |
  33 |              |   duration: 30 # Total test duration 30 seconds.             |
  34 |              |                                                              |
  35 |              | * SLA (optional):                                            |
  36 |              |   jitter: 10 (ms) # The maximum amount of jitter that is     |
  37 |              |     accepted.                                                |
  38 |              |                                                              |
  39 +--------------+--------------------------------------------------------------+
  40 |test tool     | iperf3                                                       |
  41 |              |                                                              |
  42 |              | iPerf3 is a tool for active measurements of the maximum      |
  43 |              | achievable bandwidth on IP networks. It supports tuning of   |
  44 |              | various parameters related to timing, buffers and protocols. |
  45 |              | The UDP protocols can be used to measure jitter delay.       |
  46 |              |                                                              |
  47 |              | (iperf3 is not always part of a Linux distribution, hence it |
  48 |              | needs to be installed. It is part of the Yardstick Docker    |
  49 |              | image.                                                       |
  50 |              | As an example see the /yardstick/tools/ directory for how    |
  51 |              | to generate a Linux image with pktgen included.)             |
  52 |              |                                                              |
  53 +--------------+--------------------------------------------------------------+
  54 |references    | iperf3_                                                      |
  55 |              |                                                              |
  56 |              | ETSI-NFV-TST001                                              |
  57 |              |                                                              |
  58 +--------------+--------------------------------------------------------------+
  59 |applicability | Test can be configured with different                        |
  60 |              |                                                              |
  61 |              | * bandwidth: Test case can be configured with different      |
  62 |              |              bandwidth                                       |
  63 |              |                                                              |
  64 |              | * duration: The test duration can be configured              |
  65 |              |                                                              |
  66 |              | * jitter: SLA is optional. The SLA in this test case         |
  67 |              |           serves as an example.                              |
  68 |              |                                                              |
  69 +--------------+--------------------------------------------------------------+
  70 |pre-test      | The test case image needs to be installed into Glance        |
  71 |conditions    | with iperf3 included in the image.                           |
  72 |              |                                                              |
  73 |              | No POD specific requirements have been identified.           |
  74 |              |                                                              |
  75 +--------------+--------------------------------------------------------------+
  76 |test sequence | description and expected result                              |
  77 |              |                                                              |
  78 +--------------+--------------------------------------------------------------+
  79 |step 1        | The hosts are installed, as server and client. iperf3 is     |
  80 |              | invoked and logs are produced and stored.                    |
  81 |              |                                                              |
  82 |              | Result: Logs are stored.                                     |
  83 |              |                                                              |
  84 +--------------+--------------------------------------------------------------+
  85 |test verdict  | Test should not PASS if any jitter is above the optional SLA |
  86 |              | value, or if there is a test case execution problem.         |
  87 |              |                                                              |
  88 +--------------+--------------------------------------------------------------+