9bf9cae52d2a952c3d27a55db2030b15ac64ad39
[sdnc/oam.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Release Notes
4 =============
5
6 Version 1.7.3
7 -------------
8 :Release Date: 2019-09-30
9
10 El Alto release
11
12 **Artifact Versions**
13
14
15 The following table lists the SDNC docker containers and their versions.
16
17 +--------------------------------+---------------------------------------------+-----------+
18 | Image name                     |  Description                                | Version(s)|
19 +================================+=============================================+===========+
20 | onap/network-discovery         | POMBA : network discovery microservice      | 1.7.3     |
21 +--------------------------------+---------------------------------------------+-----------+
22 | onap/service-decomposition     | POMBA : service decomposition microservice  | 1.7.3     |
23 +--------------------------------+---------------------------------------------+-----------+
24 | onap/sdnc-ansible-server-image | Ansible server                              | 1.7.3     |
25 +--------------------------------+---------------------------------------------+-----------+
26 | onap/sdnc-aaf-image            | SDNC controller image, with AAF integration | 1.7.3     |
27 +--------------------------------+---------------------------------------------+-----------+
28 | onap/sdnc-image                | SDNC controller image, standalone (no AAF)  | 1.7.3     |
29 +--------------------------------+---------------------------------------------+-----------+
30 | onap/sdnc-ueb-listener-image   | SDC listener                                | 1.7.3     |
31 +--------------------------------+---------------------------------------------+-----------+
32 | onap/sdcn-dmaap-listener-image | DMAAP listener                              | 1.7.3     |
33 +--------------------------------+---------------------------------------------+-----------+
34
35
36 **New Features**
37
38 The full list of El Alto epics and user stories for SDNC may be found at <https://jira.onap.org/issues/?filter=12044>.
39
40 The following list summarizes some of the most significant epics:
41
42 +------------+-------------------------------------------------------------------------------------+
43 | Jira #     | Abstract                                                                            |
44 +============+=====================================================================================+
45 | [SDNC-825] | OpenDaylight Neon upgrade                                                           |
46 +------------+-------------------------------------------------------------------------------------+
47 | [SDNC-858] | Tune OpenDaylight Java settings for NETCONF                                         |
48 +------------+-------------------------------------------------------------------------------------+
49 | [SDNC-822] | Add aggregate-route-policy in GR-API and async changes                              |
50 +------------+-------------------------------------------------------------------------------------+
51 | [SDNC-431] | Implement config DB and REST API                                                    |
52 +------------+-------------------------------------------------------------------------------------+
53 | [SDNC-433] | Receive netconf notification from RAN, update config DB and publish change on DMAAP |
54 +------------+-------------------------------------------------------------------------------------+
55
56
57
58 **Bug Fixes**
59 The full list of bug fixes in the SDNC El Alto release may be found at <https://jira.onap.org/issues/?filter=12045>
60
61 **Known Issues**
62 The full list of known issues in SDNC may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
63
64 One item of note is that the SDNC admin portal was determined to have a number of security vulnerabilities,
65 under Known Security Issues.  As a temporary remediation, the admin portal was disabled in
66 Dublin.  These issues have been resolved in El Alto.
67
68 **Security Notes**
69
70 *Fixed Security Issues*
71
72 - CVE-2019-12132 `OJSI-41 <https://jira.onap.org/browse/OJSI-41>`_ SDNC service allows for arbitrary code execution in sla/dgUpload form
73 - CVE-2019-12123 `OJSI-42 <https://jira.onap.org/browse/OJSI-42>`_ SDNC service allows for arbitrary code execution in sla/printAsXml form
74 - CVE-2019-12113 `OJSI-43 <https://jira.onap.org/browse/OJSI-43>`_ SDNC service allows for arbitrary code execution in sla/printAsGv form
75 - `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ SDNC exposes unprotected API for user creation
76 - `OJSI-98 <https://jira.onap.org/browse/OJSI-98>`_ In default deployment SDNC (sdnc-portal) exposes HTTP port 30201 outside of cluster.
77 - CVE-2019-12112 `OJSI-199 <https://jira.onap.org/browse/OJSI-199>`_ SDNC service allows for arbitrary code execution in sla/upload form
78 - `OJSI-34 <https://jira.onap.org/browse/OJSI-34>`_ Multiple SQL Injection issues in SDNC
79 - `OJSI-99 <https://jira.onap.org/browse/OJSI-99>`_ In default deployment SDNC (sdnc) exposes HTTP port 30202 outside of cluster.
80 - `OJSI-100 <https://jira.onap.org/browse/OJSI-100>`_ In default deployment SDNC (sdnc-dgbuilder) exposes HTTP port 30203 outside of cluster.
81 - `OJSI-179 <https://jira.onap.org/browse/OJSI-179>`_ dev-sdnc-sdnc exposes JDWP on port 1830 which allows for arbitrary code execution
82 - `OJSI-183 <https://jira.onap.org/browse/OJSI-183>`_ SDNC exposes ssh service on port 30208
83
84 *Known Security Issues*
85
86
87
88 *Known Vulnerabilities in Used Modules*
89
90 Quick Links:
91
92 - `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
93 - `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
94 - `Project Vulnerability Review Table for Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_
95
96
97 Version 1.5.4
98 -------------
99 :Release Date: 2019-06-13
100
101
102 **New Features**
103
104 The full list of Dublin epics and user stories for SDNC maybe be found at <https://jira.onap.org/issues/?filter=11803>.
105
106 The following list summarizes some of the most significant epics:
107
108 +------------+----------------------------------------------------------------------------+
109 | Jira #     | Abstract                                                                   |
110 +============+============================================================================+
111 | [SDNC-551] | OpenDaylight Fluorine Support                                              |
112 +------------+----------------------------------------------------------------------------+
113 | [SDNC-564] | 5G Use Case                                                                |
114 +------------+----------------------------------------------------------------------------+
115 | [SDNC-565] | CCVPN Use Case Extension                                                   |
116 +------------+----------------------------------------------------------------------------+
117 | [SDNC-570] | SDN-R: Server side component                                               |
118 +------------+----------------------------------------------------------------------------+
119 | [SDNC-579] | SDN-R : UX-Client                                                          |
120 +------------+----------------------------------------------------------------------------+
121 | [SDNC-631] | SDNC support for the PNF Use Case Network Assign for Plug and Play feature |
122 +------------+----------------------------------------------------------------------------+
123
124
125 **Bug Fixes**
126 The full list of bug fixes in the SDNC Dublin release may be found at <https://jira.onap.org/issues/?filter=11805>
127
128 **Known Issues**
129 The full list of known issues in SDNC may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
130
131 One item of note is that the SDNC admin portal was determined to have a number of security vulnerabilities,
132 under Known Security Issues.  As a temporary remediation, the admin portal is disabled in
133 Dublin.  It will be re-enabled in El Alto once the security issues are addressed.
134
135 **Security Notes**
136
137 *Fixed Security Issues*
138
139 - CVE-2019-12132 `OJSI-41 <https://jira.onap.org/browse/OJSI-41>`_ SDNC service allows for arbitrary code execution in sla/dgUpload form
140   Fixed temporarily by disabling admportal
141 - CVE-2019-12123 `OJSI-42 <https://jira.onap.org/browse/OJSI-42>`_ SDNC service allows for arbitrary code execution in sla/printAsXml form
142   Fixed temporarily by disabling admportal
143 - CVE-2019-12113 `OJSI-43 <https://jira.onap.org/browse/OJSI-43>`_ SDNC service allows for arbitrary code execution in sla/printAsGv form
144   Fixed temporarily by disabling admportal
145 - `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ SDNC exposes unprotected API for user creation
146   Fixed temporarily by disabling admportal
147 - `OJSI-98 <https://jira.onap.org/browse/OJSI-98>`_ In default deployment SDNC (sdnc-portal) exposes HTTP port 30201 outside of cluster.
148   Fixed temporarily by disabling admportal
149 - CVE-2019-12112 `OJSI-199 <https://jira.onap.org/browse/OJSI-199>`_ SDNC service allows for arbitrary code execution in sla/upload form
150   Fixed temporarily by disabling admportal
151
152 *Known Security Issues*
153
154 - `OJSI-34 <https://jira.onap.org/browse/OJSI-34>`_ Multiple SQL Injection issues in SDNC
155 - `OJSI-99 <https://jira.onap.org/browse/OJSI-99>`_ In default deployment SDNC (sdnc) exposes HTTP port 30202 outside of cluster.
156 - `OJSI-100 <https://jira.onap.org/browse/OJSI-100>`_ In default deployment SDNC (sdnc-dgbuilder) exposes HTTP port 30203 outside of cluster.
157 - `OJSI-179 <https://jira.onap.org/browse/OJSI-179>`_ dev-sdnc-sdnc exposes JDWP on port 1830 which allows for arbitrary code execution
158 - `OJSI-183 <https://jira.onap.org/browse/OJSI-183>`_ SDNC exposes ssh service on port 30208
159
160 *Known Vulnerabilities in Used Modules*
161
162 Quick Links:
163
164 - `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
165 - `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
166 - `Project Vulnerability Review Table for Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_
167
168 Version: 1.4.4
169 --------------
170
171 **Bugs Fixes**
172
173 The following bugs are fixed in the SDNC Casablanca January 2019 maintenance release:
174
175 +------------+------------------------------------------------------------------------------------------+
176 | Jira #     | Abstract                                                                                 |
177 +============+==========================================================================================+
178 | [SDNC-405] | SDNC API documentation is missing on ReadTheDocs                                         |
179 +------------+------------------------------------------------------------------------------------------+
180 | [SDNC-523] | vnf-information.vnf-id validation check should not be mandatory in validate-vnf-input DG |
181 +------------+------------------------------------------------------------------------------------------+
182 | [SDNC-532] | oof query failed due to hostname change, returning unknown host                          |
183 +------------+------------------------------------------------------------------------------------------+
184 | [SDNC-534] | wrong "input" field in DMaaP message template                                            |
185 +------------+------------------------------------------------------------------------------------------+
186 | [SDNC-536] | Upgrade zjsonpatch version to remediate vulnerabilities                                  |
187 +------------+------------------------------------------------------------------------------------------+
188 | [SDNC-537] | Update to spring-boot 2.1.0-RELEASE                                                      |
189 +------------+------------------------------------------------------------------------------------------+
190 | [SDNC-540] | CCVPN closed loop testing failed.                                                        |
191 +------------+------------------------------------------------------------------------------------------+
192 | [SDNC-542] | [PORT] Network Discovery microservice does not log                                       |
193 +------------+------------------------------------------------------------------------------------------+
194 | [SDNC-546] | CCVPN bugs fix for manual free integration test                                          |
195 +------------+------------------------------------------------------------------------------------------+
196 | [SDNC-549] | Retain MD-SAL data on pod recreate                                                       |
197 +------------+------------------------------------------------------------------------------------------+
198
199
200
201 Version: 1.4.3
202 --------------
203
204
205 :Release Date: 2018-11-30
206
207 **New Features**
208
209 The Casablanca release of SDNC introduces the following new features:
210
211         - Network Discovery, in support of POMBA
212         - Support for CCVPN use case
213         - Change Management enhancements
214
215 **Bug Fixes**
216
217 The list of bugs fixed in the SDNC Casablanca release may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11544>
218
219
220 **Known Issues**
221
222 The list of known issues in the SDNC project may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
223
224
225 **Security Notes**
226
227 SDNC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SDNC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_.
228
229 Quick Links:
230
231 - `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
232 - `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
233 - `Project Vulnerability Review Table for Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_
234
235 **Upgrade Notes**
236    NA
237
238 **Deprecation Notes**
239    NA
240
241 **Other**
242    NA
243
244 Version: 1.3.4
245 --------------
246
247
248 :Release Date: 2018-07-06
249
250 **New Features**
251
252 The full list of SDNC Beijing Epics and user stories can be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=10791>.  The
253 following table lists the major features included in the Beijing release.
254
255 +------------+-------------------------------------------------------------------------------------------------------------+
256 | Jira #     | Abstract                                                                                                    |
257 +============+=============================================================================================================+
258 | [SDNC-278] | Change management in-place software upgrade execution using Ansible <https://jira.onap.org/browse/SDNC-278> |
259 +------------+-------------------------------------------------------------------------------------------------------------+
260 | [SDNC-163] | Deploy a SDN-C high availability environment - Kubernetes <https://jira.onap.org/browse/SDNC-163>           |
261 +------------+-------------------------------------------------------------------------------------------------------------+
262
263
264 **Bug Fixes**
265
266 The list of bugs fixed in the SDNC Beijing release may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11118>
267
268
269 **Known Issues**
270
271 +------------+----------------------------------------------------------------------------------------------------------------------------------+
272 | Jira #     | Abstract                                                                                                                         |
273 +============+==================================================================================================================================+
274 | [SDNC-324] | IPV4_ADDRESS_POOL is empty <https://jira.onap.org/browse/SDNC-324>                                                               |
275 +------------+----------------------------------------------------------------------------------------------------------------------------------+
276 | [SDNC-321] | dgbuilder won't save DG <https://jira.onap.org/browse/SDNC-321>                                                                  |
277 +------------+----------------------------------------------------------------------------------------------------------------------------------+
278 | [SDNC-304] | SDNC OOM intermittent Healthcheck failure - JSONDecodeError - on different startup order <https://jira.onap.org/browse/SDNC-304> |
279 +------------+----------------------------------------------------------------------------------------------------------------------------------+
280 | [SDNC-115] | VNFAPI DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-115>                        |
281 +------------+----------------------------------------------------------------------------------------------------------------------------------+
282 | [SDNC-114] | Generic API DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-114>                   |
283 +------------+----------------------------------------------------------------------------------------------------------------------------------+
284 | [SDNC-106] | VNFAPI DGs contain old openecomp and com.att based plugin references <https://jira.onap.org/browse/SDNC-106>                     |
285 +------------+----------------------------------------------------------------------------------------------------------------------------------+
286 | [SDNC-64]  | SDNC is not setting FromApp identifier in logging MDC <https://jira.onap.org/browse/SDNC-64>                                     |
287 +------------+----------------------------------------------------------------------------------------------------------------------------------+
288
289
290 **Security Notes**
291
292 SDNC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SDNC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_.
293
294 Quick Links:
295
296 - `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
297 - `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
298 - `Project Vulnerability Review Table for SDNC <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_
299
300 **Upgrade Notes**
301         NA
302
303 **Deprecation Notes**
304         NA
305
306 **Other**
307         NA
308
309 Version: 1.2.1
310 --------------
311
312 :Release Date: 2018-01-18
313
314 **Bug Fixes**
315
316 - `SDNC-145 <https://jira.onap.org/browse/SDNC-145>`_ Error message refers to wrong parameters
317 - `SDNC-195 <https://jira.onap.org/browse/SDNC-195>`_ UEB listener doesn't insert correct parameters for allotted resources in DB table ALLOTTED_RESOURCE_MODEL
318 - `SDNC-198 <https://jira.onap.org/browse/SDNC-198>`_ CSIT job fails
319 - `SDNC-201 <https://jira.onap.org/browse/SDNC-201>`_ Fix DG bugs from integration tests
320 - `SDNC-202 <https://jira.onap.org/browse/SDNC-202>`_ Search for service -data null match, set vGW LAN IP via Heat
321 - `SDNC-211 <https://jira.onap.org/browse/SDNC-211>`_ Update SDNC Amsterdam branch to use maintenance release versions
322 - `SDNC-212 <https://jira.onap.org/browse/SDNC-212>`_ Duplicate file name
323
324 Version: 1.2.0
325 --------------
326
327 :Release Date: 2017-11-16
328
329 **New Features**
330
331 The ONAP Amsterdam release introduces the following changes to SDNC from
332 the original openECOMP seed code:
333    - Refactored / moved common platform code to new CCSDK project
334    - Refactored code to rename openecomp to onap
335    - Introduced new GENERIC-RESOURCE-API api, used by vCPE and VoLTE use cases
336    - Introduced new docker containers for SDC and DMAAP interfaces
337
338 **Bug Fixes**
339         NA
340 **Known Issues**
341 The following known high priority issues are being worked and are expected to be delivered
342 in release 1.2.1:
343 - `SDNC-179 <https://jira.onap.org/browse/SDNC-179>`_ Failed to make HTTPS connection in restapicall node
344 - `SDNC-181 <https://jira.onap.org/browse/SDNC-181>`_ Change call to brg-wan-ip-address vbrg-wan-ip brg topo activate DG
345 - `SDNC-182 <https://jira.onap.org/browse/SDNC-182>`_ Fix VNI Consistency: Add vG vxlan tunnel setup and bridge domain setup to brg-topo-activate DG
346
347 **Security Issues**
348         NA
349
350 **Upgrade Notes**
351         NA
352
353 **Deprecation Notes**
354         NA
355
356 **Other**
357         NA