Release 1.13.2 docker artifact
[aai/aai-common.git] / docs / release-notes.rst
index bf52368..2cc56bc 100644 (file)
@@ -10,21 +10,117 @@ AAI Release Notes
 Abstract
 ========
 
-This document provides release notes for the Active and Available Inventory Project's Jakarta Release
+This document provides release notes for the Active and Available Inventory Project's Kohn Release
 
 Release Data
 ============
 
+Version: 13.0.0
+---------------
+
+New Features
+------------
+
+- Spring Boot update in aai-common, resources and traversal from 2.1 to 2.4
+- Tracing support in resources and traversal
+- Optionally enable `database level caching for JanusGraph <https://docs.janusgraph.org/operations/cache/#database-level-caching>`_
+- Change default logging to write to stdout instead of files
+- Reduce log noise by not logging happy pass for liveness probes
+
+Fixes
+-----
+
+- Fix metrics monitoring via Prometheus
+
+:Release Date: 2022-11-10
+
+Version: 11.0.0
+---------------
+
+:Release Date: 2022-11-10
+
+New Features
+------------
+
+The R11 Kohn release of ONAP includes updates to the schema and edge rules. AAI is serving v27 as the latest version of the REST APIs, and has support for v25.
+
+- Model updates made on the following nodes for changes to attributes or indexing, present in v27
+    * User Network Interfaces (uni)
+    * Route target
+    * Network Route
+    * Bgp neighbor
+    * Vpn binding
+    * Lag interface
+    * Physical interface
+    * Logical interface
+
+- Edge rule changes include
+    * UPDATE collection > service instance edge label and multiplicity change
+    * ADD configuration > p-interface
+    * ADD collection>endpoint
+    * ADD collection>configuration
+    * ADD collection>aggregate-route
+    * ADD collection>parameter-list
+    * ADD collection>policy-key-term
+    * ADD collection>policy-map-member
+    * ADD collection>rule
+    * ADD collection>profile
+    * ADD collection>policy
+    * ADD collection>l3-network
+    * ADD collection>vpn-binding
+    * ADD collection>community-list
+    * ADD collection>object-group
+    * ADD p-interface>object-group
+
+- Please note log4j is still on older versions in a transitive dependency for aaf auth for the following mS
+  * onap-aai-aai-common
+  * onap-aai-babel
+  * onap-aai-resources
+  * onap-aai-schema-service
+  * onap-aai-traversal
+
+Known Limitations, Issues, and Workarounds
+==========================================
+
+Known Issues
+------------
+
+* DMAAP Events are Not Being Published from AAI-Resources (AAI-3507)
+
+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: 10.0.0
---------------
+---------------
 
 :Release Date: 2022-06-02
 
 The R10 Jakarta release of ONAP A&AI addressed security vulnerabilities and enhanced the model for the CCVPN Use Case
 
 - Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud Leased Line (CLL) service
-- Updated versions for indy, httpclient, freemarker, activemq, commons-io, commons-compress, logback-core,
-commons-codec, groovy, netty-all, netty-handler, gson, and snakeyaml in various mS
+- Updated versions for indy, httpclient, freemarker, activemq, commons-io, commons-compress, logback-core, commons-codec, groovy, netty-all, netty-handler, gson, and snakeyaml in various mS
 - Please note log4j is still on older versions in a transitive dependency for aaf auth for the following mS
   * onap-aai-aai-common
   * onap-aai-babel
@@ -67,8 +163,8 @@ The R9 Istanbul release of ONAP includes updates to both use cases and non-funct
     * Micrometer integration
     * Prometheus monitoring integration
 
-Known Limitations, Issues, and Workarounds
-==========================================
+Istanbul Known Limitations, Issues, and Workarounds
+---------------------------------------------------
 
 Known Issues
 ------------
@@ -80,8 +176,8 @@ Workarounds
 
 * None
 
-References
-==========
+Honolulu References
+-------------------
 
 Quick links:
 
@@ -122,8 +218,8 @@ The R8 Honolulu release of ONAP includes updates to both use cases and non-funct
 - 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
-==========================================
+Honolulu Known Limitations, Issues, and Workarounds
+---------------------------------------------------
 
 Known Issues
 ------------
@@ -135,8 +231,8 @@ Workarounds
 
 * None
 
-References
-==========
+Istanbul References
+-------------------
 
 Quick links:
 
@@ -196,8 +292,8 @@ The R7 Guilin release of ONAP includes updates to both use cases and non-functio
     * 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
-==========================================
+Guilin Known Limitations, Issues, and Workarounds
+-------------------------------------------------
 
 Known Issues
 ------------
@@ -223,8 +319,8 @@ The following is our workaround (i.e., replacing HTTPS with HTTP):
     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
-==========
+Guilin References
+-----------------
 
 Quick links:
 
@@ -266,8 +362,8 @@ The R6 Frankfurt release of ONAP includes updates to both use cases and non-func
 
 champ, spike, and gizmo are deprecated and removed from the helm chart.
 
-Known Limitations, Issues, and Workarounds
-==========================================
+Frankfurt Known Limitations, Issues, and Workarounds
+----------------------------------------------------
 
 Known Issues
 ------------
@@ -284,8 +380,8 @@ Roles for sparky are loaded into AAF by default, so previous workaround is no lo
 
 The community has been unable to make data-router communicate with DMaaP, we welcome contributors who can help resurrect this service, or it will be deprecated in Guilin.
 
-References
-==========
+Frankfurt References
+--------------------
 
 Quick links:
 
@@ -889,7 +985,7 @@ Source code of AAI is released under the following repositories at https://gerri
 
 **Known Issues**
 
-If the either the aai-resources or aai-traversal pod is deleted, haproxy will not automatically detect when the pod is re-instantiated.  As a temporary workaround, you can delete the haproxy pod (the one named "aai", for example, "dev-aai-8794fbff5-clx7d") and when the aai pod restarts the service should operate normally. A proposed fix is here: https://gerrit.onap.org/r/#/c/51075/1 if you want to see how to configure the haproxy service to auto-recover when the IP address of either the aai-resources or aai-traversal pod changes.
+If the either the aai-resources or aai-traversal pod is deleted, haproxy will not automatically detect when the pod is re-instantiated.  As a temporary workaround, you can delete the haproxy pod (the one named "aai", for example, "dev-aai-8794fbff5-clx7d") and when the aai pod restarts the service should operate normally. A proposed fix is `here <https://gerrit.onap.org/r/c/oom/+/51075/1>`_ if you want to see how to configure the haproxy service to auto-recover when the IP address of either the aai-resources or aai-traversal pod changes.
 
 **Security Notes**
 
@@ -1086,8 +1182,6 @@ Source code of AAI is released under the following repositories at https://gerri
 
 - `AAI-61 <https://jira.onap.org/browse/AAI-61>`_ AAI cleaned up references to OpenECOMP but in order to keep the release stable for R1, the XML namespace still contains openecomp.
 
-Client systems should use http://org.openecomp.aai.inventory/v11 as the XML namespace for ONAP AAI R1.
-
 **Security Issues**
 
 See Common Vulnerabilities and Exposures `CVE <https://cve.mitre.org>`