aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/releasenotes.rst
blob: f73e6672b4646640a7604d59100987c871a776c2 (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
.. 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 Danube 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 Danube release of OPNFV.

Summary
=======

The goal of the SFC Danube 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 "Boron SR2"

- `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_


- Documentation built by Jenkins

  - Overall OPNFV documentation

  - `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_

  - `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_

  - `Installation Instructions <http://artifacts.opnfv.org/sfc/danube/docs/installationprocedure/index.html>`_

  - Release Notes (this document)


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

+--------------------------------------+--------------------------------------+
| **Project**                          | sfc                                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | danube 1.0                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube base release                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | March 31 2017                        |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Add two new test cases and improve   |
|                                      | the old test case by using the new   |
|                                      | functions coming in functest         |
+--------------------------------------+--------------------------------------+

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

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

- OpenStack Newton release

- OpenDaylight Boron SR2 release

- Open vSwitch 2.6.1 with Yi Yang NSH patch

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

- `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_

- `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_

- `Installation Instructions <http://artifacts.opnfv.org/sfc/danube/docs/installationprocedure/index.html>`_

- Release notes (This document)

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

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

- `Added two new test cases to the scenarios`
- `Added a topology shuffler to the three test cases`
- `Improved readability and modularity of test case`
- `Integration with the new functest`

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

**JIRA TICKETS:**

`Bug-fixes <https://jira.opnfv.org/browse/SFC-67>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-74>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-79>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-79>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-85>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-87>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-88>`_
`Bug-fixes <https://jira.opnfv.org/browse/SFC-89>`_

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

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

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

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

- `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_

- `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_

- `Installation Instructions <http://artifacts.opnfv.org/sfc/danube/docs/installationprocedure/index.html>`_

- Release notes (This document)

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

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

The Danube 1.0 release has one limitation:

1 - The symmetric test case only works when client, server and
SFs are running in the same compute host. This is due to a missing
functionality in Tacker

JIRA: https://jira.opnfv.org/browse/SFC-86

2 - The test cases don't work in topologies where the client is not collocated
with a SF in one compute. The reason is that ODL Boron only creates a
classification rule in the computes with SFs. Therefore, the traffic from the
client goes to the server as it would be done without SFC (SFC classifier is
implemented only in the other compute). Having the SFs collocated with the
server and the client alone in other server does not work either because the
classification only classify traffic from local taps.


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

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 branched version of OVS. 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 (link provided above).

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

The way OpenStack handles VXLAN-GPE tunnels doesnt work well with
SFC, since OpenStack terminates the VXLAN tunnels in the br-int
bridge instead of the SF VM. Ideally, the tunnel should be terminated
in the VM so the SF has access to the NSH header carried in the tunnel.
A workaround was created to send the packets to the SF VM with the
VXLAN-GPE headers intact and can be found in the OPNFV SFC design
document (link provided above).

Test results
============
The Danube release of SFC has undergone QA test runs
with Functest tests on the Fuel and Apex installers.

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

OPNFV
-----

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

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

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

OpenStack
---------

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

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

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

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

Open vSwitch with NSH
---------------------

7) https://github.com/yyang13/ovs_nsh_patches