5 OPNFV Colorado 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* and the *ApexLake*
11 experimental framework are opensource software, licensed under the terms of the
12 Apache License, Version 2.0.
14 =========================================
15 OPNFV Colorado Release Note for Yardstick
16 =========================================
21 .. _Yardstick: https://wiki.opnfv.org/yardstick
23 .. _Dashboard: http://testresults.opnfv.org/grafana/dashboard/db/yardstick-main
25 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
31 This document describes the release note of Yardstick project.
37 +----------------+--------------------+---------------------------------+
38 | *Date* | *Version* | *Comment* |
40 +----------------+--------------------+---------------------------------+
41 | Aug 22nd, 2016 | 1.0 | Yardstick for Colorado release |
43 +----------------+--------------------+---------------------------------+
49 The software delivered in the OPNFV Yardstick_ Project, comprising the
50 *Yardstick framework*, the *Yardstick test cases* and the experimental
51 framework *Apex Lake* is a realization of the methodology in ETSI-ISG
54 The *Yardstick* framework is *installer*, *infrastructure* and *application*
58 OPNFV Colorado Release
59 ======================
61 This Colorado release provides *Yardstick* as a framework for NFVI testing
62 and OPNFV feature testing, automated in the OPNFV CI pipeline, including:
64 * Documentation generated with Sphinx
70 * Release notes (this document)
74 * Automated Yardstick test suite (daily, weekly)
76 * Jenkins Jobs for OPNFV community labs
78 * Automated Yardstick test results visualization
80 * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
83 * Yardstick framework source code
85 * Yardstick test cases yaml files
87 * Yardstick pliug-in configration yaml files, plug-in install/remove scripts
89 For Colorado release, the *Yardstick framework* is used for the following
92 * OPNFV platform testing - generic test cases to measure the categories:
100 * Test cases for the following OPNFV Projects:
114 * virtual Traffic Classifier
116 The *Yardstick framework* is developed in the OPNFV community, by the
117 Yardstick_ team. The *virtual Traffic Classifier* is a part of the Yardstick
120 .. note:: The test case description template used for the Yardstick test cases
121 is based on the document ETSI-ISG NFV-TST001_; the results report template
122 used for the Yardstick results is based on the IEEE Std 829-2008.
128 +--------------------------------------+--------------------------------------+
129 | **Project** | Yardstick |
131 +--------------------------------------+--------------------------------------+
132 | **Repo/tag** | yardstick/colorado.1.0 |
134 +--------------------------------------+--------------------------------------+
135 | **Yardstick Docker image tag** | colorado.1.0 |
137 +--------------------------------------+--------------------------------------+
138 | **Release designation** | Colorado base release |
140 +--------------------------------------+--------------------------------------+
141 | **Release date** | September 22 2016 |
143 +--------------------------------------+--------------------------------------+
144 | **Purpose of the delivery** | Colorado base release |
146 +--------------------------------------+--------------------------------------+
155 - User Guide: http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html
157 - Test Results: http://artifacts.opnfv.org/yardstick/colorado/docs/results/overview.html
160 Software Deliverables
161 ---------------------
163 **Yardstick framework source code <colorado.1.0>**
165 +--------------------------------------+--------------------------------------+
166 | **Project** | Yardstick |
168 +--------------------------------------+--------------------------------------+
169 | **Repo/tag** | yardstick/colorado.1.0 |
171 +--------------------------------------+--------------------------------------+
172 | **Yardstick Docker image tag** | colorado.1.0 |
174 +--------------------------------------+--------------------------------------+
175 | **Release designation** | colorado |
177 +--------------------------------------+--------------------------------------+
178 | **Release date** | September 22th, 2016 |
180 +--------------------------------------+--------------------------------------+
181 | **Purpose of the delivery** | OPNFV Colorado release |
183 +--------------------------------------+--------------------------------------+
188 +---------------------+-------------------------------------------------------+
189 | **Context** | **Description** |
191 +---------------------+-------------------------------------------------------+
192 | *Heat* | Models orchestration using OpenStack Heat |
194 +---------------------+-------------------------------------------------------+
195 | *Node* | Models Baremetal, Controller, Compute |
197 +---------------------+-------------------------------------------------------+
202 +---------------------+-------------------------------------------------------+
203 | **Runner** | **Description** |
205 +---------------------+-------------------------------------------------------+
206 | *Arithmetic* | Steps every run arithmetically according to specified |
209 +---------------------+-------------------------------------------------------+
210 | *Duration* | Runs for a specified period of time |
212 +---------------------+-------------------------------------------------------+
213 | *Iteration* | Runs for a specified number of iterations |
215 +---------------------+-------------------------------------------------------+
216 | *Sequence* | Selects input value to a scenario from an input file |
217 | | and runs all entries sequentially |
219 +---------------------+-------------------------------------------------------+
224 +---------------------+-------------------------------------------------------+
225 | **Category** | **Delivered** |
227 +---------------------+-------------------------------------------------------+
228 | *Availability* | Attacker: |
230 | | * baremetal, process |
234 | | * check host, openstack, process, service |
236 | | * start/stop service |
240 | | * command, process |
242 +---------------------+-------------------------------------------------------+
243 | *Compute* | * cpuload |
249 | | * lmbench_cache |
261 | | * computecapacity |
263 +---------------------+-------------------------------------------------------+
264 | *Networking* | * iperf3 |
278 | | * sfc with tacker |
280 | | * vtc instantion validation |
282 | | * vtc instantion validation with noisy neighbors |
284 | | * vtc throughput |
286 | | * vtc throughput in the presence of noisy neighbors |
288 | | * networkcapacity |
290 | | * netutilization |
292 +---------------------+-------------------------------------------------------+
293 | *Parser* | Tosca2Heat |
295 +---------------------+-------------------------------------------------------+
298 | | storagecapacity |
300 +---------------------+-------------------------------------------------------+
301 | *StorPerf* | storperf |
303 +---------------------+-------------------------------------------------------+
306 **API to Other Frameworks**
308 +---------------------+-------------------------------------------------------+
309 | **Framework** | **Description** |
311 +---------------------+-------------------------------------------------------+
312 | *ApexLake* | Experimental framework that enables the user to |
313 | | validate NFVI from the perspective of a VNF. |
314 | | A virtual Traffic Classifier is utilized as VNF. |
315 | | Enables experiments with SR-IOV on Compute Node. |
317 +---------------------+-------------------------------------------------------+
320 **Test Results Output**
322 +-----------------------------+-----------------------------------------------+
323 | **Dispatcher** | **Description** |
325 +-----------------------------+-----------------------------------------------+
326 | file | Log to a file. |
328 +-----------------------------+-----------------------------------------------+
329 | http | Post data to html. |
331 +-----------------------------+-----------------------------------------------+
332 | influxdb | Post data to influxDB. |
334 +-----------------------------+-----------------------------------------------+
340 * Generic NFVI test cases
342 * OPNFV_YARDSTICK_TCOO1 - NW Performance
344 * OPNFV_YARDSTICK_TCOO2 - NW Latency
346 * OPNFV_YARDSTICK_TCOO4 - Cache Utilization
348 * OPNFV_YARDSTICK_TCOO5 - Storage Performance
350 * OPNFV_YARDSTICK_TCOO8 - Packet Loss Extended Test
352 * OPNFV_YARDSTICK_TCOO9 - Packet Loss
354 * OPNFV_YARDSTICK_TCO10 - Memory Latency
356 * OPNFV_YARDSTICK_TCO11 - Packet Delay Variation Between VMs
358 * OPNFV_YARDSTICK_TCO12 - Memory Bandwidth
360 * OPNFV_YARDSTICK_TCO14 - Processing Speed
362 * OPNFV_YARDSTICK_TCO24 - CPU Load
364 * OPNFV_YARDSTICK_TCO37 - Latency, CPU Load, Throughput, Packet Loss
366 * OPNFV_YARDSTICK_TCO38 - Latency, CPU Load, Throughput, Packet Loss Extended
369 * OPNFV_YARDSTICK_TCO42 - Network Performance
371 * OPNFV_YARDSTICK_TCO43 - Network Latency Between NFVI Nodes
373 * OPNFV_YARDSTICK_TCO44 - Memory Utilization
375 * OPNFV_YARDSTICK_TCO55 - Compute Capacity
377 * OPNFV_YARDSTICK_TCO61 - Network Utilization
379 * OPNFV_YARDSTICK_TCO63 - Storage Capacity
381 * OPNFV_YARDSTICK_TCO69 - Memory Bandwidth
383 * OPNFV_YARDSTICK_TCO70 - Latency, Memory Utilization, Throughput, Packet
386 * OPNFV_YARDSTICK_TCO71 - Latency, Cache Utilization, Throughput, Packet Loss
388 * OPNFV_YARDSTICK_TCO72 - Latency, Network Utilization, Throughput, Packet
391 * OPNFV_YARDSTICK_TC073 - Network Latency and Throughput Between Nodes
393 * OPNFV_YARDSTICK_TCO75 - Network Capacity and Scale
395 * Test Cases for OPNFV HA Project:
397 * OPNFV_YARDSTICK_TCO19 - HA: Control node Openstack service down
399 * OPNFV_YARDSTICK_TC025 - HA: OpenStacK Controller Node abnormally down
401 * OPNFV_YARDSTICK_TCO45 - HA: Control node Openstack service down - neutron
404 * OPNFV_YARDSTICK_TC046 - HA: Control node Openstack service down - keystone
406 * OPNFV_YARDSTICK_TCO47 - HA: Control node Openstack service down - glance
409 * OPNFV_YARDSTICK_TC048 - HA: Control node Openstack service down - cinder
412 * OPNFV_YARDSTICK_TCO49 - HA: Control node Openstack service down - swift
415 * OPNFV_YARDSTICK_TC050 - HA: OpenStack Controller Node Network High
418 * OPNFV_YARDSTICK_TCO51 - HA: OpenStack Controller Node CPU Overload High
421 * OPNFV_YARDSTICK_TC052 - HA: OpenStack Controller Node Disk I/O Block High
424 * OPNFV_YARDSTICK_TCO53 - HA: OpenStack Controller Load Balance Service High
427 * OPNFV_YARDSTICK_TC054 - HA: OpenStack Virtual IP High Availability
429 * Test Case for OPNFV IPv6 Project:
431 * OPNFV_YARDSTICK_TCO27 - IPv6 connectivity
433 * Test Case for OPNFV KVM Project:
435 * OPNFV_YARDSTICK_TCO28 - KVM Latency measurements
437 * Test Case for OPNFV Parser Project:
439 * OPNFV_YARDSTICK_TCO40 - Verify Parser Yang-to-Tosca
441 * Test Case for OPNFV StorPerf Project:
443 * OPNFV_YARDSTICK_TCO74 - Storperf
445 * Test Cases for Virtual Traffic Classifier:
447 * OPNFV_YARDSTICK_TC006 - Virtual Traffic Classifier Data Plane Throughput
450 * OPNFV_YARDSTICK_TC007 - Virtual Traffic Classifier Data Plane Throughput
451 Benchmarking in presence of noisy neighbors Test
453 * OPNFV_YARDSTICK_TC020 - Virtual Traffic Classifier Instantiation Test
455 * OPNFV_YARDSTICK_TC021 - Virtual Traffic Classifier Instantiation in
456 presence of noisy neighbors Test
462 Module Version Changes
463 ----------------------
465 This is the third tracked release of Yardstick. It is based on following
472 - OpenDaylight Beryllium
475 Document Version Changes
476 ------------------------
478 This is the first tracked version of the Yardstick framework in OPNFV.
479 It includes the following documentation updates:
481 - Yardstick User Guide: added yardstick plugin chapter; added Store Other
482 Project's Test Results in InfluxDB chapter; Refine yardstick instantion chapter.
484 - Yardstick Code Documentation: no changes
486 - Yardstick Release Notes for Yardstick: this document
488 - Test Results report for Colorado testing with Yardstick: updated listed of
489 verified scenarios and limitations
500 For Colorado 1.0, Yardstick was tested on the following scenarios:
502 +-------------------------+---------+---------+---------+---------+
503 | Scenario | Apex | Compass | Fuel | Joid |
504 +=========================+=========+=========+=========+=========+
505 | os-nosdn-nofeature-noha | | | | X |
506 +-------------------------+---------+---------+---------+---------+
507 | os-nosdn-nofeature-ha | X | | X | X |
508 +-------------------------+---------+---------+---------+---------+
509 | os-odl_l2-nofeature-ha | X | X | X | X |
510 +-------------------------+---------+---------+---------+---------+
511 | os-odl_l2-nofeature-noha| | X | | |
512 +-------------------------+---------+---------+---------+---------+
513 | os-odl_l3-nofeature-ha | X | | X | |
514 +-------------------------+---------+---------+---------+---------+
515 | os-odl_l3-nofeature-ha | | X | | |
516 +-------------------------+---------+---------+---------+---------+
517 | os-onos-sfc-ha | X | | X | X |
518 +-------------------------+---------+---------+---------+---------+
519 | os-onos-nofeature-ha | X | | X | X |
520 +-------------------------+---------+---------+---------+---------+
521 | os-onos-nofeature-noha | | X | | |
522 +-------------------------+---------+---------+---------+---------+
523 | os-odl_l2-sfc-ha | | | X | |
524 +-------------------------+---------+---------+---------+---------+
525 | os-odl_l2-sfc-noha | X | X | | |
526 +-------------------------+---------+---------+---------+---------+
527 | os-odl_l2-bgpvpn-ha | X | | X | |
528 +-------------------------+---------+---------+---------+---------+
529 | os-odl_l2-bgpvpn-noha | | X | | |
530 +-------------------------+---------+---------+---------+---------+
531 | os-nosdn-kvm-ha | | | X | |
532 +-------------------------+---------+---------+---------+---------+
533 | os-nosdn-kvm-noha | | X | | |
534 +-------------------------+---------+---------+---------+---------+
535 | os-nosdn-ovs-ha | | | | |
536 +-------------------------+---------+---------+---------+---------+
537 | os-nosdn-ovs-noha | X | X | | |
538 +-------------------------+---------+---------+---------+---------+
539 | os-ocl-nofeature-ha | | | | |
540 +-------------------------+---------+---------+---------+---------+
541 | os-nosdn-lxd-ha | | | | X |
542 +-------------------------+---------+---------+---------+---------+
543 | os-nosdn-lxd-noha | | | | X |
544 +-------------------------+---------+---------+---------+---------+
545 | os-odl_l2-fdio-noha | X | | | |
546 +-------------------------+---------+---------+---------+---------+
552 Test results are available in:
554 - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/
556 The reporting pages can be found at:
558 * apex: http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-apex.html
559 * compass: http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-compass.html
560 * fuel: http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-fuel.html
561 * joid: http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-joid.html
563 You can get additional details through test logs on http://artifacts.opnfv.org/.
564 As no search engine is available on the OPNFV artifact web site you must
565 retrieve the pod identifier on which the tests have been executed (see
566 field pod in any of the results) then click on the selected POD and look
567 for the date of the test you are interested in.
572 - Boot up VM failed in joid-os-nosdn-lxd-ha and joid-os-nosdn-lxd-noha scenarios
573 - Yardstick CI job timeout in fuel-os-onos-nofeature-ha scenario
574 - SSH timeout in apex-os-onos-sfc-ha, apex-os-onos-nofeature-ha scenarios
575 - Floating IP not supported in apex-os-odl_l3-nofeature-ha scenario
576 - Scp /home/stack/overcloudrc failed in apex-os-nosdn-ovs-noha and apex-os-odl_l2-sfc-noha scenarios
578 .. note:: The faults not related to *Yardstick* framework, addressing scenarios
579 which were not fully verified, are listed in the OPNFV installer's release
588 Colorado known restrictions/issues
589 ==================================
590 +-----------+-----------+----------------------------------------------+
591 | Installer | Scenario | Issue |
592 +===========+===========+==============================================+
593 | any | *-bgpvpn | Floating ips not supported. Some Test cases |
594 | | | related to floating ips are excluded. |
595 +-----------+-----------+----------------------------------------------+
596 | any | odl_l3-* | Some test cases related to using floating IP |
597 | | | addresses fail because of a known ODL bug. |
598 | | | https://jira.opnfv.org/browse/APEX-112 |
599 +-----------+-----------+----------------------------------------------+
600 | apex | *-fdio | Due to late integration, fdio scenarios' |
601 | | | test suite file is not provided. |
602 +-----------+-----------+----------------------------------------------+
603 | joid | *-lxd | In the LXD scenarios, nova-lxd does not |
604 | | | support qcow2 Images. |
605 | | | https://jira.opnfv.org/browse/YARDSTICK-325 |
606 +-----------+-----------+----------------------------------------------+
612 +------------------+-----------------------------------------------+
613 | JIRA | Description |
614 +==================+===============================================+
615 | `YARDSTICK-325`_ | Add imge format support for LXD scenario |
617 +------------------+-----------------------------------------------+
623 - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick
625 - wiki Yardstick Colorado release planing page: https://wiki.opnfv.org/display/yardstick/Yardstick+Colorado+Release+Planning
627 - wiki Yardstick Colorado release jira page: https://wiki.opnfv.org/display/yardstick/Jira+Yardstick-Colorado
629 - Yardstick repo: https://git.opnfv.org/cgit/yardstick
631 - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick
633 - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/
635 - Yardstick IRC chanel: #opnfv-yardstick
637 .. _`YARDSTICK-325` : https://jira.opnfv.org/browse/YARDSTICK-325