2 This work is licensed under a Creative Commons Attribution 4.0
12 .. ===========================
13 .. * * * JAKARTA * * *
14 .. ===========================
19 This document provides the release notes for the JAKARTA release.
29 +--------------------------------------+--------------------------------------+
32 +--------------------------------------+--------------------------------------+
33 | **Docker images** | optf-has 2.3.0 |
36 +--------------------------------------+--------------------------------------+
37 | **Release designation** | 10.0.0 jakarta |
39 +--------------------------------------+--------------------------------------+
40 | **Release date** | 02/06/2022 (TBD) |
42 +--------------------------------------+--------------------------------------+
48 - Enhancements to support capacity based NSI/NSSI Selection for the Slicing usecase
54 OPTFRA-1064 - Fix bug in fetching capacity attributes from DCAE
57 Known Limitations, Issues and Workarounds
58 =========================================
80 For more information on the ONAP Jakarta release, please see:
83 #. `ONAP Documentation`_
84 #. `ONAP Release Downloads`_
88 .. _`ONAP Home Page`: https://www.onap.org
89 .. _`ONAP Wiki Page`: https://wiki.onap.org
90 .. _`ONAP Documentation`: https://docs.onap.org
91 .. _`ONAP Release Downloads`: https://git.onap.org
94 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
95 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
98 .. ===========================
99 .. * * * ISTANBUL * * *
100 .. ===========================
105 This document provides the release notes for the Istanbul release.
115 +--------------------------------------+--------------------------------------+
116 | **OOF Project** | |
118 +--------------------------------------+--------------------------------------+
119 | **Docker images** | - optf-has 2.2.1 |
121 +--------------------------------------+--------------------------------------+
122 | **Release designation** | 9.0.0 istanbul |
124 +--------------------------------------+--------------------------------------+
125 | **Release date** | 28/10/2021 (TBD) |
127 +--------------------------------------+--------------------------------------+
133 - Migration from MUSIC to ETCD for backend DB
138 - OPTFRA-968 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
139 - OPTFRA-853 Remove unwanted gplv3 components from docker image
140 - OPTFRA-971 Fix issues in OOF-CPS interface
142 Known Limitations, Issues and Workarounds
143 =========================================
149 Known Vulnerabilities
150 ---------------------
164 For more information on the ONAP Honolulu release, please see:
167 #. `ONAP Documentation`_
168 #. `ONAP Release Downloads`_
172 .. _`ONAP Home Page`: https://www.onap.org
173 .. _`ONAP Wiki Page`: https://wiki.onap.org
174 .. _`ONAP Documentation`: https://docs.onap.org
175 .. _`ONAP Release Downloads`: https://git.onap.org
178 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
179 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
182 .. ===========================
183 .. * * * HONOLULU * * *
184 .. ===========================
189 This document provides the release notes for the Honolulu release.
199 +--------------------------------------+--------------------------------------+
200 | **OOF Project** | |
202 +--------------------------------------+--------------------------------------+
203 | **Docker images** | - optf-has 2.1.4 |
205 +--------------------------------------+--------------------------------------+
206 | **Release designation** | 8.0.0 honolulu |
208 +--------------------------------------+--------------------------------------+
209 | **Release date** | 04/08/2021 (TBD) |
211 +--------------------------------------+--------------------------------------+
217 - Support for NST selection feature with AAI and SDC interface
218 - Enhancement in Slice profile generation - Deriving TA list from coverage Area
223 - OPTFRA-907 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
224 - OPTFRA-924 Replace pycryptodome with pycrytodomex, since it is not well maintained
226 Known Limitations, Issues and Workarounds
227 =========================================
233 Known Vulnerabilities
234 ---------------------
248 For more information on the ONAP Honolulu release, please see:
251 #. `ONAP Documentation`_
252 #. `ONAP Release Downloads`_
256 .. _`ONAP Home Page`: https://www.onap.org
257 .. _`ONAP Wiki Page`: https://wiki.onap.org
258 .. _`ONAP Documentation`: https://docs.onap.org
259 .. _`ONAP Release Downloads`: https://git.onap.org
262 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
263 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
266 .. ===========================
267 .. * * * GUILIN * * *
268 .. ===========================
273 This document provides the release notes for the Guilin release.
283 +--------------------------------------+--------------------------------------+
284 | **OOF Project** | |
286 +--------------------------------------+--------------------------------------+
287 | **Docker images** | - optf-has 2.1.2 |
289 +--------------------------------------+--------------------------------------+
290 | **Release designation** | 7.0.0 guilin |
292 +--------------------------------------+--------------------------------------+
293 | **Release date** | 2020-11-19 (TBD) |
295 +--------------------------------------+--------------------------------------+
301 - Support for Generic objective functions
302 - Candidate schema refactoring
303 - New candidate types - NSI, Slice profiles
304 - Functionality added in AAI plugin to support NSI candidates
309 - OPTFRA-854 HAS to support multiple inventory provider for a demand
310 - OPTFRA-839 Remove python 2.7 from HAS docker image
312 Known Limitations, Issues and Workarounds
313 =========================================
319 Known Vulnerabilities
320 ---------------------
334 For more information on the ONAP Guilin release, please see:
337 #. `ONAP Documentation`_
338 #. `ONAP Release Downloads`_
342 .. _`ONAP Home Page`: https://www.onap.org
343 .. _`ONAP Wiki Page`: https://wiki.onap.org
344 .. _`ONAP Documentation`: https://docs.onap.org
345 .. _`ONAP Release Downloads`: https://git.onap.org
348 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
349 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
352 .. ===========================
353 .. * * * FRANKFURT * * *
354 .. ===========================
359 This document provides the release notes for the Frankfurt release.
369 +--------------------------------------+--------------------------------------+
370 | **OOF Project** | |
372 +--------------------------------------+--------------------------------------+
373 | **Docker images** | - optf-has 2.0.4 |
375 +--------------------------------------+--------------------------------------+
376 | **Release designation** | 6.0.0 frankfurt |
378 +--------------------------------------+--------------------------------------+
379 | **Release date** | 2020-05-07 (TBD) |
381 +--------------------------------------+--------------------------------------+
387 - Passthrough attributes has been added to placement request.
388 - HAS container to run as non-root user.
389 - HAS Component has be upgraded to Python 3.8.
390 - New inventory type NSSI is added.
391 - Functionality has been added to AAI plugin to get the nssi candidates
393 - New constraint named ``threshold`` has been added to the solver.
398 - OPTFRA-734 Nginx failing to start as non-root user.
399 - OPTFRA-733 AAF authentication fails while handling API requests.
400 - OPTFRA-746 Add NSI id to NSSI candidate.
401 - OPTFRA-747 Music api not using server url in https mode.
402 - OPTFRA-728 HPA CSIT test failures.
403 - OPTFRA-726 Nginx needs to run as root.
404 - OPTFRA-630 Sonar failing jobs.
406 Known Limitations, Issues and Workarounds
407 =========================================
413 Known Vulnerabilities
414 ---------------------
424 **Fixed Security issues**
426 All HAS containers were running as root user which is fixed in this
427 release under OPTFRA-711.
432 For more information on the ONAP Frankfurt release, please see:
435 #. `ONAP Documentation`_
436 #. `ONAP Release Downloads`_
440 .. _`ONAP Home Page`: https://www.onap.org
441 .. _`ONAP Wiki Page`: https://wiki.onap.org
442 .. _`ONAP Documentation`: https://docs.onap.org
443 .. _`ONAP Release Downloads`: https://git.onap.org
446 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
447 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
452 :Release Date: 2019-09-30 (El Alto Release)
454 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
462 No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
463 Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
465 * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
467 * Platform Maturity Level 1
468 * ~56.2%+ unit test coverage
473 The El Alto release for OOF fixed the following Bugs.
475 * [OPTFRA-579] Json error in homing solution
476 * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
477 * [OPTFRA-409] Template example : purpose to be explained
484 *Fixed Security Issues*
486 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
487 This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
489 *Known Security Issues*
491 *Known Vulnerabilities in Used Modules*
496 **Deprecation Notes**
505 :Release Date: 2019-06-06 (Dublin Release)
509 A summary of features includes:
511 * Extend OOF to support traffic distribution optimization
512 * Implement encryption for HAS internal and external communication
514 * Platform Maturity Level 1
515 * ~56.2%+ unit test coverage
517 The Dublin release for OOF delivered the following Epics.
519 * [OPTFRA-424] Extend OOF to support traffic distribution optimization
520 * [OPTFRA-422] Move OOF projects' CSIT to run on OOM
521 * [OPTFRA-270] This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
524 * OPTFRA-515 Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
525 * OPTFRA-513 OOF-HAS pods fail to come up in ONAP deployment
526 * OPTFRA-492 HAS API pod failure
527 * OPTFRA-487 OOF HAS CSIT failing with HTTPS changes
528 * OPTFRA-475 Remove Casablanca jobs in preparation for Dublin branch
529 * OPTFRA-467 Remove aai simulator code from HAS solver
530 * OPTFRA-465 Fix data code smells
531 * OPTFRA-461 Enable HTTPS and TLS for HAS API
532 * OPTFRA-452 Remove misleading reservation logic
533 * OPTFRA-449 Create OOM based CSIT for HAS
534 * OPTFRA-448 Multiple Sonar Issues
535 * OPTFRA-445 Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
536 * OPTFRA-444 Implement Distribute Traffic API exposure in HAS
537 * OPTFRA-412 Got 'NoneType' error when there's no flavor info inside vim
538 * OPTFRA-411 latency_country_rules_loader.py - Remove the unused local variable "ctx".
539 * OPTFRA-302 Enhance coverage of existing HAS code to 55%
544 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
546 * OPTFRA-494 HAS request 'limit' argument is ignored.
550 *Fixed Security Issues*
552 *Known Security Issues*
554 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
556 *Known Vulnerabilities in Used Modules*
558 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>`_.
561 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
562 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
563 - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
565 To upgrade, run docker container or install from source, See Distribution page
567 **Deprecation Notes**
568 No features deprecated in this release
577 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
579 The following items were deployed with the Casablanca Maintenance Release:
588 * [OPTFRA-401] - Need flavor id while launching vm.
595 :Release Date: 2018-11-30 (R3 Casablanca Release)
599 A summary of features includes:
601 * Security enhancements, including integration with AAF to implement access controls on
602 OSDF and HAS northbound interfaces
603 * Integration with SMS
604 * Platform Maturity Level 1
605 * ~50%+ unit test coverage
606 * Hardware Platform Awareness Enhancements
607 1) Added support for SRIOV-NIC and directives to assist the orchestrator
608 2) Select the best candidate across all cloud region based on HPA score.
609 3) HPA metrics using prometheus
611 The Casablanca release for OOF delivered the following Epics.
613 * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
614 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
615 * OPTFRA-267 - OOF - HPA Enhancements
616 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
617 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
618 * OPTFRA-271 - This epic spans the work to progress further from the current security level
619 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
620 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
621 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
622 * OPTFRA-275 - This epic spans the stories to improve deployability of services
623 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
624 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
628 * OPTFRA-205 - Generated conductor.conf missing configurations
629 * OPTFRA-210 - Onboarding to Music error
630 * OPTFRA-211 - Error solution for HPA
631 * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
632 * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
633 * OPTFRA-264 - oof-has-zookeeper image pull error
634 * OPTFRA-305 - Analyze OOM health check failure
635 * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
636 * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
637 * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
638 * OPTFRA-325 - spelling mistake
639 * OPTFRA-326 - hyperlink links are missing
640 * OPTFRA-335 - Making flavors an optional field in HAS candidate object
641 * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
642 * OPTFRA-338 - Create authentication key for OOF-VFC integration
643 * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
644 * OPTFRA-344 - Fix broken HPA CSIT test
645 * OPTFRA-354 - Generalize the logic to process Optimization policy
646 * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
647 * OPTFRA-359 - Create index on plans table for HAS
648 * OPTFRA-362 - AAF Authentication CSIT issues
649 * OPTFRA-365 - Fix Jenkins jobs for CMSO
650 * OPTFRA-366 - HAS CSIT issues
651 * OPTFRA-370 - Update the version of the OSDF and HAS images
652 * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
653 * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
654 * OPTFRA-384 - Generate and Validate Policy for vFW testing
655 * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
656 * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
657 * OPTFRA-395 - CMSO - Fix security violations and increment version
662 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
664 * OPTFRA-401 - Need flavor id while launching vm
665 * OPTFRA-398 - Add documentation for OOF-VFC interaction
666 * OPTFRA-393 - CMSO Implement code coverage
667 * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
668 * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
669 * OPTFRA-337 - Document new transitions in HAS states
670 * OPTFRA-331 - Role-based access controls to OOF
671 * OPTFRA-329 - role based access control for OSDF-Policy interface
672 * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
673 * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
674 * OPTFRA-304 - Code cleaning
675 * OPTFRA-300 - Fix Heat deployment scripts for OOF
676 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
677 * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
678 * OPTFRA-296 - Support SON (PCI) optimization using OSDF
679 * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
680 * OPTFRA-292 - Implement encryption for all HAS internal and external communication
681 * OPTFRA-279 - Policy-based capacity check enhancements
682 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
683 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
684 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
685 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
686 * OPTFRA-271 - This epic spans the work to progress further from the current security level
687 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
688 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
689 * OPTFRA-268 - OOF - project specific enhancements
690 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
691 * OPTFRA-262 - ReadTheDoc - update for R3
692 * OPTFRA-260 - Testing vCPE flows with multiple clouds
693 * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
694 * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
698 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
701 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
703 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
706 To upgrade, run docker container or install from source, See Distribution page
708 **Deprecation Notes**
709 No features deprecated in this release
717 :Release Date: 2018-06-07 (Beijing Release)
721 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
723 * Baseline HAS functionality
724 * support for VCPE use case
725 * support for HPA (Hardware Platform Awareness)
726 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
727 * Platform Maturity Level 1
728 * ~50%+ unit test coverage
730 The Beijing release for OOF delivered the following Epics.
732 * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
734 * [OPTFRA-6] - Integrate OOF with other ONAP components
736 * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
738 * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
740 * [OPTFRA-21] - OOF Packaging
742 * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
744 * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
746 * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
748 * [OPTFRA-33] - OOF Support for HPA
750 * [OPTFRA-105] - All Documentation Related User Stories and Tasks
755 None. Initial release R2 Beijing. No previous versions
759 * [OPTFRA-179] - Error solution for HPA
761 * [OPTFRA-205] - Onboarding to Music error
763 * [OPTFRA-210] - Generated conductor.conf missing configurations
765 * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
770 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
773 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
775 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
778 None. Initial release R2 Beijing. No previous versions
780 **Deprecation Notes**
781 None. Initial release R2 Beijing. No previous versions