update link to upper-constraints.txt
[dmaap/datarouter.git] / docs / release-notes.rst
index 88bd296..e04a3f2 100644 (file)
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. _release_notes:
 
-.. toctree::
-   :maxdepth: 2
 
-Release-notes
-==============
+..      ===========================
+..      * * *      LONDON     * * *
+..      ===========================
 
-Version: 2.1.0 (Dublin)
----------------------------
+=============
+Release Notes
+=============
 
-:Release Date: 2019-06-06
+London
+======
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR London release.
+
+Summary
+-------
+No major changes for London Release.
+Minor bug fix and package updates.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.13             |
+|                                      | - datarouter-node 2.1.13             |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 12.0.0 London                        |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | TBD                                  |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+References
+----------
+
+For more information on the ONAP Kohn 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
+
+
+..      ===========================
+..      * * *      KOHN       * * *
+..      ===========================
+
+=============
+Release Notes
+=============
+
+Kohn
+========
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Kohn release.
+
+Summary
+-------
+No major for Kohn Release.
+Minor bug fix and package updates.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.11             |
+|                                      | - datarouter-node 2.1.11             |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 11.0.0 Kohn                          |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | TBD                                  |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+References
+----------
+
+For more information on the ONAP Kohn 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
+
+
+..      ===========================
+..      * * *    JAKARTA    * * *
+..      ===========================
+
+=============
+Release Notes
+=============
+
+Jakarta
+========
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Jakarta release.
+
+Summary
+-------
+No big changes for Jakarta Release.
+Some bug fixes and sonar fixes.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.10             |
+|                                      | - datarouter-node 2.1.10             |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 10.0.0 Jakarta                       |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 5/12/2022                            |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+* Patch DR certs - DMAAP-1726
+* Cross Scripting sonar fix - DMAAP-1624
+* SQL Injection Fix - DMAAP-1623
+* Sonar Security hotspot fixes - DMAAP-1624
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+References
+----------
+
+For more information on the ONAP Istanbul 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
+
+
+..      ===========================
+..      * * *    ISTANBUL    * * *
+..      ===========================
+
+=============
+Release Notes
+=============
+
+Istanbul
+========
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Istanbul release.
+
+Summary
+-------
+No big changes for Istanbul Release.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.9              |
+|                                      | - datarouter-node 2.1.9              |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 9.0.0 Istanbul                       |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2021-10-14                           |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+* Package upgrades - DMAAP-1608
+* Move csits to dr repo - DMAAP-1636
+* Sonar fixes - DMAAP-1623
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+References
+----------
+
+For more information on the ONAP Istanbul 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
+
+
+..      ===========================
+..      * * *    Honolulu    * * *
+..      ===========================
+
+
+Honolulu
+========
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Honolulu release.
+
+Summary
+-------
+No big changes for Honolulu Release.
+
+Release Data
+------------
 
