summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/releasenotes.rst
blob: d57b743f26b72cc33b6efc9fb6a419639e154b08 (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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Manuel Buil (SuSe Linux) and others

Abstract
========

This document compiles the release notes for the Fraser release of
OPNFV SFC

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

These notes provide release information for the use of SFC with the
Apex installer, xci tool and Compass4NFV for the Fraser release of OPNFV.

Summary
=======

The goal of the SFC Fraser release is to integrate the OpenDaylight
SFC project into an OPNFV environment, with either the Apex installer,
xci tools or Compass4NFV.

More information about OpenDaylight and SFC can be found here.

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

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


- Documentation built by Jenkins

  - Overall OPNFV documentation

  - `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_

  - `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_

  - `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_

  - Release Notes (this document)


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

+--------------------------------------+--------------------------------------+
| **Project**                          | sfc                                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | opnfv-6.1.0                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Fraser 6.1                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     |  25th May 2018                       |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Move to OpenStack Pike and ODL Oxygen|
|                                      | Support symmetric testcases          |
|                                      | Support master branch of OpenStack   |
+--------------------------------------+--------------------------------------+

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

Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This release of OPNFV sfc is based on following upstream versions:

- OpenStack Pike release

- OpenDaylight Oxygen SR1 release

- Open vSwitch 2.6.1 with Yi Yang NSH patch

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

- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_

- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_

- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_

- Release notes (This document)

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

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

- `Using SNAPS as base for our tests`
- `Increase test coverage with two extra test cases: symmetric and deletion`
- `Reduced the footprint of the image we use for testing to reduce testing time`

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

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

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

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

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

- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_

- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_

- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_

- Release notes (This document)

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

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

The Fraser 1.0 release has a few limitations:

1 - The testcase sfc_two_chains_SSH_and_HTTP is disabled in this release due to
a missing feature in ODL. We are unable to currently update a chain config

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

1 - When tacker is deployed without Mistral, there is an ERROR in the logs and
the VIM is always in 'PENDING' state because tacker cannot monitor its health.
However, everything works and SFs can be created.

2 - When tacker is deployed without barbican, it cannot be in HA mode because
barbican is the only way to fetch the fernet keys.

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

Test results
============
The Fraser release of SFC has undergone QA test runs with Functest tests on the
Apex and Compass installers and xci utility

References
==========
For more information on the OPNFV Fraser 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 Fraser release <http://wiki.opnfv.org/releases/fraser>`_

OpenStack
---------

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

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