[OPTFRA-585] Update release notes
[optf/osdf.git] / docs / sections / release-notes.rst
1 ..
2  This work is licensed under a Creative Commons Attribution 4.0
3  International License.
4
5 =============
6 Release Notes
7 =============
8
9 Version: 5.0.1
10 --------------
11
12 :Release Date: 2019-09-30 (El Alto Release)
13
14 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
15
16 Artifacts released:
17
18 optf-has:1.3.3
19 optf-osdf:1.3.4
20 optf-cmso:2.1.1
21
22 **New Features**
23
24 While no new features were added in the release, the following Stories were delivered as enhancements.
25
26     * [OPTFRA-415] Automation on policy model uploading
27     * [OPTFRA-427] CMSO - Schedule a workflow in SO and track status to completion
28
29 * Platform Maturity Level 1
30     * ~65.1+ unit test coverage
31
32
33 **Bug Fixes**
34
35 The El Alto release for OOF fixed the following Bugs.
36
37     * [OPTFRA-579] Json error in homing solution
38     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
39     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
40     * [OPTFRA-577] Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
41     * [OPTFRA-517] Clean up optf/cmso in integration/csit for Dublin
42     * [OPTFRA-486] Support "identifiers" field as a list of values
43     * [OPTFRA-403] OOF CMSO Service kubernetes resources allocation is not done
44     * [OPTFRA-526] OOF pods not running
45     * [OPTFRA-409] Template example : purpose to be explained
46     * [OPTFRA-593] OOF-CSMO healthcheck is failing in Master
47
48
49 **Known Issues**
50
51     * [OPTFRA-576] optf-has-master-csit-has is testing Dublin image
52     * [OPTFRA-596] CMSO - Sonar and CSIT jobs failing
53     * [OPTFRA-608] Error in Homing with multiple policies
54
55 **Security Notes**
56
57 *Fixed Security Issues*
58
59     * [OJSI-122] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
60     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
61     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
62     * [OPTFRA-455] CMSO - Mitigate License Threat tomcat-embed-core
63
64 *Known Security Issues*
65
66     * [OPTFRA-481] Fix Vulnerability with spring-data-jpa package
67     * [OPTFRA-431] Fix Vulnerability with spring-security-web package
68
69 *Known Vulnerabilities in Used Modules*
70
71 **Upgrade Notes**
72
73
74 **Deprecation Notes**
75
76
77 **Other**
78
79
80 Version: 4.0.0
81 --------------
82
83 :Release Date: 2019-06-06 (Dublin Release)
84
85 **New Features**
86
87 The Dublin release is the third release for ONAP Optimization Framework (OOF).
88
89 A summary of features includes
90
91 * Support SON (PCI/ANR) optimization using OSDF
92 * Implement encryption for OSDF internal and external communication
93
94 * Platform Maturity Level 1
95     * ~65.1+ unit test coverage
96
97 The Dublin release for OOF delivered the following Epics.
98
99     * [OPTFRA-426]      Track the changes to CMSO to support change management schedule optimization
100     * [OPTFRA-424]      Extend OOF to support traffic distribution optimization
101     * [OPTFRA-422]      Move OOF projects' CSIT to run on OOM
102     * [OPTFRA-276]      Implementing a POC for 5G SON Optimization
103     * [OPTFRA-270]      This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
104
105
106 **Bug Fixes**
107
108 * The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10463>`_
109
110 **Known Issues**
111
112
113
114 **Security Notes**
115
116 *Fixed Security Issues*
117
118 *Known Security Issues*
119
120     * [`OJSI-122 <https://jira.onap.org/browse/OJSI-122>`_] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
121
122 *Known Vulnerabilities in Used Modules*
123
124 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
125 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
126
127 Quick Links:
128     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
129     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
130     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
131
132 **Upgrade Notes**
133
134 None.
135
136 **Deprecation Notes**
137
138 None.
139
140 **Other**
141
142 None
143
144 Version: 3.0.1
145 --------------
146
147 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
148
149 The following items were deployed with the Casablanca Maintenance Release:
150
151
152 **New Features**
153
154 None.
155
156 **Bug Fixes**
157
158 * [OPTFRA-401] -        Need flavor id while launching vm.
159
160
161
162 Version: 3.0.0
163 --------------
164
165 :Release Date: 2018-11-30 (Casablanca Release)
166
167 **New Features**
168
169 The Casablanca release is the second release for ONAP Optimization Framework (OOF).
170
171 A summary of features includes
172
173 * Homing enhancements for improving service deployability
174     * Discovering and reusing shared resources when processing multiple homing requests in parallel
175     * Considering Latency Reduction (in addition to geographical distances) for homing optimization
176     * Enhanced capacity checks during VNF homing
177     * Asynchronous communication between HAS components
178 * OOF Casablanca S3P Usability enhancement
179     * Adherence to ONAP API Common Versioning Strategy (CVS) Proposal
180     * Move all internal and external facing APIs to Swagger 2.0
181 * OOF Casablanca S3P Performance enhancements
182     * Creating a plan for performance improvements based on the baseline measured metrics
183 * OOF development platform hardening
184     * Deployment scripts
185     * Fix Build Docker image script for supporting multiple versions
186     * Fix OOM, HEAT deployment scripts (versioning)
187     * CSIT functional tests for each repo
188     * CI Jobs for different streams (Beijing, master etc)
189     * Clean up nexus binaries and maven versioning
190 * Integrate OOF with Certificate and Secret Management Service (CSM)
191 * Support SON (PCI) optimization using OSDF
192
193 * Platform Maturity Level 1
194     * ~65.1+ unit test coverage
195
196 The Casablanca release for OOF delivered the following Epics.
197
198     * [OPTFRA-273] - Epic Name: OOF Casablanca S3P Manageability enhancement
199     * [OPTFRA-270] - Maintain current S3P levels
200     * [OPTFRA-271] - OOF Casablanca S3P Security enhancement
201     * [OPTFRA-267] - OOF - HPA Enhancements
202     * [OPTFRA-276] - Implementing a POC for 5G SON Optimization
203
204
205 **Bug Fixes**
206
207 * The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10445>`_
208
209 **Known Issues**
210
211   * [OPTFRA-223] -      On boarding and testing AAF certificates for OSDF.
212   * [OPTFRA-293] -      Implement encryption for all OSDF internal and external communication
213   * [OPTFRA-329] -      role based access control for OSDF-Policy interface
214
215 **Security Notes**
216
217 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
218 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_.
219
220 Quick Links:
221     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
222     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
223     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_
224
225 **Upgrade Notes**
226
227 None.
228
229 **Deprecation Notes**
230
231 None.
232
233 **Other**
234
235 None
236
237 Version: 2.0.0
238 --------------
239
240 :Release Date: 2018-06-07
241
242 **New Features**
243
244
245 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features includes:
246
247 * Baseline HAS functionality
248     * support for VCPE use case
249     * support for HPA (Hardware Platform Awareness)
250 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
251 * Platform Maturity Level 1
252     * ~50%+ unit test coverage
253
254 The Beijing release for OOF delivered the following Epics.
255
256     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
257     * [OPTFRA-6] - Integrate OOF with other ONAP components
258     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
259     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
260     * [OPTFRA-21] - OOF Packaging
261     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
262     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
263     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
264     * [OPTFRA-33] - OOF Support for HPA
265     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
266
267
268 **Bug Fixes**
269
270 None. Initial release R2 Beijing. No previous versions
271
272 **Known Issues**
273
274 None.
275
276 **Security Notes**
277
278 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
279
280 Quick Links:
281     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
282     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
283
284 **Upgrade Notes**
285
286 None. Initial release R2 Beijing. No previous versions
287
288 **Deprecation Notes**
289
290 None. Initial release R2 Beijing. No previous versions
291
292 **Other**
293
294 None