aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
blob: abad9e3c973cfb13556a84c52ff49ec809be7b64 (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
.. This work is licensed under a Creative Commons Attribution 4.0
   International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) ONAP Project and its contributors
.. _release_notes:

******************
SDNC Release Notes
******************


Abstract
========

This document provides the release notes for the Jakarta release of the Software Defined
Network Controller (SDNC)

Summary
=======

The Jakarta release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
upgrade (to Phosphorus).

The Jakarta release of SDNC also includes substantial improvements in automated test coverage integrated into
the project's CI/CD framework.  In this release, each time a new SDNC is built, a regression suite is run
and the docker is only saved if it passes this regression suite.



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

+-------------------------+-------------------------------------------+
| **Project**             | SDNC                                      |
|                         |                                           |
+-------------------------+-------------------------------------------+
| **Docker images**       | See :ref:`dockercontainers` section below |
+-------------------------+-------------------------------------------+
| **Release designation** | Jakarta                                   |
|                         |                                           |
+-------------------------+-------------------------------------------+


New features
------------

The SDNC Jakarta release includes the following features,  which are inherited from CCSDK:

* Upgrade to OpenDaylight Phosphorus Release (Jira `CCSDK-3451 <https://jira.onap.org/browse/CCSDK-3451>`_)
* A1 Adapter and A1 Policy Management Extensions in Jakarta Release - CCSDK (Jira `CCSDK-3463 <https://jira.onap.org/browse/CCSDK-3463>`_)
* CCSDK impacts for Network slicing in Jakarta Release (Jira `CCSDK-3554 <https://jira.onap.org/browse/CCSDK-3554>`_)


For the complete list of `CCSDK Jakarta release epics <https://jira.onap.org/issues/?filter=12711>`_ and
`CCSDK Jakarta release user stories <https://jira.onap.org/issues/?filter=12800>`_ , please see the `ONAP Jira`_.

**Bug fixes**

The SDNC Jakarta release carries forward a fix from the Istanbul Maintenance Release 1 for a critical vulnerability discovered in log4j by
upgrading to version 2.17.1 of the log4j-core package.  It also removes the 'data-migrator' package, which
was an old Proof of Concept that is no longer maintained and which was using a vulnerable version of log4j.
These changes are described further in Jira `SDNC-1655 <https://jira.onap.org/browse/SDNC-1655>` 

The full list of `bugs fixed in the SDNC Jakarta release <https://jira.onap.org/issues/?filter=12802>`_ is maintained on the `ONAP Jira`_.

**Known Issues**

The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.



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

Software Deliverables
~~~~~~~~~~~~~~~~~~~~~

.. _dockercontainers:

Docker Containers
`````````````````

The following table lists the docker containers comprising the SDNC Jakarta
release along with the current stable Jakarta version/tag.  Each of these is
available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
with the following command::

   docker pull nexus3.onap.org:10001/{image-name}:{version}



+--------------------------------+-----------------------------------------------------+---------+
| Image name                     | Description                                         | Version |
+================================+=====================================================+=========+
| onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.3.0   |
+--------------------------------+-----------------------------------------------------+---------+
| onap/sdnc-ansible-server-image | Ansible server                                      | 2.3.0   |
+--------------------------------+-----------------------------------------------------+---------+
| onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.3.0  |
+--------------------------------+-----------------------------------------------------+---------+
| onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.3.0   |
+--------------------------------+-----------------------------------------------------+---------+
| onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.3.0   |
+--------------------------------+-----------------------------------------------------+---------+
| onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.3.0   |
+--------------------------------+-----------------------------------------------------+---------+


Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~

* `SDN Controller for Radio user guide`_

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

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

No system limitations noted.


Known Vulnerabilities
---------------------

Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
pertain to SDNC are listed in the :ref:`secissues` section below.


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

Not applicable.


Security Notes
--------------


Known Security Issues
~~~~~~~~~~~~~~~~~~~~~

There are no known outstanding security issues related to SDNC Jakarta.


Test Results
============
Not applicable


References
==========

For more information on the ONAP Jakarta release, please see:

#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_


.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org
.. _`ONAP Jira`: https://jira.onap.org
.. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html