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