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

   1 =============================================================
   2 OPNFV Release Notes for the Colorado 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 Colorado 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 Colorado release of OVSNFV will provide RPMs for DPDK and OVS with DPDK.
  29 Also for the Colorado 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/colorado.1.0                  |
  43 |                                      |                                      |
  44 +--------------------------------------+--------------------------------------+
  45 | **Release designation**              | colorado.1.0                         |
  46 |                                      |                                      |
  47 +--------------------------------------+--------------------------------------+
  48 | **Release date**                     | 2016-09-14                           |
  49 |                                      |                                      |
  50 +--------------------------------------+--------------------------------------+
  51 | **Purpose of the delivery**          | OPNFV Colorado 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 Colorado release.
  61
  62 - Open vSwitch 2.5.90
  63
  64 - DPDK 16.04
  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 Colorado release of OVSNFV
  81 The following documentation is provided with this release:
  82
  83 - OVSNFV Build instructions of the RPMs for the Colorado 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 EXPERIMENTAL artifacts produced by OVS for NFV
 152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 153
 154   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 155   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 156   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 157   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 158   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 159   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 160   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 161   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 162   -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
 163
 164
 165 Documentation deliverables
 166 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 167 - RPM build instructions for the Colorado release version 1.0.0
 168 - OVSNFV Release Notes for the Colorado release version 1.0.0
 169 - Configuration Guide for OVSNFV
 170 - Supported Scenario Description and Documentation
 171
 172 Known Limitations, Issues and Workarounds
 173 =========================================
 174
 175 Known issues
 176 ------------
 177
 178 **JIRA TICKETS:**
 179
 180 +--------------------------------------+--------------------------------------+
 181 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 182 |                                      |                                      |
 183 +--------------------------------------+--------------------------------------+
 184 |                                      |                                      |
 185 |                                      |                                      |
 186 +--------------------------------------+--------------------------------------+
 187
 188 Workarounds
 189 -----------
 190 **-**
 191
 192
 193 Test Result
 194 ===========
 195
 196 The Colorado release of OVS/DPDK RPM deployed with the Apex deployment
 197 toolchain has undergone QA test runs with the following results:
 198
 199 +--------------------------------------+--------------------------------------+
 200 | **TEST-SUITE**                       | **Results:**                         |
 201 |                                      |                                      |
 202 +--------------------------------------+--------------------------------------+
 203 | **-**                                | **-**                                |
 204 +--------------------------------------+--------------------------------------+
 205
 206
 207 References
 208 ==========
 209
 210 For more information on the OPNFV Colorado release, please see:
 211
 212 http://wiki.opnfv.org/releases/Colorado
 213
 214 :Author: Thomas F Herbert (therbert@redhat.com)
 215 :Version: 1.0.0