1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 The *Yardstick framework*, the *Yardstick test cases* are open-source software,
5 licensed under the terms of the Apache License, Version 2.0.
7 =======================
8 Yardstick Release Notes
9 =======================
14 .. _Yardstick: https://wiki.opnfv.org/display/yardstick
16 .. _Dashboard: http://testresults.opnfv.org/grafana/
18 .. _NFV-TST001: https://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
24 This document compiles the release notes for the Gambia release of OPNFV Yardstick.
29 +-------------------+-----------+---------------------------------+
30 | *Date* | *Version* | *Comment* |
32 +-------------------+-----------+---------------------------------+
33 | November 9, 2018 | 7.0.0 | Yardstick for Gambia release |
35 +-------------------+-----------+---------------------------------+
36 | December 14, 2018 | 7.1.0 | Yardstick for Gambia release |
38 +-------------------+-----------+---------------------------------+
39 | January 25, 2019 | 7.2.0 | Yardstick for Gambia release |
41 +-------------------+-----------+---------------------------------+
47 The software delivered in the OPNFV Yardstick_ Project, comprising the
48 *Yardstick framework*, and the *Yardstick test cases* is a realization of
49 the methodology in ETSI-ISG NFV-TST001_.
51 The *Yardstick* framework is *installer*, *infrastructure* and *application*
57 This Gambia release provides *Yardstick* as a framework for NFVI testing
58 and OPNFV feature testing, automated in the OPNFV CI pipeline, including:
60 * Documentation generated with Sphinx
64 * Release notes (this document)
67 * Automated Yardstick test suite (daily, weekly)
69 * Jenkins Jobs for OPNFV community labs
71 * Automated Yardstick test results visualization
73 * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
76 * Yardstick framework source code
78 * Yardstick test cases yaml files
80 * Yardstick plug-in configuration yaml files, plug-in install/remove scripts
82 For Gambia release, the *Yardstick framework* is used for the following
85 * OPNFV platform testing - generic test cases to measure the categories:
91 * OPNFV platform network service benchmarking (NSB)
95 * Test cases for the following OPNFV Projects:
105 The *Yardstick framework* is developed in the OPNFV community, by the
108 .. note:: The test case description template used for the Yardstick test cases
109 is based on the document ETSI-ISG NFV-TST001_; the results report template
110 used for the Yardstick results is based on the IEEE Std 829-2008.
116 +--------------------------------+-----------------------+
117 | **Project** | Yardstick |
119 +--------------------------------+-----------------------+
120 | **Repo/tag** | yardstick/opnfv-7.2.0 |
122 +--------------------------------+-----------------------+
123 | **Yardstick Docker image tag** | opnfv-7.2.0 |
125 +--------------------------------+-----------------------+
126 | **Release designation** | Gambia 7.2 |
128 +--------------------------------+-----------------------+
129 | **Release date** | January 25, 2019 |
131 +--------------------------------+-----------------------+
132 | **Purpose of the delivery** | OPNFV Gambia 7.2.0 |
134 +--------------------------------+-----------------------+
143 - User Guide: :ref:`<yardstick:userguide>`
145 - Developer Guide: :ref:`<yardstick:devguide>`
148 Software Deliverables
149 ---------------------
151 - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-7.0.0)
156 +--------------+-------------------------------------------+
157 | **Context** | **Description** |
159 +--------------+-------------------------------------------+
160 | *Heat* | Models orchestration using OpenStack Heat |
162 +--------------+-------------------------------------------+
163 | *Node* | Models Baremetal, Controller, Compute |
165 +--------------+-------------------------------------------+
166 | *Standalone* | Models VM running on Non-Managed NFVi |
168 +--------------+-------------------------------------------+
169 | *Kubernetes* | Models VM running on Non-Managed NFVi |
171 +--------------+-------------------------------------------+
177 .. note:: Yardstick Gambia 7.0.0 adds 1 new Runner, "IterationIPC".
179 +----------------+-------------------------------------------------------+
180 | **Runner** | **Description** |
182 +----------------+-------------------------------------------------------+
183 | *Arithmetic* | Steps every run arithmetically according to specified |
186 +----------------+-------------------------------------------------------+
187 | *Duration* | Runs for a specified period of time |
189 +----------------+-------------------------------------------------------+
190 | *Iteration* | Runs for a specified number of iterations |
192 +----------------+-------------------------------------------------------+
193 | *IterationIPC* | Runs a configurable number of times before it |
194 | | returns. Each iteration has a configurable timeout. |
196 +----------------+-------------------------------------------------------+
197 | *Sequence* | Selects input value to a scenario from an input file |
198 | | and runs all entries sequentially |
200 +----------------+-------------------------------------------------------+
201 | *Dynamictp* | A runner that searches for the max throughput with |
204 +----------------+-------------------------------------------------------+
205 | *Search* | A runner that runs a specific time before it returns |
207 +----------------+-------------------------------------------------------+
213 +----------------+-----------------------------------------------------+
214 | **Category** | **Delivered** |
216 +----------------+-----------------------------------------------------+
217 | *Availability* | Attacker: |
219 | | * baremetal, process |
223 | | * check host, openstack, process, service |
225 | | * start/stop service |
229 | | * command, process |
231 +----------------+-----------------------------------------------------+
232 | *Compute* | * cpuload |
235 | | * lmbench_cache |
241 | | * computecapacity |
244 +----------------+-----------------------------------------------------+
245 | *Networking* | * iperf3 |
252 | | * sfc with tacker |
253 | | * networkcapacity |
254 | | * netutilization |
258 +----------------+-----------------------------------------------------+
259 | *Parser* | Tosca2Heat |
261 +----------------+-----------------------------------------------------+
262 | *Storage* | * fio |
264 | | * storagecapacity |
266 +----------------+-----------------------------------------------------+
267 | *StorPerf* | storperf |
269 +----------------+-----------------------------------------------------+
270 | *NSB* | vFW thoughput test case |
272 +----------------+-----------------------------------------------------+
278 .. note:: Yardstick Gambia 7.2.0 adds no new test cases.
280 * Generic NFVI test cases
282 * (e.g.) OPNFV_YARDSTICK_TCO84 - SPEC CPU 2006 for VM
286 * (e.g.) OPNFV_YARDSTICK_TC093 - SDN Vswitch resilience in non-HA or HA configuration
292 Module Version Changes
293 ----------------------
295 This is the seventh tracked release of Yardstick. It is based on following
299 - OpenDayLight Oxygen
302 Document Version Changes
303 ------------------------
305 This is the seventh tracked version of the Yardstick framework in OPNFV.
306 It includes the following documentation updates:
308 - Yardstick User Guide:
310 - Remove vTC chapter;
312 - Yardstick Developer Guide
313 - Yardstick Release Notes for Yardstick: this document
319 - Simplify Yardstick installation to use a single ansible playbook (nsb_setup.yaml)....
322 - Agnostic VNF tests cases for reuse of standard RFC-2544 test case.
323 - PROX enhancements and the addition of Standalone test case using SRIOV and
325 - Ixia enhancements for vBNG and PPPoE traffic.
326 - Improvements of unit tests and gating.
327 - Add DPDK pktgen traffic generator.
328 - Kubernetes context enhancements.
329 - Kubernetes sample test cases of fio and lmbench added.
335 For Gambia 7.2.0, Yardstick was tested on the following scenarios:
337 +-------------------------+------+---------+----------+------+
338 | Scenario | Apex | Compass | Fuel-arm | Fuel |
339 +=========================+======+=========+==========+======+
340 | os-nosdn-nofeature-noha | X | | | |
341 +-------------------------+------+---------+----------+------+
342 | os-nosdn-nofeature-ha | X | | | |
343 +-------------------------+------+---------+----------+------+
344 | os-odl-bgpvpn-noha | X | | | |
345 +-------------------------+------+---------+----------+------+
346 | os-nosdn-calipso-noha | X | | | |
347 +-------------------------+------+---------+----------+------+
348 | os-nosdn-kvm-ha | | X | | |
349 +-------------------------+------+---------+----------+------+
350 | os-odl-nofeature-ha | | | X | X |
351 +-------------------------+------+---------+----------+------+
352 | os-odl-sfc-noha | X | | | |
353 +-------------------------+------+---------+----------+------+
354 | os-nosdn-ovs-ha | | | | X |
355 +-------------------------+------+---------+----------+------+
356 | k8-nosdn-nofeature-ha | | X | | |
357 +-------------------------+------+---------+----------+------+
358 | k8-nosdn-stor4nfv-noha | | X | | |
359 +-------------------------+------+---------+----------+------+
360 | k8-nosdn-stor4nfv-ha | | X | | |
361 +-------------------------+------+---------+----------+------+
367 Test results are available in:
369 - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/
381 +--------------------+--------------------------------------------------------------------------+
382 | **JIRA REFERENCE** | **DESCRIPTION** |
383 +====================+==========================================================================+
384 | YARDSTICK-1512 | [dovetail] split the sla check results into process recovery and service |
385 | | recovery for HA test cases. |
386 +--------------------+--------------------------------------------------------------------------+
388 Gambia 7.2.0 known restrictions/issues
389 ======================================
395 - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick
397 - wiki Yardstick Gambia release planning page: https://wiki.opnfv.org/display/yardstick/Release+Gambia
399 - Yardstick repo: https://git.opnfv.org/yardstick
401 - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick
403 - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/
405 - Yardstick IRC channel: #opnfv-yardstick