Add missing label in the Release Note file
[optf/has.git] / docs / sections / release-notes.rst
index b4b1fba..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
 --------------