Merge "[AAI] Update of aai component diagram and description"
[aai/aai-common.git] / docs / release-notes.rst
index 884b63f..ae56b81 100644 (file)
@@ -10,15 +10,220 @@ AAI Release Notes
 Abstract
 ========
 
-This document provides release notes for the Active and Available Inventory Project's Frankfurt Release
+This document provides release notes for the Active and Available Inventory Project's Istanbul Release
 
 Release Data
 ============
 
+Version: 9.0.1
+--------------
+
+:Release Date: 2022-02-17 (TBD)
+
+The R9 Istanbul maintenance release of ONAP A&AI addressed some security vulnerabilities mainly for the Log4J dependencies
+
+- Updated the log4j libraries to 2.17.2
+
+Version: 9.0.0
+--------------
+
+:Release Date: 2021-11-04
+
+New Features
+------------
+
+The R9 Istanbul release of ONAP includes updates to both use cases and non-functional requirements. AAI is serving v24 as the latest version of the REST APIs, and has support for v21.
+
+- Functional Updates
+    * Model updates as part of CCVPN Transport Slicing Feature
+    * Model updates as part of Smart Intent Guarantee based on IBN Feature
+    * Model updates as part of CNF Orchestration Feature
+- Non-functional Updates
+    * Sonar & Security updates
+    * Rolling upgrade functionality
+    * Micrometer integration
+    * Prometheus monitoring integration
+
+Known Limitations, Issues, and Workarounds
+==========================================
+
+Known Issues
+------------
+
+* None
+
+Workarounds
+-----------
+
+* None
+
+References
+==========
+
+Quick links:
+
+- `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
+- `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
+
+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
+
+Version: 8.0.0
+--------------
+
+:Release Date: 2021-04-29
+
+New Features
+------------
+
+The R8 Honolulu release of ONAP includes updates to both use cases and non-functional requirements.
+
+- Functional Updates
+    * Model updates as part of CCVPN Transport Slicing Feature
+    * Model updates as part of Network Slicing Feature
+    * Model updates as part of Multi-tenancy
+    * Multi-tenancy implemented allowing for control of data by owner (disabled by default)
+    * GraphGraph POC enhanced for schema visualization and visual model generation
+    * Sparky UI updates including Browse, Specialized Search, BYOQ, and BYOQ Builder Views
+- Non-functional Updates
+    * Updated eligible microservices (non-janusgraph dependent) to use Java 11
+- Deprecation Notice
+    * Data-router, Search-data-service, Elastic, and Router-Core are put into maintenance mode and removed from release.
+
+Known Limitations, Issues, and Workarounds
+==========================================
+
+Known Issues
+------------
+
+* None
+
+Workarounds
+-----------
+
+* None
+
+References
+==========
+
+Quick links:
+
+- `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
+- `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
+
+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
+
+Version: 7.0.1
+--------------
+
+:Release Date: 2021-05-10
+
+The R7 Guilin maintenance release of ONAP A&AI just addressed some bug fixes and certificate updates
+
+- Updated Certificates
+- Updated Edge rule for bandwidth attribute
+- AAI-EVENT notifications failing to publish was fixed
+
+Version: 7.0.0
+--------------
+
+:Release Date: 2020-12-03
+
+New Features
+------------
+
+The R7 Guilin release of ONAP includes updates to both use cases and non-functional requirements. The AAI platform maturity rating graduated from Incubation to Mature in Guilin.  AAI is serving v21 as the latest version of the REST APIs, and has support for v19.
+
+- Functional Updates
+    * Model updates as part of CCVPN Transport Slicing Feature
+    * Model updates as part of xNF Software Upgrade feature
+    * Model updates as part of Multi-tenancy
+    * Updates to SDC model parsing to support Bulk PM/PM Data Control Extension & E2E Network Slicing features
+    * Configurable ability to control concurrency locking
+    * Configurable ability to enforce ownership of owning entity on pnf crud interactions (Multi-tenancy poc)
+    * Enhancements to the model based on physical inventory
+    * Support for nested json formatted responses using the as-tree=true parameter for traversal mS calls
+- Non-functional Updates
+    * Updated microservices to run as non-root
+    * Spring boot 2 upgrades to our microservices
+    * Enhanced logging
+    * Added limits to aai pods
+    * Update mS based on license scan findings
+- Deprecation Notice
+    * ESR Server is retired
+    * ESR GUI is retired
+    * AAI Sparky UI is not supported in Guilin nor is its supporting mS data-router, search-data-service, or elastic. Targeted for retirement in Honolulu.
+
+Known Limitations, Issues, and Workarounds
+==========================================
+
+Known Issues
+------------
+
+* `AAI-3219 <https://jira.onap.org/browse/AAI-3219>`_ - AAI-EVENT notifications failed to be published to DMaap
+
+Workarounds
+-----------
+
+The following is our workaround (i.e., replacing HTTPS with HTTP):
+
+ .. code-block:: bash
+
+    /** Change each of these configmaps below**/
+    kubectl -n onap edit configmaps dev-aai-resources-configmap
+    kubectl -n onap edit configmaps dev-aai-traversal-configmap
+    kubectl -n onap edit configmaps dev-aai-graphadmin-configmap
+    kubectl -n onap edit configmaps dev-aai-data-router-dynamic
+    // The target attributes need to be changed are:
+    // change Dmaap port from 3905 => 3904
+    // change Dmaap protocol from https => http
+    /** Restart related pods **/
+    kubectl n onap delete pod {POD1} {POD2} {POD3} {POD4}
+    //where POD1-4 are pod names of dev-aai-resources, dev-aai-traversal, dev-aai-graphadmin, and dev-aai-data-router, respectively.
+
+References
+==========
+
+Quick links:
+
+- `AAI project page <https://wiki.onap.org/display/DW/Active+and+Available+Inventory+Project>`_
+- `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
+
+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
+
 Version: 6.0.0
 --------------
 
-:Release Date: 2020-06-04 (TBD)
+:Release Date: 2020-06-04
 
 New Features
 ------------
@@ -36,7 +241,7 @@ The R6 Frankfurt release of ONAP includes updates to both use cases and non-func
 - Integration with sonarcloud
 - All containers run as non-root user
 
-champ, spike, and gizmo are deprecated and removed from the helm chart. This will be the last release where aai manages its own helm chart, in R7 Guilin and beyond, the aai/oom submodule will be merged back into the oom project.
+champ, spike, and gizmo are deprecated and removed from the helm chart.
 
 Known Limitations, Issues, and Workarounds
 ==========================================
@@ -65,12 +270,12 @@ Quick links:
 - `Passing Badge information for AAI <https://bestpractices.coreinfrastructure.org/en/projects/1591>`_
 
 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
@@ -96,7 +301,7 @@ seamless upgrade from 0.2.0 which was used in Dublin.
 Users who would like to further reduce the AAI footprint can update the
 aai/oom helm charts.
 
-To re-enable the services that have been disabled by default, update 
+To re-enable the services that have been disabled by default, update
 to "enabled: true" in aai/oom/values.yaml:
 
  .. code-block:: bash
@@ -118,9 +323,9 @@ aai/oom/values.yaml for each of the following services:
         enabled: false
     aai-search-data:
         enabled: false
-    aai-elasticsearch: 
+    aai-elasticsearch:
         enabled: false
-    aai-sparky-fe: 
+    aai-sparky-fe:
         enabled: false
 
 *Known Vulnerabilities in Used Modules*
@@ -129,7 +334,7 @@ AAI code has been formally scanned during build time using NexusIQ and
 all Critical vulnerabilities have been addressed, items that remain
 open have been assessed for risk and determined to be false
 positive. The AAI open Critical security vulnerabilities and their
-risk assessment have been documented as part of the linkTBD
+risk assessment have been documented as part of the link
 
 **Known Issues**