docs/release/release-notes/release-notes.rst

   1 =======
   2 License
   3 =======
   4
   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/>.
   9
  10 The *Yardstick framework*, the *Yardstick test cases* are open-source software,
  11  licensed under the terms of the Apache License, Version 2.0.
  12
  13 =======================================
  14 OPNFV Fraser Release Note for Yardstick
  15 =======================================
  16
  17 .. toctree::
  18    :maxdepth: 2
  19
  20 .. _Yardstick: https://wiki.opnfv.org/yardstick
  21
  22 .. _Dashboard: http://testresults.opnfv.org/grafana/dashboard/db/yardstick-main
  23
  24 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
  25
  26
  27 Abstract
  28 ========
  29
  30 This document describes the release note of Yardstick project.
  31
  32
  33 Version History
  34 ===============
  35 +-------------------+-----------+---------------------------------+
  36 | *Date*            | *Version* | *Comment*                       |
  37 |                   |           |                                 |
  38 +-------------------+-----------+---------------------------------+
  39 | May 25, 2018      | 6.1.0     | Yardstick for Fraser release    |
  40 |                   |           |                                 |
  41 +-------------------+-----------+---------------------------------+
  42 | April 27, 2018    | 6.0.0     | Yardstick for Fraser release    |
  43 |                   |           |                                 |
  44 +-------------------+-----------+---------------------------------+
  45
  46
  47 Important Notes
  48 ===============
  49
  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_.
  53
  54 The *Yardstick* framework is *installer*, *infrastructure* and *application*
  55 independent.
  56
  57 OPNFV Fraser Release
  58 ====================
  59
  60 This Fraser release provides *Yardstick* as a framework for NFVI testing
  61 and OPNFV feature testing, automated in the OPNFV CI pipeline, including:
  62
  63 * Documentation generated with Sphinx
  64
  65   * User Guide
  66   * Developer Guide
  67   * Release notes (this document)
  68   * Results
  69
  70 * Automated Yardstick test suite (daily, weekly)
  71
  72   * Jenkins Jobs for OPNFV community labs
  73
  74 * Automated Yardstick test results visualization
  75
  76   * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
  77     backend
  78
  79 * Yardstick framework source code
  80
  81 * Yardstick test cases yaml files
  82
  83 * Yardstick plug-in configuration yaml files, plug-in install/remove scripts
  84
  85 For Fraser release, the *Yardstick framework* is used for the following
  86 testing:
  87
  88 * OPNFV platform testing - generic test cases to measure the categories:
  89
  90   * Compute
  91   * Network
  92   * Storage
  93
  94 * OPNFV platform network service benchmarking (NSB)
  95
  96   * NSB
  97
  98 * Test cases for the following OPNFV Projects:
  99
 100   * Container4NFV
 101   * High Availability
 102   * IPv6
 103   * KVM
 104   * Parser
 105   * StorPerf
 106   * VSperf
 107
 108 The *Yardstick framework* is developed in the OPNFV community, by the
 109 Yardstick_ team.
 110
 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.
 114
 115
 116 Release Data
 117 ============
 118
 119 +--------------------------------+-----------------------+
 120 | **Project**                    | Yardstick             |
 121 |                                |                       |
 122 +--------------------------------+-----------------------+
 123 | **Repo/tag**                   | yardstick/opnfv-6.1.0 |
 124 |                                |                       |
 125 +--------------------------------+-----------------------+
 126 | **Yardstick Docker image tag** | opnfv-6.1.0           |
 127 |                                |                       |
 128 +--------------------------------+-----------------------+
 129 | **Release designation**        | Fraser                |
 130 |                                |                       |
 131 +--------------------------------+-----------------------+
 132 | **Release date**               | May 25, 2018          |
 133 |                                |                       |
 134 +--------------------------------+-----------------------+
 135 | **Purpose of the delivery**    | OPNFV Fraser 6.1.0    |
 136 |                                |                       |
 137 +--------------------------------+-----------------------+
 138
 139
 140 Deliverables
 141 ============
 142
 143 Documents
 144 ---------
 145
 146  - User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/user/userguide/index.html
 147
 148  - Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/yardstick/docs/testing/developer/devguide/index.html
 149
 150
 151 Software Deliverables
 152 ---------------------
 153
 154  - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-6.1.0)
 155
 156 List of Contexts
 157 ^^^^^^^^^^^^^^^^
 158
 159 +--------------+-------------------------------------------+
 160 | **Context**  | **Description**                           |
 161 |              |                                           |
 162 +--------------+-------------------------------------------+
 163 | *Heat*       | Models orchestration using OpenStack Heat |
 164 |              |                                           |
 165 +--------------+-------------------------------------------+
 166 | *Node*       | Models Baremetal, Controller, Compute     |
 167 |              |                                           |
 168 +--------------+-------------------------------------------+
 169 | *Standalone* | Models VM running on Non-Managed NFVi     |
 170 |              |                                           |
 171 +--------------+-------------------------------------------+
 172 | *Kubernetes* | Models VM running on Non-Managed NFVi     |
 173 |              |                                           |
 174 +--------------+-------------------------------------------+
 175
 176
 177 List of Runners
 178 ^^^^^^^^^^^^^^^
 179
 180 .. note:: Yardstick Fraser 6.0.0 add two new Runners, "Dynamictp" and "Search".
 181
 182 +---------------+-------------------------------------------------------+
 183 | **Runner**    | **Description**                                       |
 184 |               |                                                       |
 185 +---------------+-------------------------------------------------------+
 186 | *Arithmetic*  | Steps every run arithmetically according to specified |
 187 |               | input value                                           |
 188 |               |                                                       |
 189 +---------------+-------------------------------------------------------+
 190 | *Duration*    | Runs for a specified period of time                   |
 191 |               |                                                       |
 192 +---------------+-------------------------------------------------------+
 193 | *Iteration*   | Runs for a specified number of iterations             |
 194 |               |                                                       |
 195 +---------------+-------------------------------------------------------+
 196 | *Sequence*    | Selects input value to a scenario from an input file  |
 197 |               | and runs all entries sequentially                     |
 198 |               |                                                       |
 199 +---------------+-------------------------------------------------------+
 200 | **Dynamictp** | A runner that searches for the max throughput with    |
 201 |               | binary search                                         |
 202 |               |                                                       |
 203 +---------------+-------------------------------------------------------+
 204 | **Search**    | A runner that runs a specific time before it returns  |
 205 |               |                                                       |
 206 +---------------+-------------------------------------------------------+
 207
 208
 209 List of Scenarios
 210 ^^^^^^^^^^^^^^^^^
 211
 212 +----------------+-----------------------------------------------------+
 213 | **Category**   | **Delivered**                                       |
 214 |                |                                                     |
 215 +----------------+-----------------------------------------------------+
 216 | *Availability* | Attacker:                                           |
 217 |                |                                                     |
 218 |                | * baremetal, process                                |
 219 |                |                                                     |
 220 |                | HA tools:                                           |
 221 |                |                                                     |
 222 |                | * check host, openstack, process, service           |
 223 |                | * kill process                                      |
 224 |                | * start/stop service                                |
 225 |                |                                                     |
 226 |                | Monitor:                                            |
 227 |                |                                                     |
 228 |                | * command, process                                  |
 229 |                |                                                     |
 230 +----------------+-----------------------------------------------------+
 231 | *Compute*      | * cpuload                                           |
 232 |                | * cyclictest                                        |
 233 |                | * lmbench                                           |
 234 |                | * lmbench_cache                                     |
 235 |                | * perf                                              |
 236 |                | * unixbench                                         |
 237 |                | * ramspeed                                          |
 238 |                | * cachestat                                         |
 239 |                | * memeoryload                                       |
 240 |                | * computecapacity                                   |
 241 |                | * SpecCPU2006                                       |
 242 |                |                                                     |
 243 +----------------+-----------------------------------------------------+
 244 | *Networking*   | * iperf3                                            |
 245 |                | * netperf                                           |
 246 |                | * netperf_node                                      |
 247 |                | * ping                                              |
 248 |                | * ping6                                             |
 249 |                | * pktgen                                            |
 250 |                | * sfc                                               |
 251 |                | * sfc with tacker                                   |
 252 |                | * networkcapacity                                   |
 253 |                | * netutilization                                    |
 254 |                | * nstat                                             |
 255 |                | * pktgenDPDK                                        |
 256 |                |                                                     |
 257 +----------------+-----------------------------------------------------+
 258 | *Parser*       | Tosca2Heat                                          |
 259 |                |                                                     |
 260 +----------------+-----------------------------------------------------+
 261 | *Storage*      | * fio                                               |
 262 |                | * bonnie++                                          |
 263 |                | * storagecapacity                                   |
 264 |                |                                                     |
 265 +----------------+-----------------------------------------------------+
 266 | *StorPerf*     | storperf                                            |
 267 |                |                                                     |
 268 +----------------+-----------------------------------------------------+
 269 | *NSB*          | vFW thoughput test case                             |
 270 |                |                                                     |
 271 +----------------+-----------------------------------------------------+
 272
 273
 274 New Test cases
 275 --------------
 276
 277 .. note:: Yardstick Fraser 6.1.0 added two new test cases, "TC092" and "TC093".
 278
 279 * Generic NFVI test cases
 280
 281  * OPNFV_YARDSTICK_TCO84 - SPEC CPU 2006 for VM
 282
 283 * HA Test cases
 284
 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
 290
 291
 292 Version Change
 293 ==============
 294
 295 Module Version Changes
 296 ----------------------
 297
 298 This is the sixth tracked release of Yardstick. It is based on following
 299 upstream versions:
 300
 301 - OpenStack Pike
 302 - OpenDayLight Oxygen
 303
 304
 305 Document Version Changes
 306 ------------------------
 307
 308 This is the sixth tracked version of the Yardstick framework in OPNFV.
 309 It includes the following documentation updates:
 310
 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
 316
 317
 318 Feature additions
 319 -----------------
 320
 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
 328
 329
 330 Scenario Matrix
 331 ===============
 332
 333 For Fraser 6.0.0, Yardstick was tested on the following scenarios:
 334
 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 +-------------------------+------+---------+----------+------+------+-------+
 364
 365
 366 Test results
 367 ============
 368
 369 Test results are available in:
 370
 371  - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/
 372
 373 The reporting pages can be found at:
 374
 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 +---------------+----------------------------------------------------------------------------------+
 386
 387 Known Issues/Faults
 388 -------------------
 389
 390
 391 Corrected Faults
 392 ----------------
 393
 394 Fraser 6.1.0:
 395
 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 +--------------------+--------------------------------------------------------------------------+
 415
 416 Fraser 6.0.0:
 417
 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 +--------------------+--------------------------------------------------------------------------+
 482
 483 Fraser 6.0.0 known restrictions/issues
 484 ======================================
 485
 486 +-----------+-----------+----------------------------------------------+
 487 | Installer | Scenario  | Issue                                        |
 488 +===========+===========+==============================================+
 489 |           |           |                                              |
 490 +-----------+-----------+----------------------------------------------+
 491
 492 Useful links
 493 ============
 494
 495  - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick
 496
 497  - wiki Yardstick Fraser release planing page: https://wiki.opnfv.org/display/yardstick/Release+Fraser
 498
 499  - Yardstick repo: https://git.opnfv.org/cgit/yardstick
 500
 501  - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick
 502
 503  - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/
 504
 505  - Yardstick IRC chanel: #opnfv-yardstick