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