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

   1 =============================================================
   2 OPNFV Release Notes for the Danube release of OVS for OPNFV
   3 =============================================================
   4
   5
   6 .. contents:: Table of Contents
   7    :backlinks: none
   8
   9
  10 Abstract
  11 ========
  12
  13 This document provides the release notes for Danube release of
  14 OVS for OPNFV.
  15
  16 Version history
  17 ===============
  18
  19
  20 +-------------+-----------+------------------+----------------------+
  21 | **Date**    | **Ver.**  | **Authors**      |    **Comment**       |
  22 |             |           |                  |                      |
  23 +-------------+-----------+------------------+----------------------+
  24
  25 Summary
  26 =======
  27
  28 The Danube release of OVSNFV will provide RPMs for DPDK and OVS with DPDK.
  29 Also for the Danube release an RPM of an interim release of OVS and the
  30 OVS kernel module with NSH patches.
  31
  32 - Documentation is built by Jenkins
  33 - .rpm packages are built by Jenkins
  34
  35 Release Data
  36 ============
  37
  38 +--------------------------------------+--------------------------------------+
  39 | **Project**                          | ovsnfv                               |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42 | **Repo/tag**                         | ovsnfv/Danube.1.0                    |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release designation**              | Danube 1.0                           |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48 | **Release date**                     | 2017-3-31                            |
  49 |                                      |                                      |
  50 +--------------------------------------+--------------------------------------+
  51 | **Purpose of the delivery**          | OPNFV Danube release                 |
  52 |                                      |                                      |
  53 +--------------------------------------+--------------------------------------+
  54
  55 Version change
  56 --------------
  57
  58 Module version changes
  59 ~~~~~~~~~~~~~~~~~~~~~~
  60 This is the first tracked version of OVSNFV for the Danube release.
  61
  62 - Open vSwitch 2.6
  63
  64 - DPDK 16.11
  65
  66 Unsupported Experimental OVS with NSH
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 - **Experimental** Open vSwitch 2.5.90 with NSH
  70 - **Experimental** Open vSwitch 2.5.90 with NSH Kernel Module
  71 - OVS commit7d433ae57ebb90cd68e8fa948a096f619ac4e2d8
  72
  73 For more information see:
  74
  75 - https://github.com/yyang13/ovs_nsh_patches/blob/master/README.md
  76
  77 Document version changes
  78 ~~~~~~~~~~~~~~~~~~~~~~~~
  79
  80 This is the first tracked version of Danube release of OVSNFV
  81 The following documentation is provided with this release:
  82
  83 - OVSNFV Build instructions of the RPMs for the Danube release
  84   ver. 1.0.0
  85
  86 Feature additions
  87 ~~~~~~~~~~~~~~~~~
  88
  89 +--------------------------------------+--------------------------------------+
  90 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 | JIRA: OVSNFV-1                       | Setup OVS/DPDK RPM                   |
  94 |                                      |                                      |
  95 +--------------------------------------+--------------------------------------+
  96 | JIRA: OVSNFV-27                      | A deployment with Apex using         |
  97 |                                      | OVS/DPDK passes all relevant         |
  98 |                                      | functest tests.                      |
  99 +--------------------------------------+--------------------------------------+
 100 | JIRA: OVSNFV-29                      | Apex consume ovsnfv generated RPM    |
 101 |                                      |                                      |
 102 +--------------------------------------+--------------------------------------+
 103
 104 Bug corrections
 105 ~~~~~~~~~~~~~~~
 106
 107 **JIRA TICKETS:**
 108
 109 +--------------------------------------+--------------------------------------+
 110 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 111 |                                      |                                      |
 112 +--------------------------------------+--------------------------------------+
 113 |                                      |                                      |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116
 117 Deliverables
 118 ------------
 119
 120 Software deliverables
 121 ~~~~~~~~~~~~~~~~~~~~~
 122 build.sh - Builds the RPM artifacts
 123
 124 Artifacts produced by OVSNFV
 125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 126 Artifacts consist of RPMs. Artifacts for this release conist of RPMs.
 127 The RPM file names are all prefixed
 128 with ovs4opnfv-e8acab14-
 129 RPMs are uploaded into the OPNFV artifactory in the opnfv artifactory in the
 130 ovsnfv/colorado directory.
 131
 132 - DPDK 16.04
 133
 134   -  ovs4opnfv-e8acab14-dpdk-16.04.0-1.el7.centos.x86_64.rpm
 135   -  ovs4opnfv-e8acab14-dpdk-debuginfo-16.04.0-1.el7.centos.x86_64.rpm
 136   -  ovs4opnfv-e8acab14-dpdk-devel-16.04.0-1.el7.centos.x86_64.rpm
 137   -  ovs4opnfv-e8acab14-dpdk-examples-16.04.0-1.el7.centos.x86_64.rpm
 138   -  ovs4opnfv-e8acab14-dpdk-tools-16.04.0-1.el7.centos.x86_64.rpm
 139
 140 - OVS with DPDK
 141
 142   -  ovs4opnfv-e8acab14-openvswitch-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 143   -  ovs4opnfv-e8acab14-openvswitch-debuginfo-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 144   -  ovs4opnfv-e8acab14-openvswitch-devel-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 145   -  ovs4opnfv-e8acab14-openvswitch-ovn-central-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 146   -  ovs4opnfv-e8acab14-openvswitch-ovn-common-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 147   -  ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 148   -  ovs4opnfv-e8acab14-openvswitch-ovn-host-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 149   -  ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
 150
 151 - DPDK 16.11
 152
 153
 154   - ovsnfv/ovs4opnfv-e8acab14-dpdk-16.11-5.el7.centos.x86_64.rpm
 155   - ovsnfv/ovs4opnfv-e8acab14-dpdk-debuginfo-16.11-5.el7.centos.x86_64.rpm
 156   - ovsnfv/ovs4opnfv-e8acab14-dpdk-devel-16.11-5.el7.centos.x86_64.rpm
 157   - ovsnfv/ovs4opnfv-e8acab14-dpdk-doc-16.11-5.el7.centos.noarch.rpm
 158   - ovsnfv/ovs4opnfv-e8acab14-dpdk-examples-16.11-5.el7.centos.x86_64.rpm
 159   - ovsnfv/ovs4opnfv-e8acab14-dpdk-tools-16.11-5.el7.centos.x86_64.rpm
 160
 161 - OVS 2.6
 162
 163   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-2.6.0-1.el7.centos.x86_64.rpm
 164   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-debuginfo-2.6.0-1.el7.centos.x86_64.rpm
 165   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-devel-2.6.0-1.el7.centos.x86_64.rpm
 166   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-central-2.6.0-1.el7.centos.x86_64.rpm
 167   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-common-2.6.0-1.el7.centos.x86_64.rpm
 168   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.6.0-1.el7.centos.x86_64.rpm
 169   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-host-2.6.0-1.el7.centos.x86_64.rpm
 170   - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.6.0-1.el7.centos.x86_64.rpm
 171
 172 EXPERIMENTAL artifacts produced by OVS for NFV
 173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 174
 175   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 176   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 177   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 178   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 179   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 180   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 181   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 182   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 183   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 184
 185
 186 Documentation deliverables
 187 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 188 - RPM build instructions for the Danube release version 1.0.0
 189 - OVSNFV Release Notes for the Danube release version 1.0.0
 190 - Configuration Guide for OVSNFV
 191 - Supported Scenario Description and Documentation
 192
 193 Known Limitations, Issues and Workarounds
 194 =========================================
 195
 196 Known issues
 197 ------------
 198
 199 **JIRA TICKETS:**
 200
 201 +--------------------------------------+--------------------------------------+
 202 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 203 |                                      |                                      |
 204 +--------------------------------------+--------------------------------------+
 205 |  APEX-415                            |  br-phy dpdk interfaces are not      |
 206 |                                      |  brought up by net-config            |
 207 |                                      |                                      |
 208 +--------------------------------------+--------------------------------------+
 209
 210 Workarounds
 211 -----------
 212 **-**
 213
 214
 215 Test Result
 216 ===========
 217
 218 The DAnube release of OVS/DPDK RPM deployed with the Apex deployment
 219 toolchain has undergone QA test runs with the following results:
 220
 221 +--------------------------------------+--------------------------------------+
 222 | **TEST-SUITE**                       | **Results:**                         |
 223 |                                      |                                      |
 224 +--------------------------------------+--------------------------------------+
 225 | **-**                                | **-**                                |
 226 +--------------------------------------+--------------------------------------+
 227
 228
 229 References
 230 ==========
 231
 232 For more information on the OPNFV Danube release, please see:
 233
 234 http://wiki.opnfv.org/releases/Danube
 235
 236 :Author: Thomas F Herbert (therbert@redhat.com)
 237 :Version: 1.0.0