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