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