5 OPNFV Fraser release note for Yardstick Docs
6 are licensed under a Creative Commons Attribution 4.0 International License.
7 You should have received a copy of the license along with this.
8 If not, see <http://creativecommons.org/licenses/by/4.0/>.
10 The *Yardstick framework*, the *Yardstick test cases* are open-source software,
11 licensed under the terms of the Apache License, Version 2.0.
13 =======================================
14 OPNFV Fraser Release Note for Yardstick
15 =======================================
20 .. _Yardstick: https://wiki.opnfv.org/yardstick
22 .. _Dashboard: http://testresults.opnfv.org/grafana/dashboard/db/yardstick-main
24 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
30 This document describes the release note of Yardstick project.
35 +-------------------+-----------+---------------------------------+
36 | *Date* | *Version* | *Comment* |
38 +-------------------+-----------+---------------------------------+
39 | May 25, 2018 | 6.1.0 | Yardstick for Fraser release |
41 +-------------------+-----------+---------------------------------+
42 | April 27, 2018 | 6.0.0 | Yardstick for Fraser release |
44 +-------------------+-----------+---------------------------------+
50 The software delivered in the OPNFV Yardstick_ Project, comprising the
51 *Yardstick framework*, and the *Yardstick test cases* is a realization of
52 the methodology in ETSI-ISG NFV-TST001_.
54 The *Yardstick* framework is *installer*, *infrastructure* and *application*
60 This Fraser release provides *Yardstick* as a framework for NFVI testing
61 and OPNFV feature testing, automated in the OPNFV CI pipeline, including:
63 * Documentation generated with Sphinx
67 * Release notes (this document)
70 * Automated Yardstick test suite (daily, weekly)
72 * Jenkins Jobs for OPNFV community labs
74 * Automated Yardstick test results visualization
76 * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
79 * Yardstick framework source code
81 * Yardstick test cases yaml files
83 * Yardstick plug-in configuration yaml files, plug-in install/remove scripts
85 For Fraser release, the *Yardstick framework* is used for the following
88 * OPNFV platform testing - generic test cases to measure the categories:
94 * OPNFV platform network service benchmarking (NSB)
98 * Test cases for the following OPNFV Projects:
108 The *Yardstick framework* is developed in the OPNFV community, by the
111 .. note:: The test case description template used for the Yardstick test cases
112 is based on the document ETSI-ISG NFV-TST001_; the results report template
113 used for the Yardstick results is based on the IEEE Std 829-2008.
119 +--------------------------------+-----------------------+
120 | **Project** | Yardstick |
122 +--------------------------------+-----------------------+
123 | **Repo/tag** | yardstick/opnfv-6.1.0 |
125 +--------------------------------+-----------------------+
126 | **Yardstick Docker image tag** | opnfv-6.1.0 |
128 +--------------------------------+-----------------------+
129 | **Release designation** | Fraser |
131 +--------------------------------+-----------------------+
132 | **Release date** | May 25, 2018 |
134 +--------------------------------+-----------------------+
135 | **Purpose of the delivery** | OPNFV Fraser 6.1.0 |
137 +--------------------------------+-----------------------+
146 - User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/user/userguide/index.html
148 - Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/developer/devguide/index.html
151 Software Deliverables
152 ---------------------
154 - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-6.1.0)
159 +--------------+-------------------------------------------+
160 | **Context** | **Description** |
162 +--------------+-------------------------------------------+
163 | *Heat* | Models orchestration using OpenStack Heat |
165 +--------------+-------------------------------------------+
166 | *Node* | Models Baremetal, Controller, Compute |
168 +--------------+-------------------------------------------+
169 | *Standalone* | Models VM running on Non-Managed NFVi |
171 +--------------+-------------------------------------------+
172 | *Kubernetes* | Models VM running on Non-Managed NFVi |
174 +--------------+-------------------------------------------+
180 .. note:: Yardstick Fraser 6.0.0 add two new Runners, "Dynamictp" and "Search".
182 +---------------+-------------------------------------------------------+
183 | **Runner** | **Description** |
185 +---------------+-------------------------------------------------------+
186 | *Arithmetic* | Steps every run arithmetically according to specified |
189 +---------------+-------------------------------------------------------+
190 | *Duration* | Runs for a specified period of time |
192 +---------------+-------------------------------------------------------+
193 | *Iteration* | Runs for a specified number of iterations |
195 +---------------+-------------------------------------------------------+
196 | *Sequence* | Selects input value to a scenario from an input file |
197 | | and runs all entries sequentially |
199 +---------------+-------------------------------------------------------+
200 | **Dynamictp** | A runner that searches for the max throughput with |
203 +---------------+-------------------------------------------------------+
204 | **Search** | A runner that runs a specific time before it returns |
206 +---------------+-------------------------------------------------------+
212 +----------------+-----------------------------------------------------+
213 | **Category** | **Delivered** |
215 +----------------+-----------------------------------------------------+
216 | *Availability* | Attacker: |
218 | | * baremetal, process |
222 | | * check host, openstack, process, service |
224 | | * start/stop service |
228 | | * command, process |
230 +----------------+-----------------------------------------------------+
231 | *Compute* | * cpuload |
234 | | * lmbench_cache |
240 | | * computecapacity |
243 +----------------+-----------------------------------------------------+
244 | *Networking* | * iperf3 |
251 | | * sfc with tacker |
252 | | * networkcapacity |
253 | | * netutilization |
257 +----------------+-----------------------------------------------------+
258 | *Parser* | Tosca2Heat |
260 +----------------+-----------------------------------------------------+
261 | *Storage* | * fio |
263 | | * storagecapacity |
265 +----------------+-----------------------------------------------------+
266 | *StorPerf* | storperf |
268 +----------------+-----------------------------------------------------+
269 | *NSB* | vFW thoughput test case |
271 +----------------+-----------------------------------------------------+
277 .. note:: Yardstick Fraser 6.1.0 added two new test cases, "TC092" and "TC093".
279 * Generic NFVI test cases
281 * OPNFV_YARDSTICK_TCO84 - SPEC CPU 2006 for VM
285 * OPNFV_YARDSTICK_TC087 - SDN Controller resilience in non-HA configuration
286 * OPNFV_YARDSTICK_TC090 - Control node Openstack service down - database instance
287 * OPNFV_YARDSTICK_TC091 - Control node Openstack service down - heat-api
288 * OPNFV_YARDSTICK_TC092 - SDN Controller resilience in HA configuration
289 * OPNFV_YARDSTICK_TC093 - SDN Vswitch resilience in non-HA or HA configuration
295 Module Version Changes
296 ----------------------
298 This is the sixth tracked release of Yardstick. It is based on following
302 - OpenDayLight Oxygen
305 Document Version Changes
306 ------------------------
308 This is the sixth tracked version of the Yardstick framework in OPNFV.
309 It includes the following documentation updates:
311 - Yardstick User Guide: add "network service benchmarking(NSB)" chapter;
312 add "Yardstick - NSB Testing -Installation" chapter; add "Yardstick API" chapter;
313 add "Yardstick user interface" chapter; Update Yardstick installation chapter;
314 - Yardstick Developer Guide
315 - Yardstick Release Notes for Yardstick: this document
321 - Plugin-based test cases support Heat context
322 - SR-IOV support for the Heat context
323 - Support using existing network in Heat context
324 - Support running test cases with existing VNFs/without destroying VNF in Heat context
325 - Add vFW scale-up template
326 - Improvements of unit tests and gating
327 - GUI improvement about passing parameters
333 For Fraser 6.0.0, Yardstick was tested on the following scenarios:
335 +-------------------------+------+---------+----------+------+------+-------+
336 | Scenario | Apex | Compass | Fuel-arm | Fuel | Joid | Daisy |
337 +=========================+======+=========+==========+======+======+=======+
338 | os-nosdn-nofeature-noha | X | X | | | X | |
339 +-------------------------+------+---------+----------+------+------+-------+
340 | os-nosdn-nofeature-ha | X | X | X | X | X | X |
341 +-------------------------+------+---------+----------+------+------+-------+
342 | os-nosdn-bar-noha | X | X | | | | |
343 +-------------------------+------+---------+----------+------+------+-------+
344 | os-nosdn-bar-ha | X | | | | | |
345 +-------------------------+------+---------+----------+------+------+-------+
346 | os-odl-bgpvpn-ha | X | | | | | |
347 +-------------------------+------+---------+----------+------+------+-------+
348 | os-nosdn-calipso-noha | X | | | | | |
349 +-------------------------+------+---------+----------+------+------+-------+
350 | os-nosdn-kvm-ha | | X | | | | |
351 +-------------------------+------+---------+----------+------+------+-------+
352 | os-odl_l3-nofeature-ha | | X | | | | |
353 +-------------------------+------+---------+----------+------+------+-------+
354 | os-odl-sfc-ha | | X | | | | |
355 +-------------------------+------+---------+----------+------+------+-------+
356 | os-odl-nofeature-ha | | | | X | | X |
357 +-------------------------+------+---------+----------+------+------+-------+
358 | os-nosdn-ovs-ha | | | | X | | |
359 +-------------------------+------+---------+----------+------+------+-------+
360 | k8-nosdn-nofeature-ha | | X | | | | |
361 +-------------------------+------+---------+----------+------+------+-------+
362 | k8-nosdn-stor4nfv-noha | | X | | | | |
363 +-------------------------+------+---------+----------+------+------+-------+
369 Test results are available in:
371 - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/
373 The reporting pages can be found at:
375 +---------------+----------------------------------------------------------------------------------+
376 | apex | http://testresults.opnfv.org/reporting/fraser/yardstick/status-apex.html |
377 +---------------+----------------------------------------------------------------------------------+
378 | compass | http://testresults.opnfv.org/reporting/fraser/yardstick/status-compass.html |
379 +---------------+----------------------------------------------------------------------------------+
380 | fuel\@x86 | http://testresults.opnfv.org/reporting/fraser/yardstick/status-fuel@x86.html |
381 +---------------+----------------------------------------------------------------------------------+
382 | fuel\@aarch64 | http://testresults.opnfv.org/reporting/fraser/yardstick/status-fuel@aarch64.html |
383 +---------------+----------------------------------------------------------------------------------+
384 | joid | http://testresults.opnfv.org/reporting/fraser/yardstick/status-joid.html |
385 +---------------+----------------------------------------------------------------------------------+
396 +--------------------+--------------------------------------------------------------------------+
397 | **JIRA REFERENCE** | **DESCRIPTION** |
398 +====================+==========================================================================+
399 | YARDSTICK-995 | Test case spec for SDN Virtual Switch resilience |
400 +--------------------+--------------------------------------------------------------------------+
401 | YARDSTICK-1097 | Add pod.yaml file for APEX installer |
402 +--------------------+--------------------------------------------------------------------------+
403 | YARDSTICK-1122 | Remove unused code in SampleVNF |
404 +--------------------+--------------------------------------------------------------------------+
405 | YARDSTICK-1125 | Update samples/test_suite.yaml |
406 +--------------------+--------------------------------------------------------------------------+
407 | YARDSTICK-1132 | Document for Euphrates test case results |
408 +--------------------+--------------------------------------------------------------------------+
409 | YARDSTICK-1138 | Support Restart Operation |
410 +--------------------+--------------------------------------------------------------------------+
411 | YARDSTICK-1142 | start_service script fails to start openvswitch service in centos distro |
412 +--------------------+--------------------------------------------------------------------------+
413 | YARDSTICK-1165 | Bugfix: openrc api dump should be safe_dump |
414 +--------------------+--------------------------------------------------------------------------+
418 +--------------------+--------------------------------------------------------------------------+
419 | **JIRA REFERENCE** | **DESCRIPTION** |
420 +====================+==========================================================================+
421 | YARDSTICK-831 | tc053 kill haproxy wrong |
422 +--------------------+--------------------------------------------------------------------------+
423 | YARDSTICK-842 | load image fails when there's cirros image exist |
424 +--------------------+--------------------------------------------------------------------------+
425 | YARDSTICK-857 | tc006 failed due to volume attached to different location "/dev/vdc" |
426 +--------------------+--------------------------------------------------------------------------+
427 | YARDSTICK-874 | Specify supported architecture for Ubuntu backports repository |
428 +--------------------+--------------------------------------------------------------------------+
429 | YARDSTICK-875 | Check if multiverse repository is available in Ubuntu |
430 +--------------------+--------------------------------------------------------------------------+
431 | YARDSTICK-893 | Fix proxy env handling and ansible multinode support |
432 +--------------------+--------------------------------------------------------------------------+
433 | YARDSTICK-899 | Variable local_iface_name is read before it is set |
434 +--------------------+--------------------------------------------------------------------------+
435 | YARDSTICK-900 | Section in "upload_yardstick_image.yml" invalid |
436 +--------------------+--------------------------------------------------------------------------+
437 | YARDSTICK-911 | Remove 'inconsistent-return-statements' from Pylint checks |
438 +--------------------+--------------------------------------------------------------------------+
439 | YARDSTICK-989 | Yardstick real-time influxdb KPI reporting regressions |
440 +--------------------+--------------------------------------------------------------------------+
441 | YARDSTICK-994 | NSB set-up build script for baremetal broken |
442 +--------------------+--------------------------------------------------------------------------+
443 | YARDSTICK-996 | Error in address input format in "_ip_range_action_partial" |
444 +--------------------+--------------------------------------------------------------------------+
445 | YARDSTICK-1003 | Prox vnf descriptor cleanup for tg and vnf |
446 +--------------------+--------------------------------------------------------------------------+
447 | YARDSTICK-1006 | Ansible destroy script will fail if vm has already been undefined |
448 +--------------------+--------------------------------------------------------------------------+
449 | YARDSTICK-1012 | constants: fix pylint warnings for OSError |
450 +--------------------+--------------------------------------------------------------------------+
451 | YARDSTICK-1014 | Remove unused args in |
452 | | network_services.traffic_profile.ixia_rfc2544.IXIARFC2544Profile |
453 +--------------------+--------------------------------------------------------------------------+
454 | YARDSTICK-1016 | Allow vm to access outside world through default gateway |
455 +--------------------+--------------------------------------------------------------------------+
456 | YARDSTICK-1019 | For 'qemu-img version 2.10.1' unit 'MB' is not acceptable ansible script |
457 +--------------------+--------------------------------------------------------------------------+
458 | YARDSTICK-1021 | NSB: All Sample VNF test cases timeout after 1 hour of execution |
459 +--------------------+--------------------------------------------------------------------------+
460 | YARDSTICK-1036 | Prox: Addition of storage of extra counters for Grafana |
461 +--------------------+--------------------------------------------------------------------------+
462 | YARDSTICK-1038 | Missing file which is described in the operation_conf.yaml |
463 +--------------------+--------------------------------------------------------------------------+
464 | YARDSTICK-1047 | Error in string format in HeatTemplateError message |
465 +--------------------+--------------------------------------------------------------------------+
466 | YARDSTICK-1056 | yardstick report command print error when run test case |
467 +--------------------+--------------------------------------------------------------------------+
468 | YARDSTICK-1059 | Reduce the log level if TRex client is no connected |
469 +--------------------+--------------------------------------------------------------------------+
470 | YARDSTICK-1073 | Error when retrieving "options" section in "scenario" |
471 +--------------------+--------------------------------------------------------------------------+
472 | YARDSTICK-1080 | Running Test Case in Latest Yardstick Docker Image shows Error |
473 +--------------------+--------------------------------------------------------------------------+
474 | YARDSTICK-1082 | tc043,tc055, tc063, tc075, pass wrong node name in the ci scenario yaml |
475 +--------------------+--------------------------------------------------------------------------+
476 | YARDSTICK-1102 | Don't hide exception traceback from Task.start() |
477 +--------------------+--------------------------------------------------------------------------+
478 | YARDSTICK-1107 | bad exception traceback print due to atexit_handler |
479 +--------------------+--------------------------------------------------------------------------+
480 | YARDSTICK-1120 | HA test case tc050 should start monitor before attack |
481 +--------------------+--------------------------------------------------------------------------+
483 Fraser 6.0.0 known restrictions/issues
484 ======================================
486 +-----------+-----------+----------------------------------------------+
487 | Installer | Scenario | Issue |
488 +===========+===========+==============================================+
490 +-----------+-----------+----------------------------------------------+
495 - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick
497 - wiki Yardstick Fraser release planing page: https://wiki.opnfv.org/display/yardstick/Release+Fraser
499 - Yardstick repo: https://git.opnfv.org/cgit/yardstick
501 - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick
503 - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/
505 - Yardstick IRC chanel: #opnfv-yardstick