Update casablanca maintenance rel notes
[optf/has.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
10 Version: 3.0.1
11 --------------
12
13 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
14
15 The following items were deployed with the Casablanca Maintenance Release:
16
17
18 **New Features**
19
20 None.
21
22 **Bug Fixes**
23
24 * [OPTFRA-401] -        Need flavor id while launching vm.
25
26
27
28 Version: 3.0.0
29 --------------
30
31 :Release Date: 2018-11-30 (R3 Casablanca Release)
32
33 **New Features**
34
35 A summary of features includes: 
36
37 * Security enhancements, including integration with AAF to implement access controls on 
38     OSDF and HAS northbound interfaces
39 * Integration with SMS
40 * Platform Maturity Level 1
41     * ~50%+ unit test coverage
42 * Hardware Platform Awareness Enhancements
43     1) Added support for SRIOV-NIC and directives to assist the orchestrator
44     2) Select the best candidate across all cloud region based on HPA score.
45     3) HPA metrics using prometheus
46     
47 The Casablanca release for OOF delivered the following Epics. 
48
49     * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
50     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
51     * OPTFRA-267 - OOF - HPA Enhancements
52     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
53     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
54     * OPTFRA-271 - This epic spans the work to progress further from the current security level
55     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
56     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
57     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
58     * OPTFRA-275 - This epic spans the stories to improve deployability of services
59     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
60     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
61
62 **Bug Fixes**
63
64     * OPTFRA-205 - Generated conductor.conf missing configurations
65     * OPTFRA-210 - Onboarding to Music error
66     * OPTFRA-211 - Error solution for HPA 
67     * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
68     * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
69     * OPTFRA-264 - oof-has-zookeeper image pull error
70     * OPTFRA-305 - Analyze OOM health check failure
71     * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
72     * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
73     * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name 
74     * OPTFRA-325 - spelling mistake
75     * OPTFRA-326 - hyperlink links are missing
76     * OPTFRA-335 - Making flavors an optional field in HAS candidate object
77     * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
78     * OPTFRA-338 - Create authentication key for OOF-VFC integration
79     * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
80     * OPTFRA-344 - Fix broken HPA CSIT test
81     * OPTFRA-354 - Generalize the logic to process Optimization policy
82     * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
83     * OPTFRA-359 - Create index on plans table for HAS
84     * OPTFRA-362 - AAF Authentication CSIT issues
85     * OPTFRA-365 - Fix Jenkins jobs for CMSO
86     * OPTFRA-366 - HAS CSIT issues
87     * OPTFRA-370 - Update the version of the OSDF and HAS images
88     * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
89     * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
90     * OPTFRA-384 - Generate and Validate Policy for vFW testing
91     * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
92     * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
93     * OPTFRA-395 - CMSO - Fix security violations and increment version
94
95
96 **Known Issues**
97
98 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
99
100     * OPTFRA-401 - Need flavor id while launching vm
101     * OPTFRA-398 - Add documentation for OOF-VFC interaction
102     * OPTFRA-393 - CMSO Implement code coverage
103     * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
104     * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
105     * OPTFRA-337 - Document new transitions in HAS states
106     * OPTFRA-331 - Role-based access controls to OOF
107     * OPTFRA-329 - role based access control for OSDF-Policy interface
108     * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
109     * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
110     * OPTFRA-304 - Code cleaning
111     * OPTFRA-300 - Fix Heat deployment scripts for OOF
112     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
113     * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
114     * OPTFRA-296 - Support SON (PCI) optimization using OSDF
115     * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
116     * OPTFRA-292 - Implement encryption for all HAS internal and external communication
117     * OPTFRA-279 - Policy-based capacity check enhancements
118     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
119     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
120     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
121     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
122     * OPTFRA-271 - This epic spans the work to progress further from the current security level
123     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
124     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
125     * OPTFRA-268 - OOF - project specific enhancements
126     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
127     * OPTFRA-262 - ReadTheDoc - update for R3
128     * OPTFRA-260 - Testing vCPE flows with multiple clouds
129     * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
130     * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
131
132 **Security Issues**
133
134 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
135
136 **Quick Links**:
137         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
138         
139         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
140
141 **Upgrade Notes**
142 To upgrade, run docker container or install from source, See Distribution page  
143
144 **Deprecation Notes**
145 No features deprecated in this release  
146
147 **Other**
148 None
149
150 Version: 2.0.0
151 --------------
152
153 :Release Date: 2018-06-07 (Beijing Release)
154
155 **New Features**
156
157 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues: 
158
159 * Baseline HAS functionality
160     * support for VCPE use case
161     * support for HPA (Hardware Platform Awareness)
162 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
163 * Platform Maturity Level 1
164     * ~50%+ unit test coverage
165     
166 The Beijing release for OOF delivered the following Epics. 
167
168     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
169
170     * [OPTFRA-6] - Integrate OOF with other ONAP components
171
172     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
173
174     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
175
176     * [OPTFRA-21] - OOF Packaging
177
178     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
179
180     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
181
182     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
183
184     * [OPTFRA-33] - OOF Support for HPA
185
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     * [OPTFRA-179] - Error solution for HPA
196
197     * [OPTFRA-205] - Onboarding to Music error
198
199     * [OPTFRA-210] - Generated conductor.conf missing configurations
200
201     * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
202
203
204 **Security Issues**
205
206 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
207
208 Quick Links:
209         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
210         
211         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
212
213 **Upgrade Notes**
214 None. Initial release R2 Beijing. No previous versions  
215
216 **Deprecation Notes**
217 None. Initial release R2 Beijing. No previous versions  
218
219 **Other**
220 None