docs/userguide/opnfv_yardstick_tc001.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, Ericsson AB and others.
   5
   6 *************************************
   7 Yardstick Test Case Description TC001
   8 *************************************
   9
  10 .. _pktgen: https://www.kernel.org/doc/Documentation/networking/pktgen.txt
  11
  12 +-----------------------------------------------------------------------------+
  13 |Network Performance                                                          |
  14 |                                                                             |
  15 +--------------+--------------------------------------------------------------+
  16 |test case id  | OPNFV_YARDSTICK_TC001_NW PERF                                |
  17 |              |                                                              |
  18 +--------------+--------------------------------------------------------------+
  19 |metric        | Number of flows and throughput                               |
  20 |              |                                                              |
  21 +--------------+--------------------------------------------------------------+
  22 |test purpose  | To evaluate the IaaS network performance with regards to     |
  23 |              | flows and throughput, such as if and how different amounts   |
  24 |              | of flows matter for the throughput between hosts on different|
  25 |              | compute blades. Typically e.g. the performance of a vSwitch  |
  26 |              | depends on the number of flows running through it. Also      |
  27 |              | performance of other equipment or entities can depend        |
  28 |              | on the number of flows or the packet sizes used.             |
  29 |              | The purpose is also to be able to spot trends. Test results, |
  30 |              | graphs ans similar shall be stored for comparison reasons and|
  31 |              | product evolution understanding between different OPNFV      |
  32 |              | versions and/or configurations.                              |
  33 |              |                                                              |
  34 +--------------+--------------------------------------------------------------+
  35 |configuration | file: opnfv_yardstick_tc001.yaml                             |
  36 |              |                                                              |
  37 |              | Packet size: 60 bytes                                        |
  38 |              | Number of ports: 10, 50, 100, 500 and 1000, where each       |
  39 |              | runs for 20 seconds. The whole sequence is run               |
  40 |              | twice. The client and server are distributed on different HW.|
  41 |              | For SLA max_ppm is set to 1000. The amount of configured     |
  42 |              | ports map to between 110 up to 1001000 flows, respectively.  |
  43 |              |                                                              |
  44 +--------------+--------------------------------------------------------------+
  45 |test tool     | pktgen                                                       |
  46 |              |                                                              |
  47 |              | (Pktgen 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    | pktgen_                                                      |
  55 |              |                                                              |
  56 |              | ETSI-NFV-TST001                                              |
  57 |              |                                                              |
  58 +--------------+--------------------------------------------------------------+
  59 |applicability | Test can be configured with different packet sizes, amount   |
  60 |              | of flows and test duration. Default values exist.            |
  61 |              |                                                              |
  62 |              | SLA (optional): max_ppm: The number of packets per million   |
  63 |              |  packets sent that are acceptable to loose, not received.    |
  64 |              |                                                              |
  65 +--------------+--------------------------------------------------------------+
  66 |pre-test      | The test case image needs to be installed into Glance        |
  67 |conditions    | with pktgen included in it.                                  |
  68 |              |                                                              |
  69 |              | No POD specific requirements have been identified.           |
  70 |              |                                                              |
  71 +--------------+--------------------------------------------------------------+
  72 |test sequence | description and expected result                              |
  73 |              |                                                              |
  74 +--------------+--------------------------------------------------------------+
  75 |step 1        | The hosts are installed, as server and client. pktgen is     |
  76 |              | invoked and logs are produced and stored.                    |
  77 |              |                                                              |
  78 |              | Result: Logs are stored.                                     |
  79 |              |                                                              |
  80 +--------------+--------------------------------------------------------------+
  81 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
  82 |              | execution problem.                                           |
  83 |              |                                                              |
  84 +--------------+--------------------------------------------------------------+