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