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