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