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