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