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

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, Intel Corporation and others.
   5
   6 =======
   7 License
   8 =======
   9
  10 OPNFV release note for SampleVNF Docs
  11 are licensed under a Creative Commons Attribution 4.0 International License.
  12 You should have received a copy of the license along with this.
  13 If not, see <http://creativecommons.org/licenses/by/4.0/>.
  14 :
  15
  16 The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
  17 licensed under the terms of the Apache License, Version 2.0.
  18
  19 ==========================================
  20 OPNFV Gambia Release Note for SampleVNF
  21 ==========================================
  22
  23 .. toctree::
  24    :maxdepth: 2
  25
  26 .. _SampleVNF: https://wiki.opnfv.org/SAM
  27
  28 .. _Yardstick: https://wiki.opnfv.org/yardstick
  29
  30 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
  31
  32
  33 Abstract
  34 ========
  35
  36 This document describes the release note of SampleVNF project.
  37
  38
  39 Version History
  40 ===============
  41
  42 +----------------+--------------------+---------------------------------+
  43 | *Date*         | *Version*          | *Comment*                       |
  44 |                |                    |                                 |
  45 +----------------+--------------------+---------------------------------+
  46 | "Jan 17 2019"  |  7.2.0             | SampleVNF for Gambia release    |
  47 |                |                    |                                 |
  48 +----------------+--------------------+---------------------------------+
  49
  50
  51 Important Notes
  52 ===============
  53
  54 The software delivered in the OPNFV SampleVNF_ Project, comprising the
  55 *SampleVNF VNFs* and performance test case are part of  OPNFV Yardstick_
  56 Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
  57
  58
  59 OPNFV Gambia Release
  60 ======================
  61
  62 This Gambia release provides *SampleVNF* as a approx VNF repository for
  63 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
  64 OPNFV platform, including:
  65
  66 * Documentation generated with Sphinx
  67
  68   * User Guide
  69
  70   * Developer Guide
  71
  72   * Release notes (this document)
  73
  74   * Results
  75
  76 * Automated SampleVNF test suit in OPNFV Yardstick_ Project
  77
  78 * SampleVNF source code
  79
  80 For Gambia release, the *SampleVNF* supported:
  81
  82 +----------------+---------------------------------------------------------+-------------------+
  83 | *VNF*          |                 *Name*                                  |    *version*      |
  84 +----------------+---------------------------------------------------------+-------------------+
  85 | *CGNAPT*       | Carrier Grade Network Address and port Translation .5.0 |     v0.1.0        |
  86 +----------------+---------------------------------------------------------+-------------------+
  87 | *Prox*         | Packet pROcessing eXecution engine                      |     v0.40.0       |
  88 |                |  acts as traffic generator, L3FWD, L2FWD, BNG etc       |                   |
  89 +----------------+---------------------------------------------------------+-------------------+
  90 | *vACL*         | Access Control List                                     |     v0.1.0        |
  91 +----------------+---------------------------------------------------------+-------------------+
  92 | *vFW*          | Firewall                                                |     v0.1.0        |
  93 +----------------+---------------------------------------------------------+-------------------+
  94 | *UDP_replay*   | UDP_Replay                                              |     v0.1.0        |
  95 +----------------+---------------------------------------------------------+-------------------+
  96
  97 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
  98           and user guide.
  99
 100 For Gambia release, the *SampleVNF* is used for the following
 101 testing:
 102
 103 * OPNFV platform testing - generic test cases to measure the categories:
 104
 105   * NFVI Characterization:
 106
 107     * Network
 108
 109   * VNF Characterization:
 110
 111     * Network - rfc2544, rfc3511, latency, http_test etc
 112
 113
 114 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
 115 The *Network Service Benchmarking* SampleVNF Characterization Testing tool is a part of the
 116 Yardstick Project.
 117
 118 .. note:: The test case description template used for the SampleVNF in yardstick
 119   test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
 120   used for the SampleVNF test results is based on the IEEE Std 829-2008.
 121
 122
 123 Release Data
 124 ============
 125
 126 +--------------------------------------+--------------------------------------+
 127 | **Project**                          | SampleVNF                            |
 128 |                                      |                                      |
 129 +--------------------------------------+--------------------------------------+
 130 | **Repo/tag**                         | opnfv-7.2.0                          |
 131 |                                      |                                      |
 132 +--------------------------------------+--------------------------------------+
 133 | **SampleVNF Docker image tag**       | Gambia 7.2                           |
 134 |                                      |                                      |
 135 +--------------------------------------+--------------------------------------+
 136 | **Release designation**              | Gambia 7.2                           |
 137 |                                      |                                      |
 138 +--------------------------------------+--------------------------------------+
 139 | **Release date**                     | "Dec 14 2018"                        |
 140 |                                      |                                      |
 141 +--------------------------------------+--------------------------------------+
 142 | **Purpose of the delivery**          | Gambia alignment to Released         |
 143 |                                      | bug-fixes for the following:         |
 144 |                                      | - Memory leak                        |
 145 |                                      | - minimum latency                    |
 146 |                                      | - Increase default mbuf size and     |
 147 |                                      |   code simplification/cleanup        |
 148 |                                      | - Crash in rx/tx distribution        |
 149 |                                      |                                      |
 150 +--------------------------------------+--------------------------------------+
 151
 152
 153 Deliverables
 154 ============
 155
 156 Documents
 157 ---------
 158
 159  - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
 160
 161  - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
 162
 163
 164 Software Deliverables
 165 ---------------------
 166
 167  - The SampleVNF Docker image: To be added
 168
 169
 170 **SampleVNF tested on Contexts**
 171
 172 +---------------------+-------------------------------------------------------+
 173 | **Context**         | **Description**                                       |
 174 |                     |                                                       |
 175 +---------------------+-------------------------------------------------------+
 176 | *Heat*              | Models orchestration using OpenStack Heat             |
 177 |                     |                                                       |
 178 +---------------------+-------------------------------------------------------+
 179 | *Node*              | Models Baremetal, Controller, Compute                 |
 180 |                     |                                                       |
 181 +---------------------+-------------------------------------------------------+
 182 | *Standalone*        | Models VM running on Non-Managed NFVi                 |
 183 |                     |                                                       |
 184 +---------------------+-------------------------------------------------------+
 185
 186 Document Version Changes
 187 ------------------------
 188
 189 This is the first version of the SampleVNF  in OPNFV.
 190 It includes the following documentation updates:
 191
 192 - SampleVNF User Guide:
 193
 194 - SampleVNF Developer Guide
 195
 196 - SampleVNF Release Notes for SampleVNF: this document
 197
 198
 199 Feature additions
 200 -----------------
 201
 202 - Support for DPDK 18.05 and DPDK 18.08
 203 - Add support for counting non dataplane related packets
 204 - test improvements and fixes for image creation
 205 - Local Documentation Builds
 206 - Improve l3fwd performance
 207 - Enable the local cache mac address
 208 - Initial support for DPDK 18.05
 209 - Adding centos.json to be used with packer to generate a VM with PROX
 210 - Adding support for Ubuntu 17.10...
 211 - Get multiple port stats simultaneously
 212 - Increase default mbuf size and code simplification/cleanup
 213 - update from src port in the pvt/pub handler
 214
 215 Bug fixes:
 216 - Fix potential crash with latency accuracy
 217 - TempFix: vCGNAPT/vACL ipv4 perf issue
 218 - Temp Fix for vFW perf issue
 219 - fix code standard in VNFs/DPPD-PROX/handle_esp.c
 220 - Workaround DPDK net/virtio queue setup issue
 221 - Fix potential crash when shuffling mbufs
 222
 223
 224 Known Issues/Faults
 225 -------------------
 226 - Huge page freeing needs to be handled properly while running the application else it might
 227   cause system crash. Known issue from DPDK.
 228 - UDP Replay is used to capture throughput for dynamic cgnapt
 229 - Hardware Checksum offload is not supported for IPv6 traffic
 230 - SampleVNF on sriov is tested till 4 threads
 231 - Rest API is supported only for vACL, vFW, vCGNAPT
 232 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
 233
 234 Corrected Faults
 235 ----------------
 236
 237 Gambia 7.2:
 238
 239 +----------------------------+-------------------------------------------------------------------+
 240 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 241 +----------------------------+-------------------------------------------------------------------+
 242 | SAMPLEVNF-129              |  Support for DPDK 18.05 and DPDK 18.08                            |
 243 +----------------------------+-------------------------------------------------------------------+
 244 | SAMPLEVNF-130              |  Add support for counting non dataplane related packets           |
 245 +----------------------------+-------------------------------------------------------------------+
 246 | SAMPLEVNF-131              |  test improvements and fixes for image creation                   |
 247 +----------------------------+-------------------------------------------------------------------+
 248 | SAMPLEVNF-132              |  Local Documentation Builds                                       |
 249 +----------------------------+-------------------------------------------------------------------+
 250 | SAMPLEVNF-133              |  Improve l3fwd performance                                        |
 251 +----------------------------+-------------------------------------------------------------------+
 252 | SAMPLEVNF-134              |  Enable the local cache mac address                               |
 253 +----------------------------+-------------------------------------------------------------------+
 254 | SAMPLEVNF-135              |  Initial support for DPDK 18.05                                   |
 255 +----------------------------+-------------------------------------------------------------------+
 256 | SAMPLEVNF-136              |  Adding centos.json to be used with packer to generate a VM with PROX|
 257 +----------------------------+-------------------------------------------------------------------+
 258 | SAMPLEVNF-137              |  Adding support for Ubuntu 17.20...                               |
 259 +----------------------------+-------------------------------------------------------------------+
 260 | SAMPLEVNF-138              |  Get multiple port stats simultaneously                           |
 261 +----------------------------+-------------------------------------------------------------------+
 262 | SAMPLEVNF-139              |  Increase default mbuf size and code simplification/cleanup       |
 263 +----------------------------+-------------------------------------------------------------------+
 264 | SAMPLEVNF-140              |  update from src port in the pvt/pub handler                      |
 265 +----------------------------+-------------------------------------------------------------------+
 266
 267
 268
 269
 270 Bug Fix Jira:
 271
 272 +----------------------------+-------------------------------------------------------------------+
 273 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 274 +----------------------------+-------------------------------------------------------------------+
 275 | SAMPLEVNF-141              |  Fix potential crash with latency accuracy                        |
 276 +----------------------------+-------------------------------------------------------------------+
 277 | SAMPLEVNF-142              |  TempFix: vCGNAPT/vACL ipv4 perf issue                            |
 278 +----------------------------+-------------------------------------------------------------------+
 279 | SAMPLEVNF-143              |  Temp Fix for vFW perf issue                                      |
 280 +----------------------------+-------------------------------------------------------------------+
 281 | SAMPLEVNF-144              |  fix code standard in VNFs/DPPD-PROX/handle_esp.c                 |
 282 +----------------------------+-------------------------------------------------------------------+
 283 | SAMPLEVNF-145              |  Workaround DPDK net/virtio queue setup issue                     |
 284 +----------------------------+-------------------------------------------------------------------+
 285 | SAMPLEVNF-146              |  Fix potential crash when shuffling mbufs                         |
 286 +----------------------------+-------------------------------------------------------------------+
 287
 288 Gambia known restrictions/issues
 289 ====================================
 290 +-----------+-----------+----------------------------------------------+
 291 | Installer | Scenario  |  Issue                                       |
 292 +===========+===========+==============================================+
 293 |           |           |                                              |
 294 +-----------+-----------+----------------------------------------------+
 295
 296
 297 Open JIRA tickets
 298 =================
 299
 300 +----------------------------+------------------------------------------------+
 301 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 302 |                            |                                                |
 303 +----------------------------+------------------------------------------------+
 304 |                            |                                                |
 305 |                            |                                                |
 306 +----------------------------+------------------------------------------------+
 307
 308
 309 Useful links
 310 ============
 311
 312  - wiki project page: https://wiki.opnfv.org/display/SAM
 313
 314  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 315
 316  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 317
 318  - SampleVNF IRC chanel: #opnfv-samplevnf
 319 | SAMPLEVNF-                 |  PROX support for dpdk 18,05                                    |
 320 +----------------------------+-------------------------------------------------------------------+
 321 | SAMPLEVNF-                 |  PROX support for dpdk 18,05                                    |
 322 +----------------------------+-------------------------------------------------------------------+
 323
 324
 325
 326
 327 Bug Fix Jira:
 328
 329 +----------------------------+-------------------------------------------------------------------+
 330 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 331 +----------------------------+-------------------------------------------------------------------+
 332 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 333 +----------------------------+-------------------------------------------------------------------+
 334
 335 Gambia known restrictions/issues
 336 ====================================
 337 +-----------+-----------+----------------------------------------------+
 338 | Installer | Scenario  |  Issue                                       |
 339 +===========+===========+==============================================+
 340 |           |           |                                              |
 341 +-----------+-----------+----------------------------------------------+
 342
 343
 344 Open JIRA tickets
 345 =================
 346
 347 +----------------------------+------------------------------------------------+
 348 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 349 |                            |                                                |
 350 +----------------------------+------------------------------------------------+
 351 |                            |                                                |
 352 |                            |                                                |
 353 +----------------------------+------------------------------------------------+
 354
 355
 356 Useful links
 357 ============
 358
 359  - wiki project page: https://wiki.opnfv.org/display/SAM
 360
 361  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 362
 363  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 364
 365  - SampleVNF IRC chanel: #opnfv-samplevnf
 366
 367
 368
 369
 370 Bug Fix Jira:
 371
 372 +----------------------------+-------------------------------------------------------------------+
 373 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 374 +----------------------------+-------------------------------------------------------------------+
 375 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 376 +----------------------------+-------------------------------------------------------------------+
 377
 378 Gambia known restrictions/issues
 379 ====================================
 380 +-----------+-----------+----------------------------------------------+
 381 | Installer | Scenario  |  Issue                                       |
 382 +===========+===========+==============================================+
 383 |           |           |                                              |
 384 +-----------+-----------+----------------------------------------------+
 385
 386
 387 Open JIRA tickets
 388 =================
 389
 390 +----------------------------+------------------------------------------------+
 391 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 392 |                            |                                                |
 393 +----------------------------+------------------------------------------------+
 394 |                            |                                                |
 395 |                            |                                                |
 396 +----------------------------+------------------------------------------------+
 397
 398
 399 Useful links
 400 ============
 401
 402  - wiki project page: https://wiki.opnfv.org/display/SAM
 403
 404  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 405
 406  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 407
 408  - SampleVNF IRC chanel: #opnfv-samplevnf
 409
 410
 411
 412
 413 Bug Fix Jira:
 414
 415 +----------------------------+-------------------------------------------------------------------+
 416 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 417 +----------------------------+-------------------------------------------------------------------+
 418 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 419 +----------------------------+-------------------------------------------------------------------+
 420
 421 Gambia known restrictions/issues
 422 ====================================
 423 +-----------+-----------+----------------------------------------------+
 424 | Installer | Scenario  |  Issue                                       |
 425 +===========+===========+==============================================+
 426 |           |           |                                              |
 427 +-----------+-----------+----------------------------------------------+
 428
 429
 430 Open JIRA tickets
 431 =================
 432
 433 +----------------------------+------------------------------------------------+
 434 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 435 |                            |                                                |
 436 +----------------------------+------------------------------------------------+
 437 |                            |                                                |
 438 |                            |                                                |
 439 +----------------------------+------------------------------------------------+
 440
 441
 442 Useful links
 443 ============
 444
 445  - wiki project page: https://wiki.opnfv.org/display/SAM
 446
 447  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 448
 449  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 450
 451  - SampleVNF IRC chanel: #opnfv-samplevnf
 452
 453
 454
 455
 456 Bug Fix Jira:
 457
 458 +----------------------------+-------------------------------------------------------------------+
 459 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 460 +----------------------------+-------------------------------------------------------------------+
 461 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 462 +----------------------------+-------------------------------------------------------------------+
 463
 464 Gambia known restrictions/issues
 465 ====================================
 466 +-----------+-----------+----------------------------------------------+
 467 | Installer | Scenario  |  Issue                                       |
 468 +===========+===========+==============================================+
 469 |           |           |                                              |
 470 +-----------+-----------+----------------------------------------------+
 471
 472
 473 Open JIRA tickets
 474 =================
 475
 476 +----------------------------+------------------------------------------------+
 477 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 478 |                            |                                                |
 479 +----------------------------+------------------------------------------------+
 480 |                            |                                                |
 481 |                            |                                                |
 482 +----------------------------+------------------------------------------------+
 483
 484
 485 Useful links
 486 ============
 487
 488  - wiki project page: https://wiki.opnfv.org/display/SAM
 489
 490  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 491
 492  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 493
 494  - SampleVNF IRC chanel: #opnfv-samplevnf
 495
 496
 497
 498
 499 Bug Fix Jira:
 500
 501 +----------------------------+-------------------------------------------------------------------+
 502 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 503 +----------------------------+-------------------------------------------------------------------+
 504 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 505 +----------------------------+-------------------------------------------------------------------+
 506
 507 Gambia known restrictions/issues
 508 ====================================
 509 +-----------+-----------+----------------------------------------------+
 510 | Installer | Scenario  |  Issue                                       |
 511 +===========+===========+==============================================+
 512 |           |           |                                              |
 513 +-----------+-----------+----------------------------------------------+
 514
 515
 516 Open JIRA tickets
 517 =================
 518
 519 +----------------------------+------------------------------------------------+
 520 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 521 |                            |                                                |
 522 +----------------------------+------------------------------------------------+
 523 |                            |                                                |
 524 |                            |                                                |
 525 +----------------------------+------------------------------------------------+
 526
 527
 528 Useful links
 529 ============
 530
 531  - wiki project page: https://wiki.opnfv.org/display/SAM
 532
 533  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 534
 535  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 536
 537  - SampleVNF IRC chanel: #opnfv-samplevnf
 538
 539
 540
 541
 542 Bug Fix Jira:
 543
 544 +----------------------------+-------------------------------------------------------------------+
 545 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 546 +----------------------------+-------------------------------------------------------------------+
 547 | SAMPLEVNF-                 |  Fix samplevnf perf issues          |
 548 +----------------------------+-------------------------------------------------------------------+
 549
 550 Gambia known restrictions/issues
 551 ====================================
 552 +-----------+-----------+----------------------------------------------+
 553 | Installer | Scenario  |  Issue                                       |
 554 +===========+===========+==============================================+
 555 |           |           |                                              |
 556 +-----------+-----------+----------------------------------------------+
 557
 558
 559 Open JIRA tickets
 560 =================
 561
 562 +----------------------------+------------------------------------------------+
 563 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 564 |                            |                                                |
 565 +----------------------------+------------------------------------------------+
 566 |                            |                                                |
 567 |                            |                                                |
 568 +----------------------------+------------------------------------------------+
 569
 570
 571 Useful links
 572 ============
 573
 574  - wiki project page: https://wiki.opnfv.org/display/SAM
 575
 576  - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 577
 578  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 579
 580  - SampleVNF IRC chanel: #opnfv-samplevnf