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