2 This work is licensed under a Creative Commons Attribution 4.0
9 .. ===========================
10 .. * * * ISTANBUL * * *
11 .. ===========================
16 This document provides the release notes for the Istanbul release.
26 +--------------------------------------+--------------------------------------+
29 +--------------------------------------+--------------------------------------+
30 | **Docker images** | - optf-has 2.2.1 |
32 +--------------------------------------+--------------------------------------+
33 | **Release designation** | 8.0.0 istanbul |
35 +--------------------------------------+--------------------------------------+
36 | **Release date** | 28/10/2021 (TBD) |
38 +--------------------------------------+--------------------------------------+
44 - Migration from MUSIC to ETCD for backend DB
49 - OPTFRA-968 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
50 - OPTFRA-853 Remove unwanted gplv3 components from docker image
51 - OPTFRA-971 Fix issues in OOF-CPS interface
53 Known Limitations, Issues and Workarounds
54 =========================================
75 For more information on the ONAP Honolulu release, please see:
78 #. `ONAP Documentation`_
79 #. `ONAP Release Downloads`_
83 .. _`ONAP Home Page`: https://www.onap.org
84 .. _`ONAP Wiki Page`: https://wiki.onap.org
85 .. _`ONAP Documentation`: https://docs.onap.org
86 .. _`ONAP Release Downloads`: https://git.onap.org
89 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
90 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
93 .. ===========================
94 .. * * * HONOLULU * * *
95 .. ===========================
100 This document provides the release notes for the Honolulu release.
110 +--------------------------------------+--------------------------------------+
111 | **OOF Project** | |
113 +--------------------------------------+--------------------------------------+
114 | **Docker images** | - optf-has 2.1.4 |
116 +--------------------------------------+--------------------------------------+
117 | **Release designation** | 8.0.0 honolulu |
119 +--------------------------------------+--------------------------------------+
120 | **Release date** | 04/08/2021 (TBD) |
122 +--------------------------------------+--------------------------------------+
128 - Support for NST selection feature with AAI and SDC interface
129 - Enhancement in Slice profile generation - Deriving TA list from coverage Area
134 - OPTFRA-907 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
135 - OPTFRA-924 Replace pycryptodome with pycrytodomex, since it is not well maintained
137 Known Limitations, Issues and Workarounds
138 =========================================
144 Known Vulnerabilities
145 ---------------------
159 For more information on the ONAP Honolulu release, please see:
162 #. `ONAP Documentation`_
163 #. `ONAP Release Downloads`_
167 .. _`ONAP Home Page`: https://www.onap.org
168 .. _`ONAP Wiki Page`: https://wiki.onap.org
169 .. _`ONAP Documentation`: https://docs.onap.org
170 .. _`ONAP Release Downloads`: https://git.onap.org
173 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
174 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
177 .. ===========================
178 .. * * * GUILIN * * *
179 .. ===========================
184 This document provides the release notes for the Guilin release.
194 +--------------------------------------+--------------------------------------+
195 | **OOF Project** | |
197 +--------------------------------------+--------------------------------------+
198 | **Docker images** | - optf-has 2.1.2 |
200 +--------------------------------------+--------------------------------------+
201 | **Release designation** | 7.0.0 guilin |
203 +--------------------------------------+--------------------------------------+
204 | **Release date** | 2020-11-19 (TBD) |
206 +--------------------------------------+--------------------------------------+
212 - Support for Generic objective functions
213 - Candidate schema refactoring
214 - New candidate types - NSI, Slice profiles
215 - Functionality added in AAI plugin to support NSI candidates
220 - OPTFRA-854 HAS to support multiple inventory provider for a demand
221 - OPTFRA-839 Remove python 2.7 from HAS docker image
223 Known Limitations, Issues and Workarounds
224 =========================================
230 Known Vulnerabilities
231 ---------------------
245 For more information on the ONAP Guilin release, please see:
248 #. `ONAP Documentation`_
249 #. `ONAP Release Downloads`_
253 .. _`ONAP Home Page`: https://www.onap.org
254 .. _`ONAP Wiki Page`: https://wiki.onap.org
255 .. _`ONAP Documentation`: https://docs.onap.org
256 .. _`ONAP Release Downloads`: https://git.onap.org
259 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
260 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
263 .. ===========================
264 .. * * * FRANKFURT * * *
265 .. ===========================
270 This document provides the release notes for the Frankfurt release.
280 +--------------------------------------+--------------------------------------+
281 | **OOF Project** | |
283 +--------------------------------------+--------------------------------------+
284 | **Docker images** | - optf-has 2.0.4 |
286 +--------------------------------------+--------------------------------------+
287 | **Release designation** | 6.0.0 frankfurt |
289 +--------------------------------------+--------------------------------------+
290 | **Release date** | 2020-05-07 (TBD) |
292 +--------------------------------------+--------------------------------------+
298 - Passthrough attributes has been added to placement request.
299 - HAS container to run as non-root user.
300 - HAS Component has be upgraded to Python 3.8.
301 - New inventory type NSSI is added.
302 - Functionality has been added to AAI plugin to get the nssi candidates
304 - New constraint named ``threshold`` has been added to the solver.
309 - OPTFRA-734 Nginx failing to start as non-root user.
310 - OPTFRA-733 AAF authentication fails while handling API requests.
311 - OPTFRA-746 Add NSI id to NSSI candidate.
312 - OPTFRA-747 Music api not using server url in https mode.
313 - OPTFRA-728 HPA CSIT test failures.
314 - OPTFRA-726 Nginx needs to run as root.
315 - OPTFRA-630 Sonar failing jobs.
317 Known Limitations, Issues and Workarounds
318 =========================================
324 Known Vulnerabilities
325 ---------------------
335 **Fixed Security issues**
337 All HAS containers were running as root user which is fixed in this
338 release under OPTFRA-711.
343 For more information on the ONAP Frankfurt release, please see:
346 #. `ONAP Documentation`_
347 #. `ONAP Release Downloads`_
351 .. _`ONAP Home Page`: https://www.onap.org
352 .. _`ONAP Wiki Page`: https://wiki.onap.org
353 .. _`ONAP Documentation`: https://docs.onap.org
354 .. _`ONAP Release Downloads`: https://git.onap.org
357 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
358 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
363 :Release Date: 2019-09-30 (El Alto Release)
365 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
373 No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
374 Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
376 * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
378 * Platform Maturity Level 1
379 * ~56.2%+ unit test coverage
384 The El Alto release for OOF fixed the following Bugs.
386 * [OPTFRA-579] Json error in homing solution
387 * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
388 * [OPTFRA-409] Template example : purpose to be explained
395 *Fixed Security Issues*
397 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
398 This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
400 *Known Security Issues*
402 *Known Vulnerabilities in Used Modules*
407 **Deprecation Notes**
416 :Release Date: 2019-06-06 (Dublin Release)
420 A summary of features includes:
422 * Extend OOF to support traffic distribution optimization
423 * Implement encryption for HAS internal and external communication
425 * Platform Maturity Level 1
426 * ~56.2%+ unit test coverage
428 The Dublin release for OOF delivered the following Epics.
430 * [OPTFRA-424] Extend OOF to support traffic distribution optimization
431 * [OPTFRA-422] Move OOF projects' CSIT to run on OOM
432 * [OPTFRA-270] This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
435 * OPTFRA-515 Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
436 * OPTFRA-513 OOF-HAS pods fail to come up in ONAP deployment
437 * OPTFRA-492 HAS API pod failure
438 * OPTFRA-487 OOF HAS CSIT failing with HTTPS changes
439 * OPTFRA-475 Remove Casablanca jobs in preparation for Dublin branch
440 * OPTFRA-467 Remove aai simulator code from HAS solver
441 * OPTFRA-465 Fix data code smells
442 * OPTFRA-461 Enable HTTPS and TLS for HAS API
443 * OPTFRA-452 Remove misleading reservation logic
444 * OPTFRA-449 Create OOM based CSIT for HAS
445 * OPTFRA-448 Multiple Sonar Issues
446 * OPTFRA-445 Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
447 * OPTFRA-444 Implement Distribute Traffic API exposure in HAS
448 * OPTFRA-412 Got 'NoneType' error when there's no flavor info inside vim
449 * OPTFRA-411 latency_country_rules_loader.py - Remove the unused local variable "ctx".
450 * OPTFRA-302 Enhance coverage of existing HAS code to 55%
455 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
457 * OPTFRA-494 HAS request 'limit' argument is ignored.
461 *Fixed Security Issues*
463 *Known Security Issues*
465 * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
467 *Known Vulnerabilities in Used Modules*
469 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>`_.
472 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
473 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
474 - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
476 To upgrade, run docker container or install from source, See Distribution page
478 **Deprecation Notes**
479 No features deprecated in this release
488 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
490 The following items were deployed with the Casablanca Maintenance Release:
499 * [OPTFRA-401] - Need flavor id while launching vm.
506 :Release Date: 2018-11-30 (R3 Casablanca Release)
510 A summary of features includes:
512 * Security enhancements, including integration with AAF to implement access controls on
513 OSDF and HAS northbound interfaces
514 * Integration with SMS
515 * Platform Maturity Level 1
516 * ~50%+ unit test coverage
517 * Hardware Platform Awareness Enhancements
518 1) Added support for SRIOV-NIC and directives to assist the orchestrator
519 2) Select the best candidate across all cloud region based on HPA score.
520 3) HPA metrics using prometheus
522 The Casablanca release for OOF delivered the following Epics.
524 * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
525 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
526 * OPTFRA-267 - OOF - HPA Enhancements
527 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
528 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
529 * OPTFRA-271 - This epic spans the work to progress further from the current security level
530 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
531 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
532 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
533 * OPTFRA-275 - This epic spans the stories to improve deployability of services
534 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
535 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
539 * OPTFRA-205 - Generated conductor.conf missing configurations
540 * OPTFRA-210 - Onboarding to Music error
541 * OPTFRA-211 - Error solution for HPA
542 * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
543 * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
544 * OPTFRA-264 - oof-has-zookeeper image pull error
545 * OPTFRA-305 - Analyze OOM health check failure
546 * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
547 * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
548 * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
549 * OPTFRA-325 - spelling mistake
550 * OPTFRA-326 - hyperlink links are missing
551 * OPTFRA-335 - Making flavors an optional field in HAS candidate object
552 * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
553 * OPTFRA-338 - Create authentication key for OOF-VFC integration
554 * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
555 * OPTFRA-344 - Fix broken HPA CSIT test
556 * OPTFRA-354 - Generalize the logic to process Optimization policy
557 * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
558 * OPTFRA-359 - Create index on plans table for HAS
559 * OPTFRA-362 - AAF Authentication CSIT issues
560 * OPTFRA-365 - Fix Jenkins jobs for CMSO
561 * OPTFRA-366 - HAS CSIT issues
562 * OPTFRA-370 - Update the version of the OSDF and HAS images
563 * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
564 * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
565 * OPTFRA-384 - Generate and Validate Policy for vFW testing
566 * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
567 * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
568 * OPTFRA-395 - CMSO - Fix security violations and increment version
573 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
575 * OPTFRA-401 - Need flavor id while launching vm
576 * OPTFRA-398 - Add documentation for OOF-VFC interaction
577 * OPTFRA-393 - CMSO Implement code coverage
578 * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
579 * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
580 * OPTFRA-337 - Document new transitions in HAS states
581 * OPTFRA-331 - Role-based access controls to OOF
582 * OPTFRA-329 - role based access control for OSDF-Policy interface
583 * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
584 * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
585 * OPTFRA-304 - Code cleaning
586 * OPTFRA-300 - Fix Heat deployment scripts for OOF
587 * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
588 * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
589 * OPTFRA-296 - Support SON (PCI) optimization using OSDF
590 * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
591 * OPTFRA-292 - Implement encryption for all HAS internal and external communication
592 * OPTFRA-279 - Policy-based capacity check enhancements
593 * OPTFRA-276 - Implementing a POC for 5G SON Optimization
594 * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
595 * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
596 * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
597 * OPTFRA-271 - This epic spans the work to progress further from the current security level
598 * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
599 * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
600 * OPTFRA-268 - OOF - project specific enhancements
601 * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
602 * OPTFRA-262 - ReadTheDoc - update for R3
603 * OPTFRA-260 - Testing vCPE flows with multiple clouds
604 * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
605 * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
609 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
612 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
614 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
617 To upgrade, run docker container or install from source, See Distribution page
619 **Deprecation Notes**
620 No features deprecated in this release
628 :Release Date: 2018-06-07 (Beijing Release)
632 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
634 * Baseline HAS functionality
635 * support for VCPE use case
636 * support for HPA (Hardware Platform Awareness)
637 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
638 * Platform Maturity Level 1
639 * ~50%+ unit test coverage
641 The Beijing release for OOF delivered the following Epics.
643 * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
645 * [OPTFRA-6] - Integrate OOF with other ONAP components
647 * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
649 * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
651 * [OPTFRA-21] - OOF Packaging
653 * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
655 * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
657 * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
659 * [OPTFRA-33] - OOF Support for HPA
661 * [OPTFRA-105] - All Documentation Related User Stories and Tasks
666 None. Initial release R2 Beijing. No previous versions
670 * [OPTFRA-179] - Error solution for HPA
672 * [OPTFRA-205] - Onboarding to Music error
674 * [OPTFRA-210] - Generated conductor.conf missing configurations
676 * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
681 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
684 - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
686 - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
689 None. Initial release R2 Beijing. No previous versions
691 **Deprecation Notes**
692 None. Initial release R2 Beijing. No previous versions