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