Document fixed OJSI-147 vulnerability
[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-2019 AT&T Intellectual Property.  All rights reserved.
4
5 Release Notes
6 =============
7
8 Version: 4.0.3
9 --------------
10
11 :Release Date: 2019-05-06
12
13 **New Features**
14
15 The Dublin release is the fourth release of the Control Loop Automation Management Platform (CLAMP).
16
17 The main goal of the Dublin release was to:
18
19     - Stabilize Platform maturity by stabilizing CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Dublin+Release+Platform+Maturity>`_.
20     - CLAMP supports of Policy-model based Configuration Policy
21     - CLAMP supports new Policy Engine direct Rest API (no longer based on jar provided by Policy Engine)
22     - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ.
23
24 **Bug Fixes**
25
26         - The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/CLAMP/versions/10427>`_
27           This includes the list of bugs that were fixed during the course of this release.
28
29 **Known Issues**
30
31     - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state
32
33 **Security Notes**
34
35 *Fixed Security Issues*
36
37     - `OJSI-128 <https://jira.onap.org/browse/OJSI-128>`_ In default deployment CLAMP (clamp) exposes HTTP port 30258 outside of cluster.
38     - `OJSI-147 <https://jira.onap.org/browse/OJSI-147>`_ In default deployment CLAMP (cdash-kibana) exposes HTTP port 30290 outside of cluster.
39
40 *Known Security Issues*
41
42 *Known Vulnerabilities in Used Modules*
43
44 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.
45 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>`_.
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         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_
53
54 **Upgrade Notes**
55
56     New Docker Containers are available.
57
58
59 Version: 3.0.4 - maintenance release
60 ------------------------------------
61
62 :Release Date: 2019-04-06
63
64 **New Features**
65 none
66
67 **Bug Fixes**
68 none
69
70 **Known Issues**
71 CLAMP certificates have been renewed to extend their expiry dates
72     - `CLAMP-335 <https://jira.onap.org/browse/CLAMP-335>`_ Update Certificates on Casablanca release.
73
74
75 Version: 3.0.3 - maintenance release
76 ------------------------------------
77
78 :Release Date: 2019-02-06
79
80 **New Features**
81 none
82
83 **Bug Fixes**
84 none
85
86 **Known Issues**
87 one documentation issue was fixed, this issue does not require a new docker image:
88     - `CLAMP-257 <https://jira.onap.org/browse/CLAMP-257>`_ User Manual for CLAMP : nothing on readthedocs.
89
90 Version: 3.0.3
91 --------------
92
93 :Release Date: 2018-11-30
94
95 **New Features**
96
97 The Casablanca release is the third release of the Control Loop Automation Management Platform (CLAMP).
98
99 The main goal of the Casablanca release was to:
100
101     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Casablanca+Release+Platform+Maturity>`_.
102     - CLAMP Dashboard improvements for the monitoring of active Closed Loops
103     - CLAMP logs alignment on the ONAP platform.
104     - CLAMP is now integrated with AAF for authentication and permissions retrieval (AAF server is pre-loaded by default with the required permissions)
105     - CLAMP improvement for configuring the policies (support of Scale Out use case)
106     - 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)
107     - As a POC, the javascript coverage can now be enabled in SONAR (Disabled for now)
108
109 **Bug Fixes**
110
111         - The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/CLAMP/versions/10408>`_
112           This includes the list of bugs that were fixed during the course of this release.
113
114 **Known Issues**
115
116     - None
117
118 **Security Notes**
119
120 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.
121 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>`_.
122
123 Quick Links:
124         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
125
126         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
127
128         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_
129
130 **Upgrade Notes**
131
132     New Docker Containers are available, an ELK stack is also now part of CLAMP deployments.
133
134 **Deprecation Notes**
135
136     The CLAMP Designer Menu (in CLAMP UI) is deprecated since Beijing, the design time is being onboarded into SDC - DCAE D.
137
138 **Other**
139
140     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
141
142 **How to - Videos**
143
144     https://wiki.onap.org/display/DW/CLAMP+videos
145
146 Version: 2.0.2
147 --------------
148
149 :Release Date: 2018-06-07
150
151 **New Features**
152
153 The Beijing release is the second release of the Control Loop Automation Management Platform (CLAMP).
154
155 The main goal of the Beijing release was to:
156
157     - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
158     - Focus CLAMP on Closed loop runtime operations and control - this is reflected by the move of the design part to DCAE-D.
159     - Introduce CLAMP Dashboard for monitoring of active Closed Loops.
160     - CLAMP is integrated with MSB.
161     - CLAMP has integrated SWAGGER.
162     - CLAMP main Core has been reworked for improved flexibility.
163
164 **Bug Fixes**
165
166         - The full list of implemented user stories and epics is available on `BEIJING RELEASE <https://jira.onap.org/projects/CLAMP/versions/10314>`_
167           This includes the list of bugs that were fixed during the course of this release.
168
169 **Known Issues**
170
171     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
172
173         The "Deploy" action does not work directly after submitting it.
174
175         Workaround:
176
177         You have to close the CL and reopen it again. In that case the Deploy action will do something.
178
179 **Security Notes**
180
181 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>`_.
182
183 Quick Links:
184         - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_
185
186         - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_
187
188         - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_
189
190 **Upgrade Notes**
191
192     New Docker Containers are avaialble, an ELK stack is also now part of CLAMP deployments.
193
194 **Deprecation Notes**
195
196     The CLAMP Designer UI is now deprecated and unavailable, the design time is being onboarded into SDC - DCAE D.
197
198 **Other**
199
200     CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP.
201
202 Version: 1.1.0
203 --------------
204
205 :Release Date: 2017-11-16
206
207 **New Features**
208
209 The Amsterdam release is the first release of the Control Loop Automation Management Platform (CLAMP).
210
211 The main goal of the Amsterdam release was to:
212
213     - Support the automation of provisionning for the Closed loops of the vFW, vDNW and vCPE through TCA.
214     - Support the automation of provisionning for the Closed loops of VVolte (Holmes)
215     - Demonstrate complete interaction with Policy, DCAE, SDC and Holmes.
216
217 **Bug Fixes**
218
219         - The full list of implemented user stories and epics is available on `AMSTERDAM RELEASE <https://jira.onap.org/projects/CLAMP/versions/10313>`_
220           This is technically the first release of CLAMP, previous release was the seed code contribution.
221           As such, the defects fixed in this release were raised during the course of the release.
222           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.
223
224 **Known Issues**
225         - `CLAMP-68 <https://jira.onap.org/browse/CLAMP-68>`_ ResourceVF not always provisioned.
226
227         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.
228
229         Workaround:
230
231         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.
232
233     - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work.
234
235         The "Deploy" action does not work directly after submitting it.
236
237         Workaround:
238
239         You have to close the CL and reopen it again. In that case the Deploy action will do something
240
241
242 **Security Issues**
243         CLAMP is following the CII Best Practices Badge Program, results including security assesment can be found on the
244         `project page <https://bestpractices.coreinfrastructure.org/projects/1197>`_
245
246
247 **Upgrade Notes**
248
249     N/A
250
251 **Deprecation Notes**
252
253     N/A
254
255 **Other**
256
257
258
259 ===========
260
261 End of Release Notes