summaryrefslogtreecommitdiffstats
path: root/docs/release-notes/release-notes.rst
blob: 683ce0623b1d223eb3555394980784830f34314e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
=============================================================
OPNFV Release Notes for the Colorado release of OVS for OPNFV
=============================================================


.. contents:: Table of Contents
   :backlinks: none


Abstract
========

This document provides the release notes for Colorado release of
OVS for OPNFV.

Version history
===============


+-------------+-----------+------------------+----------------------+
| **Date**    | **Ver.**  | **Authors**      |    **Comment**       |
|             |           |                  |                      |
+-------------+-----------+------------------+----------------------+

Summary
=======

The Colorado release of OVSNFV will provide RPMs for DPDK and OVS with DPDK.
Also for the Colorado release an RPM of an interim release of OVS and the
OVS kernel module with NSH patches.

- Documentation is built by Jenkins
- .rpm packages are built by Jenkins

Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | ovsnfv                               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | ovsnfv/colorado.1.0                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | colorado.1.0                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2016-09-14                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Colorado release               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
--------------

Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This is the first tracked version of OVSNFV for the Colorado release.

- Open vSwitch 2.5.90

- DPDK 16.04

Unsupported Experimental OVS with NSH
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Experimental** Open vSwitch 2.5.90 with NSH
- **Experimental** Open vSwitch 2.5.90 with NSH Kernel Module
- OVS commit7d433ae57ebb90cd68e8fa948a096f619ac4e2d8

For more information see:

- https://github.com/yyang13/ovs_nsh_patches/blob/master/README.md

Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~

This is the first tracked version of Colorado release of OVSNFV
The following documentation is provided with this release:

- OVSNFV Build instructions of the RPMs for the Colorado release
  ver. 1.0.0

Feature additions
~~~~~~~~~~~~~~~~~

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: OVSNFV-1                       | Setup OVS/DPDK RPM                   |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: OVSNFV-27                      | A deployment with Apex using         |
|                                      | OVS/DPDK passes all relevant         |
|                                      | functest tests.                      |
+--------------------------------------+--------------------------------------+
| JIRA: OVSNFV-29                      | Apex consume ovsnfv generated RPM    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Bug corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Deliverables
------------

Software deliverables
~~~~~~~~~~~~~~~~~~~~~
build.sh - Builds the RPM artifacts

Artifacts produced by OVSNFV
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Artifacts consist of RPMs. Artifacts for this release conist of RPMs.
The RPM file names are all prefixed
with ovs4opnfv-e8acab14-
RPMs are uploaded into the OPNFV artifactory in the opnfv artifactory in the
ovsnfv/colorado directory.

- DPDK 16.04

  -  ovs4opnfv-e8acab14-dpdk-16.04.0-1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-dpdk-debuginfo-16.04.0-1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-dpdk-devel-16.04.0-1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-dpdk-examples-16.04.0-1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-dpdk-tools-16.04.0-1.el7.centos.x86_64.rpm

- OVS with DPDK

  -  ovs4opnfv-e8acab14-openvswitch-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-debuginfo-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-devel-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-ovn-central-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-ovn-common-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-ovn-host-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm

EXPERIMENTAL artifacts produced by OVS for NFV
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
  -  ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm


Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
- RPM build instructions for the Colorado release version 1.0.0
- OVSNFV Release Notes for the Colorado release version 1.0.0
- Configuration Guide for OVSNFV
- Supported Scenario Description and Documentation

Known Limitations, Issues and Workarounds
=========================================

Known issues
------------

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Workarounds
-----------
**-**


Test Result
===========

The Colorado release of OVS/DPDK RPM deployed with the Apex deployment
toolchain has undergone QA test runs with the following results:

+--------------------------------------+--------------------------------------+
| **TEST-SUITE**                       | **Results:**                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **-**                                | **-**                                |
+--------------------------------------+--------------------------------------+


References
==========

For more information on the OPNFV Colorado release, please see:

http://wiki.opnfv.org/releases/Colorado

:Author: Thomas F Herbert (therbert@redhat.com)
:Version: 1.0.0