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