correct release note
[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     - Other more minor issues are captured in the following page:`CLAMP known Frankfurt issues <https://wiki.onap.org/display/DW/CLAMP+R6+-+Frankfurt+known+issues%28bugs%29+-+to+be+solved+in+futur+Releases>`_
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     - The Upgrade strategy for Frankfurt can be found here:`<https://wiki.onap.org/display/DW/Frankfurt+CLAMP+Container+upgrade+strategy>`_
57     - New Docker Containers are available. the list of containers composing this release are below:
58
59        - clamp-backend-filebeat-onap: docker.elastic.co/beats/filebeat 5.5.0
60        - clamp-backend: nexus3.onap.org:10001/onap/clamp-backend 5.0.7
61        - clamp-frontend: nexus3.onap.org:10001/onap/clamp-frontend 5.0.7
62        - clamp-dash-es: nexus3.onap.org:10001/onap/clamp-dashboard-elasticsearch 5.0.3
63        - clamp-dash-kibana: nexus3.onap.org:10001/onap/clamp-dashboard-kibana 5.0.3
64        - clamp-dash-logstash: nexus3.onap.org:10001/onap/clamp-dashboard-logstash 5.0.3
65
66
67 Version: 4.1.3 (El-Alto)
68 ------------------------
69
70 :Release Date: 2019-10-11
71
72 **New Features**
73
74 The El Alto release is the sixth release of the Control Loop Automation Management Platform (CLAMP).
75
76 The main goal of the El Alto release was to:
77
78     - _.Fix a maximum a security issues, especially the angular related issues by moving to React.
79
80 **Bug Fixes**
81
82         - 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>`_
83           This includes the list of bugs that were fixed during the course of this release.
84
85 **Known Issues**
86
87     - `CLAMP-506 <https://jira.onap.org/browse/CLAMP-506>`_ Elastic Search Clamp image cannot be built anymore(SearchGuard DMCA issue)
88     - 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.
89     - `CLAMP-519 <https://jira.onap.org/browse/CLAMP-519>`_ Clamp cannot authenticate to AAF(Local authentication as workaround)
90
91
92 **Security Notes**
93
94 *Fixed Security Issues*
95
96 *Known Security Issues*
97
98 *Known Vulnerabilities in Used Modules*
99
100 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.
101 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>`_.
102
103 Quick Links:
104         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
105
106         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
107
108         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_
109
110 **Upgrade Notes**
111
112     New Docker Containers are available.
113
114
115 Version: 4.1.0 (El-Alto Early Drop)
116 -----------------------------------
117
118 :Release Date: 2019-08-19
119
120 **New Features**
121
122 The El Alto-Early Drop release is the fifth release of the Control Loop Automation Management Platform (CLAMP).
123
124 The main goal of the El Alto-Early Drop release was to:
125
126     - _.Fix a maximum a security issues, especially the angular related issues by moving to React.
127
128 **Bug Fixes**
129
130         - 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>`_
131           This includes the list of bugs that were fixed during the course of this release.
132
133 **Known Issues**
134
135     - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state
136
137 **Security Notes**
138
139 *Fixed Security Issues*
140
141     - `OJSI-166 <https://jira.onap.org/browse/OJSI-166>`_ Port 30290 exposes unprotected service outside of cluster.
142
143 *Known Security Issues*
144
145 *Known Vulnerabilities in Used Modules*
146
147 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.
148 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>`_.
149
150 Quick Links:
151         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
152
153         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
154
155         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_
156
157 **Upgrade Notes**
158
159     New Docker Containers are available.
160
161
162
163 Version: 4.0.5 (Dublin)
164 -----------------------
165
166 :Release Date: 2019-06-06
167
168 **New Features**
169
170 The Dublin release is the fourth release of the Control Loop Automation Management Platform (CLAMP).
171
172 The main goal of the Dublin release was to:
173
174     - Stabilize Platform maturity by stabilizing CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Dublin+Release+Platform+Maturity>`_.
175     - CLAMP supports of Policy-model based Configuration Policy
176     - CLAMP supports new Policy Engine direct Rest API (no longer based on jar provided by Policy Engine)
177     - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ.
178
179 **Bug Fixes**
180
181         - The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/CLAMP/versions/10427>`_
182           This includes the list of bugs that were fixed during the course of this release.
183
184 **Known Issues**
185
186     - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state
187
188 **Security Notes**
189
190 *Fixed Security Issues*
191
192     - `OJSI-128 <https://jira.onap.org/browse/OJSI-128>`_ In default deployment CLAMP (clamp) exposes HTTP port 30258 outside of cluster.
193     - `OJSI-147 <https://jira.onap.org/browse/OJSI-147>`_ In default deployment CLAMP (cdash-kibana) exposes HTTP port 30290 outside of cluster.
194     - `OJSI-152 <https://jira.onap.org/browse/OJSI-152>`_ In default deployment CLAMP (clamp) exposes HTTP port 30295 outside of cluster.
195
196 *Known Security Issues*
197
198 *Known Vulnerabilities in Used Modules*
199
200 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.
201 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>`_.
202
203 Quick Links:
204         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
205
206         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
207
208         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_
209
210 **Upgrade Notes**
211
212     New Docker Containers are available.
213
214
215 Version: 3.0.4 - maintenance release
216 ------------------------------------
217
218 :Release Date: 2019-04-06
219
220 **New Features**
221 none
222
223 **Bug Fixes**
224 none
225
226 **Known Issues**
227 CLAMP certificates have been renewed to extend their expiry dates
228     - `CLAMP-335 <https://jira.onap.org/browse/CLAMP-335>`_ Update Certificates on Casablanca release.
229
230
231 Version: 3.0.3 - maintenance release
232 ------------------------------------
233
234 :Release Date: 2019-02-06
235
236 **New Features**
237 none
238
239 **Bug Fixes**
240 none
241
242 **Known Issues**
243 one documentation issue was fixed, this issue does not require a new docker image:
244     - `CLAMP-257 <https://jira.onap.org/browse/CLAMP-257>`_ User Manual for CLAMP : nothing on readthedocs.
245
246 Version: 3.0.3 (Casablanca)
247 ---------------------------
248
249 :Release Date: 2018-11-30
250
251 **New Features**
252
253 The Casablanca release is the third release of the Control Loop Automation Management Platform (CLAMP).
254
255 The main goal of the Casablanca release was to:
256
257     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Casablanca+Release+Platform+Maturity>`_.
258     - CLAMP Dashboard improvements for the monitoring of active Closed Loops
259     - CLAMP logs alignment on the ONAP platform.
260     - CLAMP is now integrated with AAF for authentication and permissions retrieval (AAF server is pre-loaded by default with the required permissions)
261     - CLAMP improvement for configuring the policies (support of Scale Out use case)
262     - 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)
263     - As a POC, the javascript coverage can now be enabled in SONAR (Disabled for now)
264
265 **Bug Fixes**
266
267         - The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/CLAMP/versions/10408>`_
268           This includes the list of bugs that were fixed during the course of this release.
269
270 **Known Issues**
271
272     - None
273
274 **Security Notes**
275
276 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.
277 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>`_.
278
279 Quick Links:
280         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
281
282         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
283
284         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_
285
286 **Upgrade Notes**
287
288     New Docker Containers are available, an ELK stack is also now part of CLAMP deployments.
289
290 **Deprecation Notes**
291
292     The CLAMP Designer Menu (in CLAMP UI) is deprecated since Beijing, the design time is being onboarded into SDC - DCAE D.
293
294 **Other**
295
296     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
297
298 **How to - Videos**
299
300     https://wiki.onap.org/display/DW/CLAMP+videos
301
302 Version: 2.0.2 (Beijing)
303 ------------------------
304
305 :Release Date: 2018-06-07
306
307 **New Features**
308
309 The Beijing release is the second release of the Control Loop Automation Management Platform (CLAMP).
310
311 The main goal of the Beijing release was to:
312
313     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
314     - Focus CLAMP on Closed loop runtime operations and control - this is reflected by the move of the design part to DCAE-D.
315     - Introduce CLAMP Dashboard for monitoring of active Closed Loops.
316     - CLAMP is integrated with MSB.
317     - CLAMP has integrated SWAGGER.
318     - CLAMP main Core has been reworked for improved flexibility.
319
320 **Bug Fixes**
321
322         - The full list of implemented user stories and epics is available on `BEIJING RELEASE <https://jira.onap.org/projects/CLAMP/versions/10314>`_
323           This includes the list of bugs that were fixed during the course of this release.
324
325 **Known Issues**
326
327     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
328
329         The "Deploy" action does not work directly after submitting it.
330
331         Workaround:
332
333         You have to close the CL and reopen it again. In that case the Deploy action will do something.
334
335 **Security Notes**
336
337 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>`_.
338
339 Quick Links:
340         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
341
342         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
343
344         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_
345
346 **Upgrade Notes**
347
348     New Docker Containers are avaialble, an ELK stack is also now part of CLAMP deployments.
349
350 **Deprecation Notes**
351
352     The CLAMP Designer UI is now deprecated and unavailable, the design time is being onboarded into SDC - DCAE D.
353
354 **Other**
355
356     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
357
358 Version: 1.1.0 (Amsterdam)
359 --------------------------
360
361 :Release Date: 2017-11-16
362
363 **New Features**
364
365 The Amsterdam release is the first release of the Control Loop Automation Management Platform (CLAMP).
366
367 The main goal of the Amsterdam release was to:
368
369     - Support the automation of provisionning for the Closed loops of the vFW, vDNW and vCPE through TCA.
370     - Support the automation of provisionning for the Closed loops of VVolte (Holmes)
371     - Demonstrate complete interaction with Policy, DCAE, SDC and Holmes.
372
373 **Bug Fixes**
374
375         - The full list of implemented user stories and epics is available on `AMSTERDAM RELEASE <https://jira.onap.org/projects/CLAMP/versions/10313>`_
376           This is technically the first release of CLAMP, previous release was the seed code contribution.
377           As such, the defects fixed in this release were raised during the course of the release.
378           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.
379
380 **Known Issues**
381         - `CLAMP-68 <https://jira.onap.org/browse/CLAMP-68>`_ ResourceVF not always provisioned.
382
383         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.
384
385         Workaround:
386
387         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.
388
389     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
390
391         The "Deploy" action does not work directly after submitting it.
392
393         Workaround:
394
395         You have to close the CL and reopen it again. In that case the Deploy action will do something
396
397
398 **Security Issues**
399         CLAMP is following the CII Best Practices Badge Program, results including security assesment can be found on the
400         `project page <https://bestpractices.coreinfrastructure.org/projects/1197>`_
401
402
403 **Upgrade Notes**
404
405     N/A
406
407 **Deprecation Notes**
408
409     N/A
410
411 **Other**
412
413
414
415 ===========
416
417 End of Release Notes