summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
blob: 492db684a7d238c9f1d56c158f1abd6bff992d76 (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
===========================================================
OPNFV Release Note for the Brahmaputra release of OPNFV SFC
===========================================================

License
=======

This work is licensed under a Creative Commons Attribution 4.0 International
License. .. http://creativecommons.org/licenses/by/4.0 ..
(c) Brady Johnson (Ericsson Inc.) and others

Abstract
========

This document compiles the release notes for the Brahmaputra release of
OPNFV SFC.

Important notes
===============

These notes provide release information for the use of SFC with the Fuel
and Apex installer tools for the Brahmaputra release of OPNFV.

Summary
=======

The goal of the SFC Brahmaputra release is to integrate the OpenDaylight
SFC project into an OPNFV environment, with either the Fuel or Apex
installer. In subsequent releases, other OPNFV installers will be
considered.

More information about OpenDaylight and SFC can be found here.

- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium"

- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_


- Documentation built by Jenkins

  - overall OPNFV documentation

  - Design document

  - this document (release notes)


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

+--------------------------------------+--------------------------------------+
| **Project**                          | sfc                                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | brahmaputra.1.0                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Brahmaputra base release             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | February 25 2016                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Brahmaputra base release             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

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

Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This is the first tracked release of OPNFV sfc. It is based on
following upstream versions:

- OpenStack Liberty release

- OpenDaylight Beryllium release

- Open vSwitch

Document changes
~~~~~~~~~~~~~~~~
This is the first tracked version of OPNFV SFC. It comes with
the following documentation:

- Design document

- Release notes (This document)

Reason for version
------------------

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

**JIRA TICKETS:**

`New features <https://jira.opnfv.org/issues/?filter=11002>`_ 'https://jira.opnfv.org/issues/?filter=11002'

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

**JIRA TICKETS:**

`Bug-fixes <https://jira.opnfv.org/browse/FUEL-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001'

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

Software deliverables
~~~~~~~~~~~~~~~~~~~~~

No specific deliverables are created, as SFC is included with Apex and Fuel.

Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~

- Design document

- Release notes (This document)

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

OpenDaylight SFC relies on a version of Open vSwitch (OVS) with
Network Service Headers (NSH). A version of OVS with NSH currently
exists, but it is in a private branch. Extensive upstream work has
been done to merge the NSH patches into mainstream OVS, but the work
is still not complete. More information about this can be found in
the OPNFV SFC design document.

System Limitations
------------------

No limitations beyond those in Fuel and Apex have been identified.

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

**JIRA TICKETS:**

`Known issues <https://jira.opnfv.org/browse/SFC-27>`_ 'https://jira.opnfv.org/browse/SFC-27'

Workarounds
-----------



Test results
============
The Brahmaputra release of SFC has only undergone QA test runs with
the Fuel installer and basic Yardstick tests, nothing SFC specific.

References
==========
For more information on the OPNFV Brahmaputra release, please see:

OPNFV
-----

1) `OPNFV Home Page <www.opnfv.org>`_

2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_

3) `OPNFV Brahmaputra release <http://wiki.opnfv.org/releases/brahmaputra>`_

OpenStack
---------

4) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_

5) `OpenStack documentation <http://docs.openstack.org>`_

OpenDaylight
------------

6) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_


:Authors: Brady Johnson (brady.allen.johnson@ericsson.com)
:Version: 1.0.0