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