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 | Jun 29, 2018 | 6.2.0 | Yardstick for Fraser release |
41 +-------------------+-----------+---------------------------------+
42 | May 25, 2018 | 6.1.0 | Yardstick for Fraser release |
44 +-------------------+-----------+---------------------------------+
45 | April 27, 2018 | 6.0.0 | Yardstick for Fraser release |
47 +-------------------+-----------+---------------------------------+
53 The software delivered in the OPNFV Yardstick_ Project, comprising the
54 *Yardstick framework*, and the *Yardstick test cases* is a realization of
55 the methodology in ETSI-ISG NFV-TST001_.
57 The *Yardstick* framework is *installer*, *infrastructure* and *application*
63 This Fraser release provides *Yardstick* as a framework for NFVI testing
64 and OPNFV feature testing, automated in the OPNFV CI pipeline, including:
66 * Documentation generated with Sphinx
70 * Release notes (this document)
73 * Automated Yardstick test suite (daily, weekly)
75 * Jenkins Jobs for OPNFV community labs
77 * Automated Yardstick test results visualization
79 * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
82 * Yardstick framework source code
84 * Yardstick test cases yaml files
86 * Yardstick plug-in configuration yaml files, plug-in install/remove scripts
88 For Fraser release, the *Yardstick framework* is used for the following
91 * OPNFV platform testing - generic test cases to measure the categories:
97 * OPNFV platform network service benchmarking (NSB)
101 * Test cases for the following OPNFV Projects:
111 The *Yardstick framework* is developed in the OPNFV community, by the
114 .. note:: The test case description template used for the Yardstick test cases
115 is based on the document ETSI-ISG NFV-TST001_; the results report template
116 used for the Yardstick results is based on the IEEE Std 829-2008.
122 +--------------------------------+-----------------------+
123 | **Project** | Yardstick |
125 +--------------------------------+-----------------------+
126 | **Repo/tag** | yardstick/opnfv-6.2.0 |
128 +--------------------------------+-----------------------+
129 | **Yardstick Docker image tag** | opnfv-6.2.0 |
131 +--------------------------------+-----------------------+
132 | **Release designation** | Fraser |
134 +--------------------------------+-----------------------+
135 | **Release date** | Jun 29, 2018 |
137 +--------------------------------+-----------------------+
138 | **Purpose of the delivery** | OPNFV Fraser 6.2.0 |
140 +--------------------------------+-----------------------+
149 - User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/user/userguide/index.html
151 - Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/developer/devguide/index.html
154 Software Deliverables
155 ---------------------
157 - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-6.2.0)
162 +--------------+-------------------------------------------+
163 | **Context** | **Description** |
165 +--------------+-------------------------------------------+
166 | *Heat* | Models orchestration using OpenStack Heat |
168 +--------------+-------------------------------------------+
169 | *Node* | Models Baremetal, Controller, Compute |
171 +--------------+-------------------------------------------+
172 | *Standalone* | Models VM running on Non-Managed NFVi |
174 +--------------+-------------------------------------------+
175 | *Kubernetes* | Models VM running on Non-Managed NFVi |
177 +--------------+-------------------------------------------+
183 .. note:: Yardstick Fraser 6.0.0 add two new Runners, "Dynamictp" and "Search".
185 +---------------+-------------------------------------------------------+
186 | **Runner** | **Description** |
188 +---------------+-------------------------------------------------------+
189 | *Arithmetic* | Steps every run arithmetically according to specified |
192 +---------------+-------------------------------------------------------+
193 | *Duration* | Runs for a specified period of time |
195 +---------------+-------------------------------------------------------+
196 | *Iteration* | Runs for a specified number of iterations |
198 +---------------+-------------------------------------------------------+
199 | *Sequence* | Selects input value to a scenario from an input file |
200 | | and runs all entries sequentially |
202 +---------------+-------------------------------------------------------+
203 | **Dynamictp** | A runner that searches for the max throughput with |
206 +---------------+-------------------------------------------------------+
207 | **Search** | A runner that runs a specific time before it returns |
209 +---------------+-------------------------------------------------------+
215 +----------------+-----------------------------------------------------+
216 | **Category** | **Delivered** |
218 +----------------+-----------------------------------------------------+
219 | *Availability* | Attacker: |
221 | | * baremetal, process |
225 | | * check host, openstack, process, service |
227 | | * start/stop service |
231 | | * command, process |
233 +----------------+-----------------------------------------------------+
234 | *Compute* | * cpuload |
237 | | * lmbench_cache |
243 | | * computecapacity |
246 +----------------+-----------------------------------------------------+
247 | *Networking* | * iperf3 |
254 | | * sfc with tacker |
255 | | * networkcapacity |
256 | | * netutilization |
260 +----------------+-----------------------------------------------------+
261 | *Parser* | Tosca2Heat |
263 +----------------+-----------------------------------------------------+
264 | *Storage* | * fio |
266 | | * storagecapacity |
268 +----------------+-----------------------------------------------------+
269 | *StorPerf* | storperf |
271 +----------------+-----------------------------------------------------+
272 | *NSB* | vFW thoughput test case |
274 +----------------+-----------------------------------------------------+
280 .. note:: Yardstick Fraser 6.1.0 added two new test cases, "TC092" and "TC093".
282 * Generic NFVI test cases
284 * OPNFV_YARDSTICK_TCO84 - SPEC CPU 2006 for VM
288 * OPNFV_YARDSTICK_TC087 - SDN Controller resilience in non-HA configuration
289 * OPNFV_YARDSTICK_TC090 - Control node Openstack service down - database instance
290 * OPNFV_YARDSTICK_TC091 - Control node Openstack service down - heat-api
291 * OPNFV_YARDSTICK_TC092 - SDN Controller resilience in HA configuration
292 * OPNFV_YARDSTICK_TC093 - SDN Vswitch resilience in non-HA or HA configuration
298 Module Version Changes
299 ----------------------
301 This is the sixth tracked release of Yardstick. It is based on following
305 - OpenDayLight Oxygen
308 Document Version Changes
309 ------------------------
311 This is the sixth tracked version of the Yardstick framework in OPNFV.
312 It includes the following documentation updates:
314 - Yardstick User Guide: add "network service benchmarking(NSB)" chapter;
315 add "Yardstick - NSB Testing -Installation" chapter; add "Yardstick API" chapter;
316 add "Yardstick user interface" chapter; Update Yardstick installation chapter;
317 - Yardstick Developer Guide
318 - Yardstick Release Notes for Yardstick: this document
324 - Plugin-based test cases support Heat context
325 - SR-IOV support for the Heat context
326 - Support using existing network in Heat context
327 - Support running test cases with existing VNFs/without destroying VNF in Heat context
328 - Add vFW scale-up template
329 - Improvements of unit tests and gating
330 - GUI improvement about passing parameters
336 For Fraser 6.0.0, Yardstick was tested on the following scenarios:
338 +-------------------------+------+---------+----------+------+------+-------+
339 | Scenario | Apex | Compass | Fuel-arm | Fuel | Joid | Daisy |
340 +=========================+======+=========+==========+======+======+=======+
341 | os-nosdn-nofeature-noha | X | X | | | X | |
342 +-------------------------+------+---------+----------+------+------+-------+
343 | os-nosdn-nofeature-ha | X | X | X | X | X | X |
344 +-------------------------+------+---------+----------+------+------+-------+
345 | os-nosdn-bar-noha | X | X | | | | |
346 +-------------------------+------+---------+----------+------+------+-------+
347 | os-nosdn-bar-ha | X | | | | | |
348 +-------------------------+------+---------+----------+------+------+-------+
349 | os-odl-bgpvpn-ha | X | | | | | |
350 +-------------------------+------+---------+----------+------+------+-------+
351 | os-nosdn-calipso-noha | X | | | | | |
352 +-------------------------+------+---------+----------+------+------+-------+
353 | os-nosdn-kvm-ha | | X | | | | |
354 +-------------------------+------+---------+----------+------+------+-------+
355 | os-odl_l3-nofeature-ha | | X | | | | |
356 +-------------------------+------+---------+----------+------+------+-------+
357 | os-odl-sfc-ha | | X | | | | |
358 +-------------------------+------+---------+----------+------+------+-------+
359 | os-odl-nofeature-ha | | | | X | | X |
360 +-------------------------+------+---------+----------+------+------+-------+
361 | os-nosdn-ovs-ha | | | | X | | |
362 +-------------------------+------+---------+----------+------+------+-------+
363 | k8-nosdn-nofeature-ha | | X | | | | |
364 +-------------------------+------+---------+----------+------+------+-------+
365 | k8-nosdn-stor4nfv-noha | | X | | | | |
366 +-------------------------+------+---------+----------+------+------+-------+
372 Test results are available in:
374 - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/
376 The reporting pages can be found at:
378 +---------------+----------------------------------------------------------------------------------+
379 | apex | http://testresults.opnfv.org/reporting/fraser/yardstick/status-apex.html |
380 +---------------+----------------------------------------------------------------------------------+
381 | compass | http://testresults.opnfv.org/reporting/fraser/yardstick/status-compass.html |
382 +---------------+----------------------------------------------------------------------------------+
383 | fuel\@x86 | http://testresults.opnfv.org/reporting/fraser/yardstick/status-fuel@x86.html |
384 +---------------+----------------------------------------------------------------------------------+
385 | fuel\@aarch64 | http://testresults.opnfv.org/reporting/fraser/yardstick/status-fuel@aarch64.html |
386 +---------------+----------------------------------------------------------------------------------+
387 | joid | http://testresults.opnfv.org/reporting/fraser/yardstick/status-joid.html |
388 +---------------+----------------------------------------------------------------------------------+
399 +--------------------+--------------------------------------------------------------------------+
400 | **JIRA REFERENCE** | **DESCRIPTION** |
401 +====================+==========================================================================+
402 | YARDSTICK-1246 | Update pmd/lcore mask for OVS-DPDK context |
403 +--------------------+--------------------------------------------------------------------------+
404 | YARDSTICK-837 | Move tests: unit/network_services/{lib/,collector/,*.py} |
405 +--------------------+--------------------------------------------------------------------------+
406 | YARDSTICK-1144 | Correctly set PYTHONPATH in Dockerfile |
407 +--------------------+--------------------------------------------------------------------------+
408 | YARDSTICK-1205 | Set "cmd2" library to version 0.8.6 |
409 +--------------------+--------------------------------------------------------------------------+
410 | YARDSTICK-1204 | Bump oslo.messaging version to 5.36.0 |
411 +--------------------+--------------------------------------------------------------------------+
412 | YARDSTICK-1210 | Remove __init__ method overriding in HeatContextTestCase |
413 +--------------------+--------------------------------------------------------------------------+
414 | YARDSTICK-1189 | Error when adding SR-IOV interfaces in SR-IOV context |
415 +--------------------+--------------------------------------------------------------------------+
416 | YARDSTICK-1214 | Remove AnsibleCommon class method mock |
417 +--------------------+--------------------------------------------------------------------------+
418 | YARDSTICK-1159 | Add --hwlb options as a command line argument for SampleVNF |
419 +--------------------+--------------------------------------------------------------------------+
420 | YARDSTICK-1203 | Add scale out TCs with availability zone support |
421 +--------------------+--------------------------------------------------------------------------+
422 | YARDSTICK-1167 | Do not start collectd twice when SampleVNF is running on Baremetal |
423 +--------------------+--------------------------------------------------------------------------+
424 | YARDSTICK-1188 | Add "host_name_separator" variable to Context class |
425 +--------------------+--------------------------------------------------------------------------+
426 | YARDSTICK-1112 | MQ startup process refactor |
427 +--------------------+--------------------------------------------------------------------------+
428 | YARDSTICK-1229 | Cleanup BaseMonitor unit tests |
429 +--------------------+--------------------------------------------------------------------------+
430 | - | Configure ACL via static file |
431 +--------------------+--------------------------------------------------------------------------+
432 | YARDSTICK-1191 | Use TRex release v2.41 to support both x86 and aarch64 |
433 +--------------------+--------------------------------------------------------------------------+
434 | YARDSTICK-1106 | Add IxNetwork API Python Binding package |
435 +--------------------+--------------------------------------------------------------------------+
436 | YARDSTICK-1224 | Cleanup TestYardstickNSCli class |
437 +--------------------+--------------------------------------------------------------------------+
438 | YARDSTICK-1225 | Remove print out of logger exception in TestUtils |
439 +--------------------+--------------------------------------------------------------------------+
440 | YARDSTICK-1194 | Add "duration" parameter to test case definition |
441 +--------------------+--------------------------------------------------------------------------+
442 | YARDSTICK-1209 | Remove instantiated contexts in "test_task" |
443 +--------------------+--------------------------------------------------------------------------+
444 | YARDSTICK-1192 | Standalone XML machine type is not longer valid |
445 +--------------------+--------------------------------------------------------------------------+
446 | YARDSTICK-1197 | Refactor RFC2455 TRex traffic profile injection |
447 +--------------------+--------------------------------------------------------------------------+
448 | - | Fix "os.path" mock problems during tests |
449 +--------------------+--------------------------------------------------------------------------+
450 | YARDSTICK-1218 | Refactor "utils.parse_ini_file" testing |
451 +--------------------+--------------------------------------------------------------------------+
452 | YARDSTICK-1179 | Start nginx and uwsgi servicies only in not container mode |
453 +--------------------+--------------------------------------------------------------------------+
454 | YARDSTICK-1177 | Install dependencies: bare-metal, standalone |
455 +--------------------+--------------------------------------------------------------------------+
456 | YARDSTICK-1126 | Migrate install.sh script to ansible |
457 +--------------------+--------------------------------------------------------------------------+
458 | YARDSTICK-1146 | Fix nsb_setup.sh script |
459 +--------------------+--------------------------------------------------------------------------+
460 | YARDSTICK-1247 | NSB setup inventory name changed |
461 +--------------------+--------------------------------------------------------------------------+
462 | YARDSTICK-1116 | Changed IxNextgen library load in IXIA RFC2544 traffic generator call. |
463 +--------------------+--------------------------------------------------------------------------+
464 | - | Corrected scale-up command line arguments |
465 +--------------------+--------------------------------------------------------------------------+
466 | YARDSTICK-878 | OpenStack client replacement |
467 +--------------------+--------------------------------------------------------------------------+
468 | YARDSTICK-1222 | Bugfix: HA kill process recovery has a conflict |
469 +--------------------+--------------------------------------------------------------------------+
470 | YARDSTICK-1139 | Add "os_cloud_config" as a new context flag parameter |
471 +--------------------+--------------------------------------------------------------------------+
472 | YARDSTICK-1255 | Extended Context class with get_physical_nodes functionality |
473 +--------------------+--------------------------------------------------------------------------+
474 | YARDSTICK-1244 | NSB NFVi BNG test fails to run - stops after one step |
475 +--------------------+--------------------------------------------------------------------------+
476 | YARDSTICK-1219 | Decrease Sampling interval |
477 +--------------------+--------------------------------------------------------------------------+
478 | YARDSTICK-1101 | NSB NFVi PROX BNG losing many packets |
479 +--------------------+--------------------------------------------------------------------------+
480 | YARDSTICK-1217 | Fix NSB NfVi support for 25 and 40Gbps |
481 +--------------------+--------------------------------------------------------------------------+
482 | YARDSTICK-1185 | NSB Topology fix for Prox 4 port test case |
483 +--------------------+--------------------------------------------------------------------------+
484 | YARDSTICK-966 | Convert SLA asserts to raises |
485 +--------------------+--------------------------------------------------------------------------+
489 +--------------------+--------------------------------------------------------------------------+
490 | **JIRA REFERENCE** | **DESCRIPTION** |
491 +====================+==========================================================================+
492 | YARDSTICK-995 | Test case spec for SDN Virtual Switch resilience |
493 +--------------------+--------------------------------------------------------------------------+
494 | YARDSTICK-1097 | Add pod.yaml file for APEX installer |
495 +--------------------+--------------------------------------------------------------------------+
496 | YARDSTICK-1122 | Remove unused code in SampleVNF |
497 +--------------------+--------------------------------------------------------------------------+
498 | YARDSTICK-1125 | Update samples/test_suite.yaml |
499 +--------------------+--------------------------------------------------------------------------+
500 | YARDSTICK-1132 | Document for Euphrates test case results |
501 +--------------------+--------------------------------------------------------------------------+
502 | YARDSTICK-1138 | Support Restart Operation |
503 +--------------------+--------------------------------------------------------------------------+
504 | YARDSTICK-1142 | start_service script fails to start openvswitch service in centos distro |
505 +--------------------+--------------------------------------------------------------------------+
506 | YARDSTICK-1165 | Bugfix: openrc api dump should be safe_dump |
507 +--------------------+--------------------------------------------------------------------------+
511 +--------------------+--------------------------------------------------------------------------+
512 | **JIRA REFERENCE** | **DESCRIPTION** |
513 +====================+==========================================================================+
514 | YARDSTICK-831 | tc053 kill haproxy wrong |
515 +--------------------+--------------------------------------------------------------------------+
516 | YARDSTICK-842 | load image fails when there's cirros image exist |
517 +--------------------+--------------------------------------------------------------------------+
518 | YARDSTICK-857 | tc006 failed due to volume attached to different location "/dev/vdc" |
519 +--------------------+--------------------------------------------------------------------------+
520 | YARDSTICK-874 | Specify supported architecture for Ubuntu backports repository |
521 +--------------------+--------------------------------------------------------------------------+
522 | YARDSTICK-875 | Check if multiverse repository is available in Ubuntu |
523 +--------------------+--------------------------------------------------------------------------+
524 | YARDSTICK-893 | Fix proxy env handling and ansible multinode support |
525 +--------------------+--------------------------------------------------------------------------+
526 | YARDSTICK-899 | Variable local_iface_name is read before it is set |
527 +--------------------+--------------------------------------------------------------------------+
528 | YARDSTICK-900 | Section in "upload_yardstick_image.yml" invalid |
529 +--------------------+--------------------------------------------------------------------------+
530 | YARDSTICK-911 | Remove 'inconsistent-return-statements' from Pylint checks |
531 +--------------------+--------------------------------------------------------------------------+
532 | YARDSTICK-989 | Yardstick real-time influxdb KPI reporting regressions |
533 +--------------------+--------------------------------------------------------------------------+
534 | YARDSTICK-994 | NSB set-up build script for baremetal broken |
535 +--------------------+--------------------------------------------------------------------------+
536 | YARDSTICK-996 | Error in address input format in "_ip_range_action_partial" |
537 +--------------------+--------------------------------------------------------------------------+
538 | YARDSTICK-1003 | Prox vnf descriptor cleanup for tg and vnf |
539 +--------------------+--------------------------------------------------------------------------+
540 | YARDSTICK-1006 | Ansible destroy script will fail if vm has already been undefined |
541 +--------------------+--------------------------------------------------------------------------+
542 | YARDSTICK-1012 | constants: fix pylint warnings for OSError |
543 +--------------------+--------------------------------------------------------------------------+
544 | YARDSTICK-1014 | Remove unused args in |
545 | | network_services.traffic_profile.ixia_rfc2544.IXIARFC2544Profile |
546 +--------------------+--------------------------------------------------------------------------+
547 | YARDSTICK-1016 | Allow vm to access outside world through default gateway |
548 +--------------------+--------------------------------------------------------------------------+
549 | YARDSTICK-1019 | For 'qemu-img version 2.10.1' unit 'MB' is not acceptable ansible script |
550 +--------------------+--------------------------------------------------------------------------+
551 | YARDSTICK-1021 | NSB: All Sample VNF test cases timeout after 1 hour of execution |
552 +--------------------+--------------------------------------------------------------------------+
553 | YARDSTICK-1036 | Prox: Addition of storage of extra counters for Grafana |
554 +--------------------+--------------------------------------------------------------------------+
555 | YARDSTICK-1038 | Missing file which is described in the operation_conf.yaml |
556 +--------------------+--------------------------------------------------------------------------+
557 | YARDSTICK-1047 | Error in string format in HeatTemplateError message |
558 +--------------------+--------------------------------------------------------------------------+
559 | YARDSTICK-1056 | yardstick report command print error when run test case |
560 +--------------------+--------------------------------------------------------------------------+
561 | YARDSTICK-1059 | Reduce the log level if TRex client is no connected |
562 +--------------------+--------------------------------------------------------------------------+
563 | YARDSTICK-1073 | Error when retrieving "options" section in "scenario" |
564 +--------------------+--------------------------------------------------------------------------+
565 | YARDSTICK-1080 | Running Test Case in Latest Yardstick Docker Image shows Error |
566 +--------------------+--------------------------------------------------------------------------+
567 | YARDSTICK-1082 | tc043,tc055, tc063, tc075, pass wrong node name in the ci scenario yaml |
568 +--------------------+--------------------------------------------------------------------------+
569 | YARDSTICK-1102 | Don't hide exception traceback from Task.start() |
570 +--------------------+--------------------------------------------------------------------------+
571 | YARDSTICK-1107 | bad exception traceback print due to atexit_handler |
572 +--------------------+--------------------------------------------------------------------------+
573 | YARDSTICK-1120 | HA test case tc050 should start monitor before attack |
574 +--------------------+--------------------------------------------------------------------------+
576 Fraser 6.0.0 known restrictions/issues
577 ======================================
579 +-----------+-----------+----------------------------------------------+
580 | Installer | Scenario | Issue |
581 +===========+===========+==============================================+
583 +-----------+-----------+----------------------------------------------+
588 - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick
590 - wiki Yardstick Fraser release planing page: https://wiki.opnfv.org/display/yardstick/Release+Fraser
592 - Yardstick repo: https://git.opnfv.org/cgit/yardstick
594 - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick
596 - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/
598 - Yardstick IRC chanel: #opnfv-yardstick