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 OPNFV Jerma Release
   8 ===================
   9 * The only supported test VNF in this release for dataplane benchmarking purposes is PROX
  10 * PROX supporting up to DPDK:20.05
  11 * Introducing ability to make test cloud-configured dataplane networking benchmarks using
  12   ETSI NFV TST009 standard methods
  13 * Test automation using X-testing
  14
  15
  16 OPNFV Hunter Release
  17 ====================
  18
  19 This Hunter release provides *SampleVNF* as a approx VNF repository for
  20 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
  21 OPNFV platform, including:
  22
  23 * Documentation generated with Sphinx
  24
  25   * User Guide
  26
  27   * Developer Guide
  28
  29   * Release notes (this document)
  30
  31   * Results
  32
  33 * Automated SampleVNF test suit in OPNFV Yardstick Project
  34
  35 * SampleVNF source code
  36
  37 For Hunter release, the *SampleVNF* supported:
  38
  39 +----------------+---------------------------------------------------------+-------------------+
  40 | *VNF*          |                 *Name*                                  |    *version*      |
  41 +----------------+---------------------------------------------------------+-------------------+
  42 | *CGNAPT*       | Carrier Grade Network Address and port Translation .5.0 |     v0.1.0        |
  43 +----------------+---------------------------------------------------------+-------------------+
  44 | *Prox*         | Packet pROcessing eXecution engine                      |     v0.40.0       |
  45 |                | acts as traffic generator, L3FWD, L2FWD, BNG etc        |                   |
  46 +----------------+---------------------------------------------------------+-------------------+
  47 | *vACL*         | Access Control List                                     |     v0.1.0        |
  48 +----------------+---------------------------------------------------------+-------------------+
  49 | *vFW*          | Firewall                                                |     v0.1.0        |
  50 +----------------+---------------------------------------------------------+-------------------+
  51 | *UDP_replay*   | UDP_Replay                                              |     v0.1.0        |
  52 +----------------+---------------------------------------------------------+-------------------+
  53
  54 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
  55           and user guide.
  56
  57 For Hunter release, the *SampleVNF* is used for the following
  58 testing:
  59
  60 * OPNFV platform testing - generic test cases to measure the categories:
  61
  62   * NFVI Characterization:
  63
  64     * Network
  65
  66   * VNF Characterization:
  67
  68     * Network - rfc2544, rfc3511, latency, http_test etc
  69
  70
  71 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF team.
  72 The *Network Service Benchmarking* SampleVNF Characterization Testing tool is a part of the
  73 Yardstick Project.
  74
  75 .. note:: The test case description template used for the SampleVNF in yardstick
  76   test cases is based on the document `ETSI GS NFV-TST 001`_; the results report template
  77   used for the SampleVNF test results is based on the IEEE Std 829-2008.
  78
  79 .. _ETSI GS NFV-TST 001: https://portal.etsi.org/webapp/workprogram/Report_WorkItem.asp?WKI_ID=46009
  80
  81
  82 Release Data
  83 ------------
  84
  85 +--------------------------------------+--------------------------------------+
  86 | **Project**                          | SampleVNF                            |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | **Repo/tag**                         | opnfv-8.0                            |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | **SampleVNF Docker image tag**       | Hunter 8.0                           |
  93 |                                      |                                      |
  94 +--------------------------------------+--------------------------------------+
  95 | **Release designation**              | Hunter 8.0                           |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98 | **Release date**                     | "May 10 2019"                        |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101 | **Purpose of the delivery**          | Hunter alignment to Released         |
 102 |                                      | bug-fixes for the following:         |
 103 |                                      |                                      |
 104 |                                      | - Memory leak                        |
 105 |                                      | - minimum latency                    |
 106 |                                      | - Increase default mbuf size and     |
 107 |                                      |   code simplification/cleanup        |
 108 |                                      | - Crash in rx/tx distribution        |
 109 |                                      |                                      |
 110 +--------------------------------------+--------------------------------------+
 111
 112
 113 Deliverables
 114 ------------
 115
 116 Documents
 117 ^^^^^^^^^
 118
 119  - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
 120
 121  - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
 122
 123
 124 Software Deliverables
 125 ^^^^^^^^^^^^^^^^^^^^^
 126
 127  - The SampleVNF Docker image: To be added
 128
 129
 130 **SampleVNF tested on Contexts**
 131
 132 +---------------------+-------------------------------------------------------+
 133 | **Context**         | **Description**                                       |
 134 |                     |                                                       |
 135 +---------------------+-------------------------------------------------------+
 136 | *Heat*              | Models orchestration using OpenStack Heat             |
 137 |                     |                                                       |
 138 +---------------------+-------------------------------------------------------+
 139 | *Node*              | Models Baremetal, Controller, Compute                 |
 140 |                     |                                                       |
 141 +---------------------+-------------------------------------------------------+
 142 | *Standalone*        | Models VM running on Non-Managed NFVi                 |
 143 |                     |                                                       |
 144 +---------------------+-------------------------------------------------------+
 145
 146 Document Version Changes
 147 ^^^^^^^^^^^^^^^^^^^^^^^^
 148
 149 This is the first version of the SampleVNF  in OPNFV.
 150 It includes the following documentation updates:
 151
 152 - SampleVNF User Guide:
 153
 154 - SampleVNF Developer Guide
 155
 156 - SampleVNF Release Notes for SampleVNF: this document
 157
 158
 159 Feature additions
 160 ^^^^^^^^^^^^^^^^^
 161
 162 - Support for DPDK 18.05 and DPDK 18.08
 163 - Add support for counting non dataplane related packets
 164 - test improvements and fixes for image creation
 165 - Local Documentation Builds
 166 - Improve l3fwd performance
 167 - Enable the local cache mac address
 168 - Initial support for DPDK 18.05
 169 - Adding centos.json to be used with packer to generate a VM with PROX
 170 - Adding support for Ubuntu 17.10...
 171 - Get multiple port stats simultaneously
 172 - Increase default mbuf size and code simplification/cleanup
 173 - update from src port in the pvt/pub handler
 174
 175 Bug fixes:
 176 - Fix potential crash with latency accuracy
 177 - TempFix: vCGNAPT/vACL ipv4 perf issue
 178 - Temp Fix for vFW perf issue
 179 - fix code standard in VNFs/DPPD-PROX/handle_esp.c
 180 - Workaround DPDK net/virtio queue setup issue
 181 - Fix potential crash when shuffling mbufs
 182
 183
 184 Known Issues/Faults
 185 ^^^^^^^^^^^^^^^^^^^
 186 - Huge page freeing needs to be handled properly while running the application else it might
 187   cause system crash. Known issue from DPDK.
 188 - UDP Replay is used to capture throughput for dynamic cgnapt
 189 - Hardware Checksum offload is not supported for IPv6 traffic
 190 - SampleVNF on sriov is tested till 4 threads
 191 - Rest API is supported only for vACL, vFW, vCGNAPT
 192 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
 193
 194 Corrected Faults
 195 ^^^^^^^^^^^^^^^^
 196
 197 Hunter 8.2:
 198
 199 +----------------------------+----------------------------------------------------------------------+
 200 | **JIRA REFERENCE**         | **DESCRIPTION**                                                      |
 201 +----------------------------+----------------------------------------------------------------------+
 202 | SAMPLEVNF-129              |  Support for DPDK 18.05 and DPDK 18.08                               |
 203 +----------------------------+----------------------------------------------------------------------+
 204 | SAMPLEVNF-130              |  Add support for counting non dataplane related packets              |
 205 +----------------------------+----------------------------------------------------------------------+
 206 | SAMPLEVNF-131              |  test improvements and fixes for image creation                      |
 207 +----------------------------+----------------------------------------------------------------------+
 208 | SAMPLEVNF-132              |  Local Documentation Builds                                          |
 209 +----------------------------+----------------------------------------------------------------------+
 210 | SAMPLEVNF-133              |  Improve l3fwd performance                                           |
 211 +----------------------------+----------------------------------------------------------------------+
 212 | SAMPLEVNF-134              |  Enable the local cache mac address                                  |
 213 +----------------------------+----------------------------------------------------------------------+
 214 | SAMPLEVNF-135              |  Initial support for DPDK 18.05                                      |
 215 +----------------------------+----------------------------------------------------------------------+
 216 | SAMPLEVNF-136              |  Adding centos.json to be used with packer to generate a VM with PROX|
 217 +----------------------------+----------------------------------------------------------------------+
 218 | SAMPLEVNF-137              |  Adding support for Ubuntu 17.20...                                  |
 219 +----------------------------+----------------------------------------------------------------------+
 220 | SAMPLEVNF-138              |  Get multiple port stats simultaneously                              |
 221 +----------------------------+----------------------------------------------------------------------+
 222 | SAMPLEVNF-139              |  Increase default mbuf size and code simplification/cleanup          |
 223 +----------------------------+----------------------------------------------------------------------+
 224 | SAMPLEVNF-140              |  update from src port in the pvt/pub handler                         |
 225 +----------------------------+----------------------------------------------------------------------+
 226
 227
 228
 229
 230 Bug Fix Jira:
 231
 232 +----------------------------+-------------------------------------------------------------------+
 233 | **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
 234 +----------------------------+-------------------------------------------------------------------+
 235 | SAMPLEVNF-141              |  Fix potential crash with latency accuracy                        |
 236 +----------------------------+-------------------------------------------------------------------+
 237 | SAMPLEVNF-142              |  TempFix: vCGNAPT/vACL ipv4 perf issue                            |
 238 +----------------------------+-------------------------------------------------------------------+
 239 | SAMPLEVNF-143              |  Temp Fix for vFW perf issue                                      |
 240 +----------------------------+-------------------------------------------------------------------+
 241 | SAMPLEVNF-144              |  fix code standard in VNFs/DPPD-PROX/handle_esp.c                 |
 242 +----------------------------+-------------------------------------------------------------------+
 243 | SAMPLEVNF-145              |  Workaround DPDK net/virtio queue setup issue                     |
 244 +----------------------------+-------------------------------------------------------------------+
 245 | SAMPLEVNF-146              |  Fix potential crash when shuffling mbufs                         |
 246 +----------------------------+-------------------------------------------------------------------+
 247
 248 Hunter known restrictions/issues
 249 --------------------------------
 250 +-----------+-----------+----------------------------------------------+
 251 | Installer | Scenario  |  Issue                                       |
 252 +===========+===========+==============================================+
 253 |           |           |                                              |
 254 +-----------+-----------+----------------------------------------------+
 255
 256
 257 Open JIRA tickets
 258 -----------------
 259
 260 +----------------------------+------------------------------------------------+
 261 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 262 |                            |                                                |
 263 +----------------------------+------------------------------------------------+
 264 |                            |                                                |
 265 |                            |                                                |
 266 +----------------------------+------------------------------------------------+
 267
 268
 269 Useful links
 270 ------------
 271
 272  - wiki project page: https://wiki-old.opnfv.org/display/SAM
 273
 274  - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 275
 276  - SampleVNF repo: https://git.opnfv.org/samplevnf/
 277
 278  - SampleVNF IRC chanel: #opnfv-samplevnf