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