Add missing label in the Release Note file
[optf/has.git] / docs / sections / release-notes.rst
index cdfe4cc..19d9b88 100644 (file)
 ..
  This work is licensed under a Creative Commons Attribution 4.0
  International License.
+.. _release_notes:
 
 =============
 Release Notes
 =============
 
 
+
+..      ===========================
+..      * * *   JAKARTA  * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the JAKARTA release.
+
+Summary
+=======
+
+
+Release Data
+============
+
+
++--------------------------------------+--------------------------------------+
+| **OOF Project**                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    |   optf-has 2.3.0                     |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 10.0.0 jakarta                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 02/06/2022 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+- Enhancements to support capacity based NSI/NSSI Selection for the Slicing usecase
+
+
+Bug Fixes
+---------
+
+OPTFRA-1064 - Fix bug in fetching capacity attributes from DCAE
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+
+References
+==========
+
+For more information on the ONAP Jakarta release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+- `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+- `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+
+
+..      ===========================
+..      * * *    ISTANBUL    * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the Istanbul release.
+
+Summary
+=======
+
+
+Release Data
+============
+
+
++--------------------------------------+--------------------------------------+
+| **OOF Project**                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - optf-has 2.2.1                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 9.0.0 istanbul                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 28/10/2021 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+- Migration from MUSIC to ETCD for backend DB
+
+Bug Fixes
+=========
+
+- OPTFRA-968 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
+- OPTFRA-853 Remove unwanted gplv3 components from docker image
+- OPTFRA-971 Fix issues in OOF-CPS interface
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+
+References
+==========
+
+For more information on the ONAP Honolulu release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+
+
+..      ===========================
+..      * * *    HONOLULU    * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the Honolulu release.
+
+Summary
+=======
+
+
+Release Data
+============
+
+
++--------------------------------------+--------------------------------------+
+| **OOF Project**                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - optf-has 2.1.4                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 8.0.0 honolulu                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 04/08/2021 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+- Support for NST selection feature with AAI and SDC interface
+- Enhancement in Slice profile generation - Deriving TA list from coverage Area
+
+Bug Fixes
+=========
+
+- OPTFRA-907 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
+- OPTFRA-924 Replace pycryptodome with pycrytodomex, since it is not well maintained
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+
+References
+==========
+
+For more information on the ONAP Honolulu release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+
+
+..      ===========================
+..      * * *    GUILIN    * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the Guilin release.
+
+Summary
+=======
+
+
+Release Data
+============
+
+
++--------------------------------------+--------------------------------------+
+| **OOF Project**                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - optf-has 2.1.2                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 7.0.0 guilin                         |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-11-19 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+- Support for Generic objective functions
+- Candidate schema refactoring
+- New candidate types - NSI, Slice profiles
+- Functionality added in AAI plugin to support NSI candidates
+
+Bug Fixes
+=========
+
+- OPTFRA-854 HAS to support multiple inventory provider for a demand
+- OPTFRA-839 Remove python 2.7 from HAS docker image
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+
+References
+==========
+
+For more information on the ONAP Guilin release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+
+
+..      ===========================
+..      * * *    FRANKFURT    * * *
+..      ===========================
+
+Abstract
+========
+
+This document provides the release notes for the Frankfurt release.
+
+Summary
+=======
+
+
+Release Data
+============
+
+
++--------------------------------------+--------------------------------------+
+| **OOF Project**                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - optf-has 2.0.4                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 6.0.0 frankfurt                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-05-07 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+- Passthrough attributes has been added to placement request.
+- HAS container to run as non-root user.
+- HAS Component has be upgraded to Python 3.8.
+- New inventory type NSSI is added.
+- Functionality has been added to AAI plugin to get the nssi candidates
+  from AAI.
+- New constraint named ``threshold`` has been added to the solver.
+
+Bug Fixes
+=========
+
+- OPTFRA-734 Nginx failing to start as non-root user.
+- OPTFRA-733 AAF authentication fails while handling API requests.
+- OPTFRA-746 Add NSI id to NSSI candidate.
+- OPTFRA-747 Music api not using server url in https mode.
+- OPTFRA-728 HPA CSIT test failures.
+- OPTFRA-726 Nginx needs to run as root.
+- OPTFRA-630 Sonar failing jobs.
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
+
+**Fixed Security issues**
+
+All HAS containers were running as root user which is fixed in this
+release under OPTFRA-711.
+
+References
+==========
+
+For more information on the ONAP Frankfurt release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
+
+Quick Links:
+    - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+    - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+
+Version: 5.0.1
+--------------
+
+:Release Date: 2019-09-30 (El Alto Release)
+
+The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
+
+Artifacts released:
+
+optf-has:1.3.3
+
+**New Features**
+
+No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
+Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
+
+    * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
+
+* Platform Maturity Level 1
+    * ~56.2%+ unit test coverage
+
+
+**Bug Fixes**
+
+The El Alto release for OOF fixed the following Bugs.
+
+    * [OPTFRA-579] Json error in homing solution
+    * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
+    * [OPTFRA-409] Template example : purpose to be explained
+
+
+**Known Issues**
+
+**Security Notes**
+
+*Fixed Security Issues*
+
+    * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
+      This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
+
+*Known Security Issues*
+
+*Known Vulnerabilities in Used Modules*
+
+**Upgrade Notes**
+
+
+**Deprecation Notes**
+
+
+**Other**
+
+
+Version: 4.0.0
+--------------
+
+:Release Date: 2019-06-06 (Dublin Release)
+
+**New Features**
+
+A summary of features includes:
+
+* Extend OOF to support traffic distribution optimization
+* Implement encryption for HAS internal and external communication
+
+* Platform Maturity Level 1
+    * ~56.2%+ unit test coverage
+
+The Dublin release for OOF delivered the following Epics.
+
+    * [OPTFRA-424]     Extend OOF to support traffic distribution optimization
+    * [OPTFRA-422]     Move OOF projects' CSIT to run on OOM
+    * [OPTFRA-270]     This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
+
+**Bug Fixes**
+    * OPTFRA-515       Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
+    * OPTFRA-513       OOF-HAS pods fail to come up in ONAP deployment
+    * OPTFRA-492       HAS API pod failure
+    * OPTFRA-487       OOF HAS CSIT failing with HTTPS changes
+    * OPTFRA-475       Remove Casablanca jobs in preparation for Dublin branch
+    * OPTFRA-467       Remove aai simulator code from HAS solver
+    * OPTFRA-465       Fix data code smells
+    * OPTFRA-461       Enable HTTPS and TLS for HAS API
+    * OPTFRA-452       Remove misleading reservation logic
+    * OPTFRA-449       Create OOM based CSIT for HAS
+    * OPTFRA-448       Multiple Sonar Issues
+    * OPTFRA-445       Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
+    * OPTFRA-444       Implement Distribute Traffic API exposure in HAS
+    * OPTFRA-412       Got 'NoneType' error when there's no flavor info inside vim
+    * OPTFRA-411       latency_country_rules_loader.py - Remove the unused local variable "ctx".
+    * OPTFRA-302       Enhance coverage of existing HAS code to 55%
+
+
+**Known Issues**
+
+These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
+
+    * OPTFRA-494       HAS request 'limit' argument is ignored.
+
+**Security Issues**
+
+*Fixed Security Issues*
+
+*Known Security Issues*
+
+    * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
+
+*Known Vulnerabilities in Used Modules*
+
+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>`_.
+
+**Quick Links**:
+    - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
+    - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
+    - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
+**Upgrade Notes**
+To upgrade, run docker container or install from source, See Distribution page
+
+**Deprecation Notes**
+No features deprecated in this release
+
+**Other**
+None
+
+
 Version: 3.0.1
 --------------
 
@@ -32,9 +596,9 @@ Version: 3.0.0
 
 **New Features**
 
-A summary of features includes: 
+A summary of features includes:
 
-* Security enhancements, including integration with AAF to implement access controls on 
+* Security enhancements, including integration with AAF to implement access controls on
     OSDF and HAS northbound interfaces
 * Integration with SMS
 * Platform Maturity Level 1
@@ -43,8 +607,8 @@ A summary of features includes:
     1) Added support for SRIOV-NIC and directives to assist the orchestrator
     2) Select the best candidate across all cloud region based on HPA score.
     3) HPA metrics using prometheus
-    
-The Casablanca release for OOF delivered the following Epics. 
+
+The Casablanca release for OOF delivered the following Epics.
 
     * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
@@ -63,14 +627,14 @@ The Casablanca release for OOF delivered the following Epics.
 
     * OPTFRA-205 - Generated conductor.conf missing configurations
     * OPTFRA-210 - Onboarding to Music error
-    * OPTFRA-211 - Error solution for HPA 
+    * OPTFRA-211 - Error solution for HPA
     * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
     * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
     * OPTFRA-264 - oof-has-zookeeper image pull error
     * OPTFRA-305 - Analyze OOM health check failure
     * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
     * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
-    * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name 
+    * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
     * OPTFRA-325 - spelling mistake
     * OPTFRA-326 - hyperlink links are missing
     * OPTFRA-335 - Making flavors an optional field in HAS candidate object
@@ -135,14 +699,14 @@ OPTFRA code has been formally scanned during build time using NexusIQ and no Cri
 
 **Quick Links**:
        - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
-       
+
        - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 
 **Upgrade Notes**
-To upgrade, run docker container or install from source, See Distribution page  
+To upgrade, run docker container or install from source, See Distribution page
 
 **Deprecation Notes**
-No features deprecated in this release  
+No features deprecated in this release
 
 **Other**
 None
@@ -154,7 +718,7 @@ Version: 2.0.0
 
 **New Features**
 
-The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues: 
+The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
 
 * Baseline HAS functionality
     * support for VCPE use case
@@ -162,8 +726,8 @@ The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features i
 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 * Platform Maturity Level 1
     * ~50%+ unit test coverage
-    
-The Beijing release for OOF delivered the following Epics. 
+
+The Beijing release for OOF delivered the following Epics.
 
     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
 
@@ -188,7 +752,7 @@ The Beijing release for OOF delivered the following Epics.
 
 **Bug Fixes**
 
-None. Initial release R2 Beijing. No previous versions  
+None. Initial release R2 Beijing. No previous versions
 
 **Known Issues**
 
@@ -207,14 +771,14 @@ OPTFRA code has been formally scanned during build time using NexusIQ and no Cri
 
 Quick Links:
        - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
-       
+
        - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 
 **Upgrade Notes**
-None. Initial release R2 Beijing. No previous versions  
+None. Initial release R2 Beijing. No previous versions
 
 **Deprecation Notes**
-None. Initial release R2 Beijing. No previous versions  
+None. Initial release R2 Beijing. No previous versions
 
 **Other**
-None
\ No newline at end of file
+None