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