-The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and
-subscriptions.
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.8              |
+|                                      | - datarouter-node 2.1.8              |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 8.0.0 Honolulu                       |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2021-04-01                           |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+* Update commons-codec (listed in "Known Vulnerabilities" below) - DMAAP-1515
+* Change openjdk baseOS imgs to ONAP/integration- - INT-1864
+* Update Project Lead Information - DMAAP-1538
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+* SONATYPE-2012-0050
+
+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
+
+
+..      ===========================
+..      * * *    GUILIN       * * *
+..      ===========================
+
+Guilin
+======
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Guilin release.
+
+Summary
+-------
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.7              |
+|                                      | - datarouter-node 2.1.7              |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 7.0.0 guilin                         |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-10-19 (TBD)                     |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+
+..      ===========================
+..      * * *    FRANKFURT    * * *
+..      ===========================
+
+Frankfurt
+=========
+
+Abstract
+--------
+
+This document provides the release notes for the DMaaP DR Frankfurt release.
+
+Summary
+-------
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Data Router Project**        |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - datarouter-prov 2.1.6              |
+|                                      | - datarouter-node 2.1.6              |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 6.0.0 frankfurt                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-05-14 (TBD)                     |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+* Implement boolean flag in OOM to disable HTTP ports
+* Dynamic cert distribution from OOM AAF
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+Known Vulnerabilities
+---------------------
+* CVE-2019-11358
+
+Workarounds
+-----------
+
+Security Notes
+--------------
+
+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
+
+
+El Alto
+=======
+
+Version: 2.1.2
+--------------
+
+:Release Date: 2019-09-05
+
+New Features:
+
++----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| JIRA ID        | Description                                                                                                                     |
++================+=================================================================================================================================+
+| DMAAP-1227     | Updating logging functionality to log events into correct log files as specified in logging spec                                |
++----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| DMAAP-1228     | Updating Logging pattern to match logging spec                                                                                  |
++----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| DMAAP-1049     | [DR] Update DR logging to match Platform maturity Logging Spec                                                                  |
++----------------+---------------------------------------------------------------------------------------------------------------------------------+
+
+Bug Fixes:
+
++----------------+--------------------------------------------------------------------------------------------------+
+| JIRA ID        | Description                                                                                      |
++================+==================================================================================================+
+| DMAAP-1421     |  [DR] ElAlto AAF certs expired                                                                   |
++----------------+--------------------------------------------------------------------------------------------------+
+
+Known Issues:
+N/A
+
+Security Issues:
+N/A
+
+Upgrade Notes:
+N/A
+
+Deprecation Notes:
+N/A
+
+Other:
+N/A
+
+
+Dublin
+======
+
+Version: 2.1.0
+--------------
+
+:Release Date: 2019-06-06
 
 New Features:
 
@@ -43,10 +555,10 @@ Bug Fixes:
 | DMAAP-1161     | [DR] filebeat container on DR-Node and DR-Prov are unable to publish to kibana                   |
 +----------------+--------------------------------------------------------------------------------------------------+
 
-Known Issues
+Known Issues:
 N/A
 
-Security Issues
+Security Issues:
 
 *Fixed Security Issues*
 
@@ -64,23 +576,23 @@ Critical security vulnerabilities and their risk assessment have been documented
 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
 
-Upgrade Notes
+Upgrade Notes:
 N/A
 
-Deprecation Notes
+Deprecation Notes:
 N/A
 
-Other
+Other:
 N/A
 
 
-Version: 1.0.8 (Casablanca)
----------------------------
+Casablanca Maintenance
+======================
 
-:Release Date: 2019-02-28
+Version: 1.0.8
+--------------
 
-The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and
-subscriptions.
+:Release Date: 2019-02-28
 
 New Features:
 
@@ -97,10 +609,10 @@ Bug Fixes:
 | DMAAP-1065     | [DR] Casablanca - AAF certs expired on dmaap-dr-prov and dmaap-dr-node                           |
 +----------------+--------------------------------------------------------------------------------------------------+
 
-Known Issues
+Known Issues:
 N/A
 
-Security Issues
+Security Issues:
 DMAAP 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 DMAAP open
 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
@@ -109,23 +621,23 @@ Critical security vulnerabilities and their risk assessment have been documented
 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
 
-Upgrade Notes
+Upgrade Notes:
 N/A
 
-Deprecation Notes
+Deprecation Notes:
 N/A
 
-Other
+Other:
 N/A
 
 
-Version: 1.0.3 (Casablanca)
----------------------------
+Casablanca
+==========
 
-:Release Date: 2018-11-30
+Version: 1.0.3
+--------------
 
-The DataRouter(DR) provisioning API is a HTTPS-based, REST-like API for creating and managing DR feeds and
-subscriptions.
+:Release Date: 2018-11-30
 
 New Features:
 
@@ -151,10 +663,10 @@ Bug Fixes:
 | DMAAP-565      | Incorrect nexusUrl parameter in datarouter pom files                                                                            |
 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
 
-Known Issues
+Known Issues:
 N/A
 
-Security Issues
+Security Issues:
 DMAAP 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 DMAAP open
 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
@@ -163,11 +675,11 @@ Critical security vulnerabilities and their risk assessment have been documented
 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
 
-Upgrade Notes
+Upgrade Notes:
 N/A
 
-Deprecation Notes
+Deprecation Notes:
 N/A
 
-Other
+Other:
 N/A