2 This work is licensed under a Creative Commons Attribution 4.0
11 .. ===========================
12 .. * * * JAKARTA * * *
13 .. ===========================
18 This document provides the release notes for the JAKARTA release.
28 +--------------------------------------+--------------------------------------+
31 +--------------------------------------+--------------------------------------+
32 | **Docker images** | optf-has 2.3.0 |
35 +--------------------------------------+--------------------------------------+
36 | **Release designation** | 10.0.0 jakarta |
38 +--------------------------------------+--------------------------------------+
39 | **Release date** | 02/06/2022 (TBD) |
41 +--------------------------------------+--------------------------------------+
47 - Enhancements to support capacity based NSI/NSSI Selection for the Slicing usecase
53 OPTFRA-1064 - Fix bug in fetching capacity attributes from DCAE
56 Known Limitations, Issues and Workarounds
57 =========================================
79 For more information on the ONAP Jakarta release, please see:
82 #. `ONAP Documentation`_
83 #. `ONAP Release Downloads`_
87 .. _`ONAP Home Page`: https://www.onap.org
88 .. _`ONAP Wiki Page`: https://wiki.onap.org
89 .. _`ONAP Documentation`: https://docs.onap.org
90 .. _`ONAP Release Downloads`: https://git.onap.org
93 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
94 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
97 .. ===========================
98 .. * * * ISTANBUL * * *
99 .. ===========================
104 This document provides the release notes for the Istanbul release.
114 +--------------------------------------+--------------------------------------+
115 | **OOF Project** | |
117 +--------------------------------------+--------------------------------------+
118 | **Docker images** | - optf-has 2.2.1 |
120 +--------------------------------------+--------------------------------------+
121 | **Release designation** | 9.0.0 istanbul |
123 +--------------------------------------+--------------------------------------+
124 | **Release date** | 28/10/2021 (TBD) |
126 +--------------------------------------+--------------------------------------+
132 - Migration from MUSIC to ETCD for backend DB
137 - OPTFRA-968 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
138 - OPTFRA-853 Remove unwanted gplv3 components from docker image
139 - OPTFRA-971 Fix issues in OOF-CPS interface
141 Known Limitations, Issues and Workarounds
142 =========================================
148 Known Vulnerabilities
149 ---------------------
163 For more information on the ONAP Honolulu release, please see:
166 #. `ONAP Documentation`_
167 #. `ONAP Release Downloads`_
171 .. _`ONAP Home Page`: https://www.onap.org
172 .. _`ONAP Wiki Page`: https://wiki.onap.org
173 .. _`ONAP Documentation`: https://docs.onap.org
174 .. _`ONAP Release Downloads`: https://git.onap.org
177 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
178 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
181 .. ===========================
182 .. * * * HONOLULU * * *
183 .. ===========================
188 This document provides the release notes for the Honolulu release.
198 +--------------------------------------+--------------------------------------+
199 | **OOF Project** | |
201 +--------------------------------------+--------------------------------------+
202 | **Docker images** | - optf-has 2.1.4 |
204 +--------------------------------------+--------------------------------------+
205 | **Release designation** | 8.0.0 honolulu |
207 +--------------------------------------+--------------------------------------+
208 | **Release date** | 04/08/2021 (TBD) |
210 +--------------------------------------+--------------------------------------+
216 - Support for NST selection feature with AAI and SDC interface
217 - Enhancement in Slice profile generation - Deriving TA list from coverage Area
222 - OPTFRA-907 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
223 - OPTFRA-924 Replace pycryptodome with pycrytodomex, since it is not well maintained
225 Known Limitations, Issues and Workarounds
226 =========================================
232 Known Vulnerabilities
233 ---------------------
247 For more information on the ONAP Honolulu release, please see:
250 #. `ONAP Documentation`_
251 #. `ONAP Release Downloads`_
255 .. _`ONAP Home Page`: https://www.onap.org
256 .. _`ONAP Wiki Page`: https://wiki.onap.org
257 .. _`ONAP Documentation`: https://docs.onap.org
258 .. _`ONAP Release Downloads`: https://git.onap.org
261 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
262 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
265 .. ===========================
266 .. * * * GUILIN * * *
267 .. ===========================
272 This document provides the release notes for the Guilin release.
282 +--------------------------------------+--------------------------------------+
283 | **OOF Project** | |
285 +--------------------------------------+--------------------------------------+
286 | **Docker images** | - optf-has 2.1.2 |
288 +--------------------------------------+--------------------------------------+
289 | **Release designation** | 7.0.0 guilin |
291 +--------------------------------------+--------------------------------------+
292 | **Release date** | 2020-11-19 (TBD) |
294 +--------------------------------------+--------------------------------------+
300 - Support for Generic objective functions
301 - Candidate schema refactoring
302 - New candidate types - NSI, Slice profiles
303 - Functionality added in AAI plugin to support NSI candidates
308 - OPTFRA-854 HAS to support multiple inventory provider for a demand
309 - OPTFRA-839 Remove python 2.7 from HAS docker image
311 Known Limitations, Issues and Workarounds
312 =========================================
318 Known Vulnerabilities
319 ---------------------
333 For more information on the ONAP Guilin release, please see:
336 #. `ONAP Documentation`_
337 #. `ONAP Release Downloads`_
341 .. _`ONAP Home Page`: https://www.onap.org
342 .. _`ONAP Wiki Page`: https://wiki.onap.org
343 .. _`ONAP Documentation`: https://docs.onap.org
344 .. _`ONAP Release Downloads`: https://git.onap.org
347 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
348 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
351 .. ===========================
352 .. * * * FRANKFURT * * *
353 .. ===========================
358 This document provides the release notes for the Frankfurt release.
368 +--------------------------------------+--------------------------------------+
369 | **OOF Project** | |
371 +--------------------------------------+--------------------------------------+
372 | **Docker images** | - optf-has 2.0.4 |
374 +--------------------------------------+--------------------------------------+
375 | **Release designation** | 6.0.0 frankfurt |
377 +--------------------------------------+--------------------------------------+
378 | **Release date** | 2020-05-07 (TBD) |
380 +--------------------------------------+--------------------------------------+
386 - Passthrough attributes has been added to placement request.
387 - HAS container to run as non-root user.
388 - HAS Component has be upgraded to Python 3.8.
389 - New inventory type NSSI is added.
390 - Functionality has been added to AAI plugin to get the nssi candidates
392 - New constraint named ``threshold`` has been added to the solver.
397 - OPTFRA-734 Nginx failing to start as non-root user.
398 - OPTFRA-733 AAF authentication fails while handling API requests.
399 - OPTFRA-746 Add NSI id to NSSI candidate.
400 - OPTFRA-747 Music api not using server url in https mode.
401 - OPTFRA-728 HPA CSIT test failures.
402 - OPTFRA-726 Nginx needs to run as root.
403 - OPTFRA-630 Sonar failing jobs.
405 Known Limitations, Issues and Workarounds
406 =========================================
412 Known Vulnerabilities
413 ---------------------
423 **Fixed Security issues**
425 All HAS containers were running as root user which is fixed in this
426 release under OPTFRA-711.
431 For more information on the ONAP Frankfurt release, please see:
434 #. `ONAP Documentation`_
435 #. `ONAP Release Downloads`_
439 .. _`ONAP Home Page`: https://www.onap.org
440 .. _`ONAP Wiki Page`: https://wiki.onap.org
441 .. _`ONAP Documentation`: https://docs.onap.org
442 .. _`ONAP Release Downloads`: https://git.onap.org
445 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
446 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
451 :Release Date: 2019-09-30 (El Alto Release)
453 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
461 No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
462 Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
464 * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
466 * Platform Maturity Level 1
467 * ~56.2%+ unit test coverage
472 The El Alto release for OOF fixed the following Bugs.
474 * [OPTFRA-579] Json error in homing solution
475 * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
476 * [OPTFRA-409] Template example : purpose to be explained
483 *Fixed Security Issues*
485 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
486 This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
488 *Known Security Issues*
490 *Known Vulnerabilities in Used Modules*
495 **Deprecation Notes**
504 :Release Date: 2019-06-06 (Dublin Release)
508 A summary of features includes:
510 * Extend OOF to support traffic distribution optimization
511 * Implement encryption for HAS internal and external communication
513 * Platform Maturity Level 1
514 * ~56.2%+ unit test coverage
516 The Dublin release for OOF delivered the following Epics.
518 * [OPTFRA-424] Extend OOF to support traffic distribution optimization
519 * [OPTFRA-422] Move OOF projects' CSIT to run on OOM
520 * [OPTFRA-270] This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
523 * OPTFRA-515 Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
524 * OPTFRA-513 OOF-HAS pods fail to come up in ONAP deployment
525 * OPTFRA-492 HAS API pod failure
526 * OPTFRA-487 OOF HAS CSIT failing with HTTPS changes
527 * OPTFRA-475 Remove Casablanca jobs in preparation for Dublin branch
528 * OPTFRA-467 Remove aai simulator code from HAS solver
529 * OPTFRA-465 Fix data code smells
530 * OPTFRA-461 Enable HTTPS and TLS for HAS API
531 * OPTFRA-452 Remove misleading reservation logic
532 * OPTFRA-449 Create OOM based CSIT for HAS
533 * OPTFRA-448 Multiple Sonar Issues
534 * OPTFRA-445 Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
535 * OPTFRA-444 Implement Distribute Traffic API exposure in HAS
536 * OPTFRA-412 Got 'NoneType' error when there's no flavor info inside vim
537 * OPTFRA-411 latency_country_rules_loader.py - Remove the unused local variable "ctx".
538 * OPTFRA-302 Enhance coverage of existing HAS code to 55%
543 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
545 * OPTFRA-494 HAS request 'limit' argument is ignored.
549 *Fixed Security Issues*
551 *Known Security Issues*
553 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
555 *Known Vulnerabilities in Used Modules*
557 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>`_.
560 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
561 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
562 - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
564 To upgrade, run docker container or install from source, See Distribution page
566 **Deprecation Notes**
567 No features deprecated in this release
576 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
578 The following items were deployed with the Casablanca Maintenance Release:
587 * [OPTFRA-401] - Need flavor id while launching vm.
594 :Release Date: 2018-11-30 (R3 Casablanca Release)
598 A summary of features includes:
600 * Security enhancements, including integration with AAF to implement access controls on
601 OSDF and HAS northbound interfaces
602 * Integration with SMS
603 * Platform Maturity Level 1
604 * ~50%+ unit test coverage
605 * Hardware Platform Awareness Enhancements
606 1) Added support for SRIOV-NIC and directives to assist the orchestrator
607 2) Select the best candidate across all cloud region based on HPA score.
608 3) HPA metrics using prometheus
610 The Casablanca release for OOF delivered the following Epics.
612 * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
613 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
614 * OPTFRA-267 - OOF - HPA Enhancements
615 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
616 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
617 * OPTFRA-271 - This epic spans the work to progress further from the current security level
618 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
619 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
620 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
621 * OPTFRA-275 - This epic spans the stories to improve deployability of services
622 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
623 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
627 * OPTFRA-205 - Generated conductor.conf missing configurations
628 * OPTFRA-210 - Onboarding to Music error
629 * OPTFRA-211 - Error solution for HPA
630 * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
631 * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
632 * OPTFRA-264 - oof-has-zookeeper image pull error
633 * OPTFRA-305 - Analyze OOM health check failure
634 * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
635 * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
636 * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
637 * OPTFRA-325 - spelling mistake
638 * OPTFRA-326 - hyperlink links are missing
639 * OPTFRA-335 - Making flavors an optional field in HAS candidate object
640 * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
641 * OPTFRA-338 - Create authentication key for OOF-VFC integration
642 * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
643 * OPTFRA-344 - Fix broken HPA CSIT test
644 * OPTFRA-354 - Generalize the logic to process Optimization policy
645 * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
646 * OPTFRA-359 - Create index on plans table for HAS
647 * OPTFRA-362 - AAF Authentication CSIT issues
648 * OPTFRA-365 - Fix Jenkins jobs for CMSO
649 * OPTFRA-366 - HAS CSIT issues
650 * OPTFRA-370 - Update the version of the OSDF and HAS images
651 * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
652 * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
653 * OPTFRA-384 - Generate and Validate Policy for vFW testing
654 * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
655 * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
656 * OPTFRA-395 - CMSO - Fix security violations and increment version
661 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
663 * OPTFRA-401 - Need flavor id while launching vm
664 * OPTFRA-398 - Add documentation for OOF-VFC interaction
665 * OPTFRA-393 - CMSO Implement code coverage
666 * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
667 * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
668 * OPTFRA-337 - Document new transitions in HAS states
669 * OPTFRA-331 - Role-based access controls to OOF
670 * OPTFRA-329 - role based access control for OSDF-Policy interface
671 * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
672 * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
673 * OPTFRA-304 - Code cleaning
674 * OPTFRA-300 - Fix Heat deployment scripts for OOF
675 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
676 * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
677 * OPTFRA-296 - Support SON (PCI) optimization using OSDF
678 * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
679 * OPTFRA-292 - Implement encryption for all HAS internal and external communication
680 * OPTFRA-279 - Policy-based capacity check enhancements
681 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
682 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
683 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
684 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
685 * OPTFRA-271 - This epic spans the work to progress further from the current security level
686 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
687 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
688 * OPTFRA-268 - OOF - project specific enhancements
689 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
690 * OPTFRA-262 - ReadTheDoc - update for R3
691 * OPTFRA-260 - Testing vCPE flows with multiple clouds
692 * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
693 * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
697 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
700 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
702 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
705 To upgrade, run docker container or install from source, See Distribution page
707 **Deprecation Notes**
708 No features deprecated in this release
716 :Release Date: 2018-06-07 (Beijing Release)
720 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
722 * Baseline HAS functionality
723 * support for VCPE use case
724 * support for HPA (Hardware Platform Awareness)
725 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
726 * Platform Maturity Level 1
727 * ~50%+ unit test coverage
729 The Beijing release for OOF delivered the following Epics.
731 * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
733 * [OPTFRA-6] - Integrate OOF with other ONAP components
735 * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
737 * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
739 * [OPTFRA-21] - OOF Packaging
741 * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
743 * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
745 * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
747 * [OPTFRA-33] - OOF Support for HPA
749 * [OPTFRA-105] - All Documentation Related User Stories and Tasks
754 None. Initial release R2 Beijing. No previous versions
758 * [OPTFRA-179] - Error solution for HPA
760 * [OPTFRA-205] - Onboarding to Music error
762 * [OPTFRA-210] - Generated conductor.conf missing configurations
764 * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
769 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
772 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
774 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
777 None. Initial release R2 Beijing. No previous versions
779 **Deprecation Notes**
780 None. Initial release R2 Beijing. No previous versions