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