6aade9ba990be325106f0589d70dddcb30c98de4
[ccsdk/distribution.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 0.5.4 / 0.6.3
8 *********************
9 :Release Date: 2019-09-30
10
11 El Alto release
12
13 **Artifact Versions**
14
15 The CCSDK El Alto release includes artifacts for both OpenDaylight Fluorine SR2 (version 0.5.4) and
16 OpenDaylight Neon SR1 (version 0.6.3).
17
18 Note: CCSDK support for Ubuntu-based OpenDaylight containers is deprecated.  Ubuntu-based containers are provided
19 for ODL Fluorine, but not for Neon.
20
21 The following table lists the CCSDK docker containers and their versions.
22
23 +--------------------------------------+---------------------------------------------------+----------------------+
24 | Image name                           |  Description                                      | Version(s)           |
25 +======================================+===================================================+======================+
26 | onap/ccsdk-alpine-image              | Base Alpine Linux image for CCSDK                 | 0.5.4 (ODL Fluorine) |
27 |                                      |                                                   | 0.6.3 (ODL Neon)     |
28 +--------------------------------------+---------------------------------------------------+----------------------+
29 | onap/ccsdk-ansible-server-image      | Ansible server image                              | 0.5.4 (ODL Fluorine) |
30 |                                      |                                                   | 0.6.3 (ODL Neon)     |
31 +--------------------------------------+---------------------------------------------------+----------------------+
32 | onap/ccsdk-apps-ms-neng              | Naming microservice                               | 0.6.3                |
33 +--------------------------------------+---------------------------------------------------+----------------------+
34 | onap/ccsdk-blueprints-processor      | CDS blueprint processor                           | 0.6.3                |
35 +--------------------------------------+---------------------------------------------------+----------------------+
36 | onap/ccsdk-cds-ui                    | CDS web interface                                 | 0.6.3                |
37 +--------------------------------------+---------------------------------------------------+----------------------+
38 | onap/ccsdk-cds-ui-server             | CDS user interface back end                       | 0.6.3                |
39 +--------------------------------------+---------------------------------------------------+----------------------+
40 | onap/ccsdk-commandexecutor           | CDS command executor                              | 0.6.3                |
41 +--------------------------------------+---------------------------------------------------+----------------------+
42 | onap/ccsdk-controllerblueprint       | CDS controller blueprints                         | 0.6.3                |
43 +--------------------------------------+---------------------------------------------------+----------------------+
44 | onap/ccsdk-dgbuilder-image           | Directed graph builder                            | 0.5.4 (ODL Fluorine) |
45 |                                      |                                                   | 0.6.3 (ODL Neon)     |
46 +--------------------------------------+---------------------------------------------------+----------------------+
47 | onap/ccsdk-odl-fluorine-alpine-image | Alpine based OpenDaylight Fluorine SR2 image      | 0.5.4                |
48 +--------------------------------------+---------------------------------------------------+----------------------+
49 | onap/ccsdk-odl-fluorine-ubuntu-image | Ubuntu based OpenDaylight Fluorine SR2 image      | 0.5.4                |
50 +--------------------------------------+---------------------------------------------------+----------------------+
51 | onap/ccsdk-odl-neon-alpine-image     | Alpine based OpenDaylight Neon SR1 image          | 0.6.3                |
52 +--------------------------------------+---------------------------------------------------+----------------------+
53 | onap/ccsdk-odlsli-alpine-image       | Alpine based OpenDaylight image with CCSDK        | 0.5.4 (ODL Fluorine) |
54 |                                      | libraries installed                               | 0.6.3 (ODL Neon)     |
55 +--------------------------------------+---------------------------------------------------+----------------------+
56 | onap/ccsdk-odlsli-image              | Ubuntu based OpenDaylight image with CCSDK        | 0.5.4 (ODL Fluorine) |
57 |                                      | libraries installed. DEPRECATED (see note above)  |                      |
58 +--------------------------------------+---------------------------------------------------+----------------------+
59 | onap/ccsdk-saltstack-server-image    | Saltstack server                                  | 0.5.4 (ODL Fluorine) |
60 |                                      |                                                   | 0.6.3 (ODL Neon)     |
61 +--------------------------------------+---------------------------------------------------+----------------------+
62 | onap/ccsdk-sdclistener               | CDS SDC listener                                  | 0.6.4                |
63 +--------------------------------------+---------------------------------------------------+----------------------+
64 | onap/ccsdk-ubuntu-image              | Base Ubuntu image for CCSDK                       | 0.5.4                |
65 |                                      |                                                   | 0.6.3                |
66 +--------------------------------------+---------------------------------------------------+----------------------+
67
68 **New Features**
69
70 There are no new use cases or functional requirements in the El Alto release.  The focus of this release is on bug
71 fixes, with a particular emphasis fon security fixes.  However, there are new non-functional user stories that were
72 in El Alto.
73
74 The full list of CCSDK user stories for El Alto may be found at <https://jira.onap.org/issues/?filter=12041>.
75
76 The following table lists some of the most significant user stories:
77
78 +--------------+----------------------------------------------------+
79 | Jira #       | Abstract                                           |
80 +==============+====================================================+
81 | CCSDK-1387   | Upgrade to OpenDaylight Neon SR1                   |
82 +--------------+----------------------------------------------------+
83 | CCSDK-1033   | Support for NETCONF Notifications in CCSDK/SDNC    |
84 +--------------+----------------------------------------------------+
85
86
87 **Bug Fixes**
88 The full list of bug fixes in the El Alto release may be found at <https://jira.onap.org/issues/?filter=12018>
89
90 The following table summarizes some of the most significant issues addressed:
91
92 +--------------+----------------------------------------------------+
93 | Jira #       | Abstract                                           |
94 +==============+====================================================+
95 | [CCSDK-1445] | loading jdbc driver Exception in ccsdk             |
96 +--------------+----------------------------------------------------+
97 | [CCSDK-1443] | cds blueprint processor does not start             |
98 +--------------+----------------------------------------------------+
99 | [CCSDK-1240] | CVE-20190-3795 : spring-data-core vulnerability    |
100 +--------------+----------------------------------------------------+
101 | [CCSDK-1239] | CVE-2019-3797 : spring-data vulnerability          |
102 +--------------+----------------------------------------------------+
103 | [CCSDK-1238] | Multiple CVEs - commons-compress                   |
104 +--------------+----------------------------------------------------+
105 | [CCSDK-1117] | Remove runtime internet dependency for dgbuilder   |
106 +--------------+----------------------------------------------------+
107 | [CCSDK-991]  | Upgrade to spring-core 2.8.6 or higher             |
108 +--------------+----------------------------------------------------+
109 | [CCSDK-988]  | Multiple CVEs - spring-expression < 4.3.17.RELEASE |
110 +--------------+----------------------------------------------------+
111 | [CCSDK-441]  | Spring 3 vulnerability CVE-2018-1270               |
112 +--------------+----------------------------------------------------+
113
114 **Known Issues**
115
116 The full list of known issues in CCSDK may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11341>
117
118 **Security Notes**
119
120 *Fixed Security Issues*
121
122         * In default deployment CCSDK (cds-ui) exposes HTTP port 30497 outside of cluster. [`OJSI-196 <https://jira.onap.org/browse/OJSI-196>`_]
123
124 *Known Security Issues*
125
126         * In default deployment CCSDK (netbox-nginx) exposes HTTP port 30420 outside of cluster. [`OJSI-160 <https://jira.onap.org/browse/OJSI-160>`_]
127         * In default deployment CCSDK (cds-blueprints-processor-http) exposes HTTP port 30499 outside of cluster. [`OJSI-197 <https://jira.onap.org/browse/OJSI-197>`_]
128
129 *Known Vulnerabilities in Used Modules*
130
131 Quick Links:
132  - `CCSDK project page <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`_
133
134  - `Passing Badge information for CCSDK <https://bestpractices.coreinfrastructure.org/en/projects/1630>`_
135
136  - `Project Vulnerability Review Table for CCSDK <https://wiki.onap.org/pages/viewpage.action?pageId=51282469>`_
137
138
139 Version 0.4.4/0.4.5
140 *******************
141 :Release Date: 2019-06-13
142
143 Note: The Dublin version for most CCSDK repositories is 0.4.4, except for CDS which is version
144 0.4.5
145
146 **New Features**
147
148 The full list of Dublin epics and user stories for CCSDK may be found at <https://jira.onap.org/issues/?filter=11802>.
149
150 The following list summarizes some of the most significant epics:
151
152 +-------------+------------------------------------------------+
153 | Jira #      | Abstract                                       |
154 +=============+================================================+
155 | [CCSDK-575] | Improve E2E Process Automation                 |
156 +-------------+------------------------------------------------+
157 | [CCSDK-840] | S3P - Footprint Optimization                   |
158 +-------------+------------------------------------------------+
159 | [CCSDK-859] | Update to OpenDaylight Fluorine                |
160 +-------------+------------------------------------------------+
161 | [CCSDK-929] | 5G Use Case                                    |
162 +-------------+------------------------------------------------+
163 | [CCSDK-930] | CCVPN Use Case Extension                       |
164 +-------------+------------------------------------------------+
165
166
167 **Bug Fixes**
168 The full list of bug fixes in the CCSDK Dublin release may be found at <https://jira.onap.org/issues/?filter=11804>
169
170 **Known Issues**
171 The full list of known issues in CCSDK may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11341>
172
173 **Security Notes**
174
175 *Fixed Security Issues*
176
177 *Known Security Issues*
178
179         * In default deployment CCSDK (netbox-nginx) exposes HTTP port 30420 outside of cluster. [`OJSI-160 <https://jira.onap.org/browse/OJSI-160>`_]
180         * In default deployment CCSDK (cds-ui) exposes HTTP port 30497 outside of cluster. [`OJSI-196 <https://jira.onap.org/browse/OJSI-196>`_]
181         * In default deployment CCSDK (cds-blueprints-processor-http) exposes HTTP port 30499 outside of cluster. [`OJSI-197 <https://jira.onap.org/browse/OJSI-197>`_]
182
183 *Known Vulnerabilities in Used Modules*
184
185 Quick Links:
186  - `CCSDK project page <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`_
187
188  - `Passing Badge information for CCSDK <https://bestpractices.coreinfrastructure.org/en/projects/1630>`_
189
190  - `Project Vulnerability Review Table for CCSDK Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=51282469>`_
191
192 Version: 0.3.3
193 **************
194
195 :Release Date: 2019-01-30
196
197 ** Bug Fixes **
198 The following bugs are fixed in the CCSDK Casablanca January 2019 maintenance release:
199
200 +-------------+-------------------------------------------------------------------------------+
201 | Jira #      | Abstract                                                                      |
202 +=============+===============================================================================+
203 | [CCSDK-727] | Do not prepend "sub" for subnet net id                                        |
204 +-------------+-------------------------------------------------------------------------------+
205 | [CCSDK-728] | Self serve DG adjustement for unassign                                        |
206 +-------------+-------------------------------------------------------------------------------+
207 | [CCSDK-740] | Restore inventory-response-item definition to the original version            |
208 +-------------+-------------------------------------------------------------------------------+
209 | [CCSDK-765] | Upgrade jackson version to 2.8.9                                              |
210 +-------------+-------------------------------------------------------------------------------+
211 | [CCSDK-777] | Release version contains some snapshots                                       |
212 +-------------+-------------------------------------------------------------------------------+
213 | [CCSDK-843] | Compile error due to old snapshot dependency                                  |
214 +-------------+-------------------------------------------------------------------------------+
215 | [CCSDK-935] | restapicall JsonParser failed if response contains : as part of response body |
216 +-------------+-------------------------------------------------------------------------------+
217
218 **Known Issues**
219 The full list of known issues in CCSDK may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11341>
220
221 Quick Links:
222    - `CCSDK project page <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`_
223
224    - `Passing Badge information for CCSDK <https://bestpractices.coreinfrastructure.org/en/projects/1630>`_
225
226    - `Project Vulnerability Review Table for CCSDK Casablanca Maintenance Release <https://wiki.onap.org/pages/viewpage.action?pageId=45300857>`_
227
228 Version: 0.3.2
229 **************
230
231 :Release Date: 2018-11-30
232
233 **New Features**
234
235 The full list of Casablanca epics and user stories for CCSDK maybe be found at <https://jira.onap.org/issues/?filter=11516>.
236
237 The following list summarizes some of the most significant epics:
238
239 +-------------+------------------------------------------------+
240 | Jira #      | Abstract                                       |
241 +=============+================================================+
242 | [CCSDK-279] | Update to OpenDaylight Oxygen release          |
243 +-------------+------------------------------------------------+
244 | [CCSDK-357] | Develop Controller Design Studio in Casablanca |
245 +-------------+------------------------------------------------+
246 | [CCSDK-324] | Enhancements to support CCVPN use case         |
247 +-------------+------------------------------------------------+
248 | [CCSDK-288] | Usability Enhancements                         |
249 +-------------+------------------------------------------------+
250
251 **Bug Fixes**
252 The full list of bug fixes in the CCSDK Casablanca release may be found at <https://jira.onap.org/issues/?filter=11544>
253
254 **Known Issues**
255 The full list of known issues in CCSDK may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11341>
256
257 Quick Links:
258  - `CCSDK project page <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`_
259
260  - `Passing Badge information for CCSDK <https://bestpractices.coreinfrastructure.org/en/projects/1630>`_
261
262  - `Project Vulnerability Review Table for CCSDK Casablanca <https://wiki.onap.org/pages/viewpage.action?pageId=45300857>`_
263
264 Version: 0.2.4
265 **************
266
267
268 :Release Date: 2018-06-07
269
270
271
272 **New Features**
273
274 The full list of Beijing Epics and user stories for CCSDK may be found at <https://jira.onap.org/issues/?filter=10792>.  The following
275 list summarizes some of the more critical features:
276
277 +--------------+-----------------------------------------------------------------------------------------------+
278 | Jira #       | Abstract                                                                                      |
279 +==============+===============================================================================================+
280 | [CCSDK-222]  | Ansible server support <https://jira.onap.org/browse/CCSDK-222>                               |
281 +--------------+-----------------------------------------------------------------------------------------------+
282 | [CCSDK-191]  | enable fast loading of graphs <https://jira.onap.org/browse/CCSDK-191>                        |
283 +--------------+-----------------------------------------------------------------------------------------------+
284 | [CCSDK-179]  | Upgrade CCSDK ODL containers to Nitrogen <https://jira.onap.org/browse/CCSDK-179>             |
285 +--------------+-----------------------------------------------------------------------------------------------+
286 | [CCSDK-177]  | Upgrade sli/northbound to Nitrogen <https://jira.onap.org/browse/CCSDK-177>                   |
287 +--------------+-----------------------------------------------------------------------------------------------+
288 | [CCSDK-176]  | Upgrade sli/adaptors to Nitrogen <https://jira.onap.org/browse/CCSDK-176>                     |
289 +--------------+-----------------------------------------------------------------------------------------------+
290 | [CCSDK-175]  | Upgrade sli/core to Nitrogen <https://jira.onap.org/browse/CCSDK-175>                         |
291 +--------------+-----------------------------------------------------------------------------------------------+
292 | [CCSDK-174]  | Update ccsdk parent to support Nitrogen parent poms <https://jira.onap.org/browse/CCSDK-174>  |
293 +--------------+-----------------------------------------------------------------------------------------------+
294 | [CCSDK-172]  | Ability to call Ansible playbook from directed graph <https://jira.onap.org/browse/CCSDK-172> |
295 +--------------+-----------------------------------------------------------------------------------------------+
296
297 **Bug Fixes**
298
299 The full list of bug fixes in the CCSDK Beijing release may be found at <https://jira.onap.org/issues/?filter=11117>
300
301 **Known Issues**
302
303 +--------------+-----------------------------------------------------------------------------------------------------+
304 | Jira #       | Abstract                                                                                            |
305 +==============+=====================================================================================================+
306 | [CCSDK-136]  | pgaas is dependent on location\_prefix being all lowercase <https://jira.onap.org/browse/CCSDK-136> |
307 +--------------+-----------------------------------------------------------------------------------------------------+
308
309 **Security Notes**
310
311 CCSDK 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 CCSDK open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379011>`_.
312
313 Quick Links:
314  - `CCSDK project page <https://wiki.onap.org/display/DW/Common+Controller+SDK+Project>`_
315
316  - `Passing Badge information for CCSDK <https://bestpractices.coreinfrastructure.org/en/projects/1630>`_
317
318  - `Project Vulnerability Review Table for CCSDK Beijing <https://wiki.onap.org/pages/viewpage.action?pageId=28379011>`_
319
320 **Upgrade Notes**
321
322 N/A
323
324 **Deprecation Notes**
325
326 N/A
327
328 **Other**
329
330 N/A
331
332
333 Version: 0.1.0
334 **************
335
336
337 :Release Date: 2017-11-16
338
339
340
341 **New Features**
342
343 The Common Controller SDK provides the following functionality :
344    - Service Logic Interpreter
345    - Database access library (dblib)
346    - Service Logic test api (sliapi)
347    - MD-SAL data query adaptor
348    - SQL query adaptor
349    - Resource allocator
350    - SDC interface
351    - DMAAP interface
352    - REST API adaptor
353
354
355 **Bug Fixes**
356
357 **Known Issues**
358    - `CCSDK-110 <https://jira.onap.org/browse/CCSDK-110>`_ Resolve license issues in dashboard project
359    - `CCSDK-136 <https://jira.onap.org/browse/CCSDK-136>`_ pgaas is dependent on location_prefix being all lowercase
360    - `CCSDK-137 <https://jira.onap.org/browse/CCSDK-137>`_ isolate deprecated methods
361
362 **Security Issues**
363    You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
364
365
366 **Upgrade Notes**
367
368 **Deprecation Notes**
369
370 **Other**