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