2 This work is licensed under a Creative Commons Attribution 4.0
9 .. ===========================
10 .. * * * FRANKFURT * * *
11 .. ===========================
16 This document provides the release notes for the Frankfurt release.
26 +--------------------------------------+--------------------------------------+
29 +--------------------------------------+--------------------------------------+
30 | **Docker images** | - optf-has 2.0.4 |
32 +--------------------------------------+--------------------------------------+
33 | **Release designation** | 6.0.0 frankfurt |
35 +--------------------------------------+--------------------------------------+
36 | **Release date** | 2020-05-07 (TBD) |
38 +--------------------------------------+--------------------------------------+
44 - Passthrough attributes has been added to placement request.
45 - HAS container to run as non-root user.
46 - HAS Component has be upgraded to Python 3.8.
47 - New inventory type NSSI is added.
48 - Functionality has been added to AAI plugin to get the nssi candidates
50 - New constraint named ``threshold`` has been added to the solver.
55 - OPTFRA-734 Nginx failing to start as non-root user.
56 - OPTFRA-733 AAF authentication fails while handling API requests.
57 - OPTFRA-746 Add NSI id to NSSI candidate.
58 - OPTFRA-747 Music api not using server url in https mode.
59 - OPTFRA-728 HPA CSIT test failures.
60 - OPTFRA-726 Nginx needs to run as root.
61 - OPTFRA-630 Sonar failing jobs.
63 Known Limitations, Issues and Workarounds
64 =========================================
81 **Fixed Security issues**
83 All HAS containers were running as root user which is fixed in this
84 release under OPTFRA-711.
89 For more information on the ONAP Frankfurt release, please see:
92 #. `ONAP Documentation`_
93 #. `ONAP Release Downloads`_
97 .. _`ONAP Home Page`: https://www.onap.org
98 .. _`ONAP Wiki Page`: https://wiki.onap.org
99 .. _`ONAP Documentation`: https://docs.onap.org
100 .. _`ONAP Release Downloads`: https://git.onap.org
103 - `OOF project page`_
104 - `Passing Badge information for OOF`_
109 :Release Date: 2019-09-30 (El Alto Release)
111 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
119 No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
120 Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
122 * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
124 * Platform Maturity Level 1
125 * ~56.2%+ unit test coverage
130 The El Alto release for OOF fixed the following Bugs.
132 * [OPTFRA-579] Json error in homing solution
133 * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
134 * [OPTFRA-409] Template example : purpose to be explained
141 *Fixed Security Issues*
143 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
144 This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
146 *Known Security Issues*
148 *Known Vulnerabilities in Used Modules*
153 **Deprecation Notes**
162 :Release Date: 2019-06-06 (Dublin Release)
166 A summary of features includes:
168 * Extend OOF to support traffic distribution optimization
169 * Implement encryption for HAS internal and external communication
171 * Platform Maturity Level 1
172 * ~56.2%+ unit test coverage
174 The Dublin release for OOF delivered the following Epics.
176 * [OPTFRA-424] Extend OOF to support traffic distribution optimization
177 * [OPTFRA-422] Move OOF projects' CSIT to run on OOM
178 * [OPTFRA-270] This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
181 * OPTFRA-515 Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
182 * OPTFRA-513 OOF-HAS pods fail to come up in ONAP deployment
183 * OPTFRA-492 HAS API pod failure
184 * OPTFRA-487 OOF HAS CSIT failing with HTTPS changes
185 * OPTFRA-475 Remove Casablanca jobs in preparation for Dublin branch
186 * OPTFRA-467 Remove aai simulator code from HAS solver
187 * OPTFRA-465 Fix data code smells
188 * OPTFRA-461 Enable HTTPS and TLS for HAS API
189 * OPTFRA-452 Remove misleading reservation logic
190 * OPTFRA-449 Create OOM based CSIT for HAS
191 * OPTFRA-448 Multiple Sonar Issues
192 * OPTFRA-445 Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
193 * OPTFRA-444 Implement Distribute Traffic API exposure in HAS
194 * OPTFRA-412 Got 'NoneType' error when there's no flavor info inside vim
195 * OPTFRA-411 latency_country_rules_loader.py - Remove the unused local variable "ctx".
196 * OPTFRA-302 Enhance coverage of existing HAS code to 55%
201 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
203 * OPTFRA-494 HAS request 'limit' argument is ignored.
207 *Fixed Security Issues*
209 *Known Security Issues*
211 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
213 *Known Vulnerabilities in Used Modules*
215 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
218 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
219 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
220 - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
222 To upgrade, run docker container or install from source, See Distribution page
224 **Deprecation Notes**
225 No features deprecated in this release
234 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
236 The following items were deployed with the Casablanca Maintenance Release:
245 * [OPTFRA-401] - Need flavor id while launching vm.
252 :Release Date: 2018-11-30 (R3 Casablanca Release)
256 A summary of features includes:
258 * Security enhancements, including integration with AAF to implement access controls on
259 OSDF and HAS northbound interfaces
260 * Integration with SMS
261 * Platform Maturity Level 1
262 * ~50%+ unit test coverage
263 * Hardware Platform Awareness Enhancements
264 1) Added support for SRIOV-NIC and directives to assist the orchestrator
265 2) Select the best candidate across all cloud region based on HPA score.
266 3) HPA metrics using prometheus
268 The Casablanca release for OOF delivered the following Epics.
270 * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
271 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
272 * OPTFRA-267 - OOF - HPA Enhancements
273 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
274 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
275 * OPTFRA-271 - This epic spans the work to progress further from the current security level
276 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
277 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
278 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
279 * OPTFRA-275 - This epic spans the stories to improve deployability of services
280 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
281 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
285 * OPTFRA-205 - Generated conductor.conf missing configurations
286 * OPTFRA-210 - Onboarding to Music error
287 * OPTFRA-211 - Error solution for HPA
288 * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
289 * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
290 * OPTFRA-264 - oof-has-zookeeper image pull error
291 * OPTFRA-305 - Analyze OOM health check failure
292 * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
293 * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
294 * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
295 * OPTFRA-325 - spelling mistake
296 * OPTFRA-326 - hyperlink links are missing
297 * OPTFRA-335 - Making flavors an optional field in HAS candidate object
298 * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
299 * OPTFRA-338 - Create authentication key for OOF-VFC integration
300 * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
301 * OPTFRA-344 - Fix broken HPA CSIT test
302 * OPTFRA-354 - Generalize the logic to process Optimization policy
303 * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
304 * OPTFRA-359 - Create index on plans table for HAS
305 * OPTFRA-362 - AAF Authentication CSIT issues
306 * OPTFRA-365 - Fix Jenkins jobs for CMSO
307 * OPTFRA-366 - HAS CSIT issues
308 * OPTFRA-370 - Update the version of the OSDF and HAS images
309 * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
310 * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
311 * OPTFRA-384 - Generate and Validate Policy for vFW testing
312 * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
313 * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
314 * OPTFRA-395 - CMSO - Fix security violations and increment version
319 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
321 * OPTFRA-401 - Need flavor id while launching vm
322 * OPTFRA-398 - Add documentation for OOF-VFC interaction
323 * OPTFRA-393 - CMSO Implement code coverage
324 * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
325 * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
326 * OPTFRA-337 - Document new transitions in HAS states
327 * OPTFRA-331 - Role-based access controls to OOF
328 * OPTFRA-329 - role based access control for OSDF-Policy interface
329 * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
330 * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
331 * OPTFRA-304 - Code cleaning
332 * OPTFRA-300 - Fix Heat deployment scripts for OOF
333 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
334 * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
335 * OPTFRA-296 - Support SON (PCI) optimization using OSDF
336 * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
337 * OPTFRA-292 - Implement encryption for all HAS internal and external communication
338 * OPTFRA-279 - Policy-based capacity check enhancements
339 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
340 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
341 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
342 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
343 * OPTFRA-271 - This epic spans the work to progress further from the current security level
344 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
345 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
346 * OPTFRA-268 - OOF - project specific enhancements
347 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
348 * OPTFRA-262 - ReadTheDoc - update for R3
349 * OPTFRA-260 - Testing vCPE flows with multiple clouds
350 * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
351 * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
355 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
358 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
360 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
363 To upgrade, run docker container or install from source, See Distribution page
365 **Deprecation Notes**
366 No features deprecated in this release
374 :Release Date: 2018-06-07 (Beijing Release)
378 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
380 * Baseline HAS functionality
381 * support for VCPE use case
382 * support for HPA (Hardware Platform Awareness)
383 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
384 * Platform Maturity Level 1
385 * ~50%+ unit test coverage
387 The Beijing release for OOF delivered the following Epics.
389 * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
391 * [OPTFRA-6] - Integrate OOF with other ONAP components
393 * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
395 * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
397 * [OPTFRA-21] - OOF Packaging
399 * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
401 * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
403 * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
405 * [OPTFRA-33] - OOF Support for HPA
407 * [OPTFRA-105] - All Documentation Related User Stories and Tasks
412 None. Initial release R2 Beijing. No previous versions
416 * [OPTFRA-179] - Error solution for HPA
418 * [OPTFRA-205] - Onboarding to Music error
420 * [OPTFRA-210] - Generated conductor.conf missing configurations
422 * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
427 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
430 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
432 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
435 None. Initial release R2 Beijing. No previous versions
437 **Deprecation Notes**
438 None. Initial release R2 Beijing. No previous versions