Merge "add one known issue"
[clamp.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (c) 2017-2020 AT&T Intellectual Property.  All rights reserved.
4 .. _release_notes:
5
6 Release Notes
7 =============
8
9 Version: 5.0.1 (Frankfurt)
10 --------------------------
11
12 :Release Date: 2020-05-12
13
14 **New Features**
15
16 The Frankfurt release is the seventh release of the Control Loop Automation Management Platform (CLAMP).
17
18 The main goal of the Frankfurt release was to:
19
20     - implementing a new Control Loop creation flow: Self Serve Control Loop(partially done will be continued in next release).
21     - Add Tosca policy-model support for Operational Policies definitions.
22     - Add integration to CDS for Actor/Action selection.
23     - Move from SearchGuard to OpenDistro.
24     - Document(high level) current upgrade component strategy (TSC must have).
25     - SECCOM Perform Software Composition Analysis - Vulnerability tables (TSC must have).
26     - SECCOM Password removal from OOM HELM charts (TSC must have).
27     - SECCOM Password removal from OOM HELM charts (TSC must have).
28     - SECCOM HTTPS communication vs. HTTP (TSC must have)
29
30 **Bug Fixes**
31
32         - The full list of implemented user stories and epics is available on `Frankfurt CLAMP M1 release planning <https://wiki.onap.org/display/DW/CLAMP+R6+-+M1+Release+Planning>`_
33         - The full list of issues(bugs) solved, is available on `CLAMP R6 - Frankfurt list of solved issues(bugs) <https://wiki.onap.org/pages/viewpage.action?pageId=84648915>`_
34
35 **Known Issues**
36     - `CLAMP-856 <https://jira.onap.org/browse/CLAMP-856>`_ CLAMP should not display all CDS workflow properties
37
38
39 **Security Notes**
40
41 *Fixed Security Issues*
42
43 *Known Security Issues*
44
45 *Known Vulnerabilities in Used Modules*
46
47 CLAMP 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 actions to be taken in future release.
48
49 Quick Links:
50         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
51
52         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
53
54 **Upgrade Notes**
55
56     New Docker Containers are available. the list of containers composing this release are below:
57     - clamp-backend-filebeat-onap: docker.elastic.co/beats/filebeat 5.5.0
58     - clamp-backend: nexus3.onap.org:10001/onap/clamp-backend 5.0.6
59     - clamp-frontend: nexus3.onap.org:10001/onap/clamp-frontend 5.0.6
60     - clamp-dash-es: nexus3.onap.org:10001/onap/clamp-dashboard-elasticsearch 5.0.3
61     - clamp-dash-kibana: nexus3.onap.org:10001/onap/clamp-dashboard-kibana 5.0.3
62     - clamp-dash-logstash: nexus3.onap.org:10001/onap/clamp-dashboard-logstash 5.0.3
63
64
65 Version: 4.1.3 (El-Alto)
66 ------------------------
67
68 :Release Date: 2019-10-11
69
70 **New Features**
71
72 The El Alto release is the sixth release of the Control Loop Automation Management Platform (CLAMP).
73
74 The main goal of the El Alto release was to:
75
76     - _.Fix a maximum a security issues, especially the angular related issues by moving to React.
77
78 **Bug Fixes**
79
80         - The full list of implemented user stories and epics is available on `El Alto CLAMP user stories done <https://wiki.onap.org/display/DW/El+Alto+CLAMP+user+stories+done>`_
81           This includes the list of bugs that were fixed during the course of this release.
82
83 **Known Issues**
84
85     - `CLAMP-506 <https://jira.onap.org/browse/CLAMP-506>`_ Elastic Search Clamp image cannot be built anymore(SearchGuard DMCA issue)
86     - Due to the uncertainties with the DMCA SearchGuard issue, the ELK stack has been removed from El Alto release, meaning the CLAMP "Control Loop Dashboard" is not part of the El Alto release.
87     - `CLAMP-519 <https://jira.onap.org/browse/CLAMP-519>`_ Clamp cannot authenticate to AAF(Local authentication as workaround)
88
89
90 **Security Notes**
91
92 *Fixed Security Issues*
93
94 *Known Security Issues*
95
96 *Known Vulnerabilities in Used Modules*
97
98 CLAMP 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 actions to be taken in future release.
99 The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_.
100
101 Quick Links:
102         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
103
104         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
105
106         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_
107
108 **Upgrade Notes**
109
110     New Docker Containers are available.
111
112
113 Version: 4.1.0 (El-Alto Early Drop)
114 -----------------------------------
115
116 :Release Date: 2019-08-19
117
118 **New Features**
119
120 The El Alto-Early Drop release is the fifth release of the Control Loop Automation Management Platform (CLAMP).
121
122 The main goal of the El Alto-Early Drop release was to:
123
124     - _.Fix a maximum a security issues, especially the angular related issues by moving to React.
125
126 **Bug Fixes**
127
128         - The full list of implemented user stories and epics is available on `CLAMP R5 - Early Drop RELEASE <https://wiki.onap.org/display/DW/CLAMP+R5+-+Early+Drop>`_
129           This includes the list of bugs that were fixed during the course of this release.
130
131 **Known Issues**
132
133     - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state
134
135 **Security Notes**
136
137 *Fixed Security Issues*
138
139     - `OJSI-166 <https://jira.onap.org/browse/OJSI-166>`_ Port 30290 exposes unprotected service outside of cluster.
140
141 *Known Security Issues*
142
143 *Known Vulnerabilities in Used Modules*
144
145 CLAMP 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 actions to be taken in future release.
146 The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_.
147
148 Quick Links:
149         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
150
151         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
152
153         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_
154
155 **Upgrade Notes**
156
157     New Docker Containers are available.
158
159
160
161 Version: 4.0.5 (Dublin)
162 -----------------------
163
164 :Release Date: 2019-06-06
165
166 **New Features**
167
168 The Dublin release is the fourth release of the Control Loop Automation Management Platform (CLAMP).
169
170 The main goal of the Dublin release was to:
171
172     - Stabilize Platform maturity by stabilizing CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Dublin+Release+Platform+Maturity>`_.
173     - CLAMP supports of Policy-model based Configuration Policy
174     - CLAMP supports new Policy Engine direct Rest API (no longer based on jar provided by Policy Engine)
175     - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ.
176
177 **Bug Fixes**
178
179         - The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/CLAMP/versions/10427>`_
180           This includes the list of bugs that were fixed during the course of this release.
181
182 **Known Issues**
183
184     - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state
185
186 **Security Notes**
187
188 *Fixed Security Issues*
189
190     - `OJSI-128 <https://jira.onap.org/browse/OJSI-128>`_ In default deployment CLAMP (clamp) exposes HTTP port 30258 outside of cluster.
191     - `OJSI-147 <https://jira.onap.org/browse/OJSI-147>`_ In default deployment CLAMP (cdash-kibana) exposes HTTP port 30290 outside of cluster.
192     - `OJSI-152 <https://jira.onap.org/browse/OJSI-152>`_ In default deployment CLAMP (clamp) exposes HTTP port 30295 outside of cluster.
193
194 *Known Security Issues*
195
196 *Known Vulnerabilities in Used Modules*
197
198 CLAMP 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 actions to be taken in future release.
199 The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_.
200
201 Quick Links:
202         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
203
204         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
205
206         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_
207
208 **Upgrade Notes**
209
210     New Docker Containers are available.
211
212
213 Version: 3.0.4 - maintenance release
214 ------------------------------------
215
216 :Release Date: 2019-04-06
217
218 **New Features**
219 none
220
221 **Bug Fixes**
222 none
223
224 **Known Issues**
225 CLAMP certificates have been renewed to extend their expiry dates
226     - `CLAMP-335 <https://jira.onap.org/browse/CLAMP-335>`_ Update Certificates on Casablanca release.
227
228
229 Version: 3.0.3 - maintenance release
230 ------------------------------------
231
232 :Release Date: 2019-02-06
233
234 **New Features**
235 none
236
237 **Bug Fixes**
238 none
239
240 **Known Issues**
241 one documentation issue was fixed, this issue does not require a new docker image:
242     - `CLAMP-257 <https://jira.onap.org/browse/CLAMP-257>`_ User Manual for CLAMP : nothing on readthedocs.
243
244 Version: 3.0.3 (Casablanca)
245 ---------------------------
246
247 :Release Date: 2018-11-30
248
249 **New Features**
250
251 The Casablanca release is the third release of the Control Loop Automation Management Platform (CLAMP).
252
253 The main goal of the Casablanca release was to:
254
255     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Casablanca+Release+Platform+Maturity>`_.
256     - CLAMP Dashboard improvements for the monitoring of active Closed Loops
257     - CLAMP logs alignment on the ONAP platform.
258     - CLAMP is now integrated with AAF for authentication and permissions retrieval (AAF server is pre-loaded by default with the required permissions)
259     - CLAMP improvement for configuring the policies (support of Scale Out use case)
260     - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ on JAVA/JAVASCRIPT code (Libraries upgrade or removal/replacement when possible)
261     - As a POC, the javascript coverage can now be enabled in SONAR (Disabled for now)
262
263 **Bug Fixes**
264
265         - The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/CLAMP/versions/10408>`_
266           This includes the list of bugs that were fixed during the course of this release.
267
268 **Known Issues**
269
270     - None
271
272 **Security Notes**
273
274 CLAMP 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 actions to be taken in future release.
275 The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_.
276
277 Quick Links:
278         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
279
280         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
281
282         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_
283
284 **Upgrade Notes**
285
286     New Docker Containers are available, an ELK stack is also now part of CLAMP deployments.
287
288 **Deprecation Notes**
289
290     The CLAMP Designer Menu (in CLAMP UI) is deprecated since Beijing, the design time is being onboarded into SDC - DCAE D.
291
292 **Other**
293
294     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
295
296 **How to - Videos**
297
298     https://wiki.onap.org/display/DW/CLAMP+videos
299
300 Version: 2.0.2 (Beijing)
301 ------------------------
302
303 :Release Date: 2018-06-07
304
305 **New Features**
306
307 The Beijing release is the second release of the Control Loop Automation Management Platform (CLAMP).
308
309 The main goal of the Beijing release was to:
310
311     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
312     - Focus CLAMP on Closed loop runtime operations and control - this is reflected by the move of the design part to DCAE-D.
313     - Introduce CLAMP Dashboard for monitoring of active Closed Loops.
314     - CLAMP is integrated with MSB.
315     - CLAMP has integrated SWAGGER.
316     - CLAMP main Core has been reworked for improved flexibility.
317
318 **Bug Fixes**
319
320         - The full list of implemented user stories and epics is available on `BEIJING RELEASE <https://jira.onap.org/projects/CLAMP/versions/10314>`_
321           This includes the list of bugs that were fixed during the course of this release.
322
323 **Known Issues**
324
325     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
326
327         The "Deploy" action does not work directly after submitting it.
328
329         Workaround:
330
331         You have to close the CL and reopen it again. In that case the Deploy action will do something.
332
333 **Security Notes**
334
335 CLAMP 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 CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_.
336
337 Quick Links:
338         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
339
340         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
341
342         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_
343
344 **Upgrade Notes**
345
346     New Docker Containers are avaialble, an ELK stack is also now part of CLAMP deployments.
347
348 **Deprecation Notes**
349
350     The CLAMP Designer UI is now deprecated and unavailable, the design time is being onboarded into SDC - DCAE D.
351
352 **Other**
353
354     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
355
356 Version: 1.1.0 (Amsterdam)
357 --------------------------
358
359 :Release Date: 2017-11-16
360
361 **New Features**
362
363 The Amsterdam release is the first release of the Control Loop Automation Management Platform (CLAMP).
364
365 The main goal of the Amsterdam release was to:
366
367     - Support the automation of provisionning for the Closed loops of the vFW, vDNW and vCPE through TCA.
368     - Support the automation of provisionning for the Closed loops of VVolte (Holmes)
369     - Demonstrate complete interaction with Policy, DCAE, SDC and Holmes.
370
371 **Bug Fixes**
372
373         - The full list of implemented user stories and epics is available on `AMSTERDAM RELEASE <https://jira.onap.org/projects/CLAMP/versions/10313>`_
374           This is technically the first release of CLAMP, previous release was the seed code contribution.
375           As such, the defects fixed in this release were raised during the course of the release.
376           Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above.
377
378 **Known Issues**
379         - `CLAMP-68 <https://jira.onap.org/browse/CLAMP-68>`_ ResourceVF not always provisioned.
380
381         In Closed Loop -> Properties CL: When opening the popup window, the first service in the list does not show Resource-VF even though in SDC there is a resource instance in the service.
382
383         Workaround:
384
385         If you have multiple service available (if not create a dummy one on SDC), just click on another one and then click back on the first one in the list. The ResourceVF should be provisioned now.
386
387     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
388
389         The "Deploy" action does not work directly after submitting it.
390
391         Workaround:
392
393         You have to close the CL and reopen it again. In that case the Deploy action will do something
394
395
396 **Security Issues**
397         CLAMP is following the CII Best Practices Badge Program, results including security assesment can be found on the
398         `project page <https://bestpractices.coreinfrastructure.org/projects/1197>`_
399
400
401 **Upgrade Notes**
402
403     N/A
404
405 **Deprecation Notes**
406
407     N/A
408
409 **Other**
410
411
412
413 ===========
414
415 End of Release Notes