Code Review / dmaap / buscontroller.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
DMAAP-BC - Update Release Note Date
[dmaap/buscontroller.git] / docs / release-notes / release-notes.rst
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
index 19a8c99..42f7b2c 100644 (file)
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -1,33 +1,121 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+
+.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
 .. _release_notes:
 
+DMaaP Buscontroller Release Notes
+====================
 
-..      ===========================
+.. note
+..      * This Release Notes must be updated each time the team decides to Release new artifacts.
+..      * The scope of these Release Notes are for ONAP DMaaP Buscontroller. In other words, each ONAP component has its Release Notes.
+..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
+..      * this Release Notes.
+..      * Except the date and the version number, all the other sections are optional but there must be at least
+..      * one section describing the purpose of this new release.
+..      * This note must be removed after content has been added.
 
-..      * * *    FRANKFURT    * * *
 
 ..      ===========================
+..      * * *    Honolulu    * * *
+..      ===========================
+
 
 
 Abstract
+--------
 
-========
 
-
-This document provides the release notes for the Frankfurt release.
+This document provides the release notes for the Honolulu release.
 
 
 Summary
+-------
 
-=======
+Mainly Security changes to update Project Lead details, and update outdated packages
 
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Bus Controller Project**     |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - dmaap-bc 2.0.5                     |
+|                                      | - dbc-client 1.0.9                   |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | 8.0.0 Honolulu                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2021-04-01 (TBD)                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
 
-Release Data
+New features
+------------
+* Updated log4j (Listed in "Known Vulternabilities" below) - DMAAP-1515
+* Update Project Lead details - DMAAP-1538
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+* CVE-2019-17571
+
+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:
+- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
+
+..      ===========================
+..      * * *    GUILIN    * * *
+..      ===========================
+
+
+
+Abstract
+--------
+
+
+This document provides the release notes for the Guilin release.
+
+
+Summary
+-------
+
+Release Data
+------------
 
 +--------------------------------------+--------------------------------------+
 | **DMaaP Bus Controller Project**     |                                      |
@@ -36,10 +124,10 @@ Release Data
 | **Docker images**                    | - dmaap-bc 2.0.4                     |
 |                                      | - dbc-client 1.0.9                   |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | 6.0.0 frankfurt                      |
+| **Release designation**              | 7.0.0 guilin                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | 2020-05-14 (TBD)                     |
+| **Release date**                     | 2020-11-18                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -47,13 +135,8 @@ Release Data
 New features
 ------------
 
-* Implement boolean flag in OOM to disable HTTP ports
-* Dynamic cert distribution from OOM AAF
-
-
 Known Limitations, Issues and Workarounds
-=========================================
-
+-----------------------------------------
 
 System Limitations
 ------------------
@@ -74,18 +157,14 @@ Workarounds
 -----------
 
 
-
 Security Notes
 --------------
 
 
-
 References
-==========
-
-
-For more information on the ONAP Frankfurt release, please see:
+----------
 
+For more information on the ONAP Guilin release, please see:
 
 #. `ONAP Home Page`_
 #. `ONAP Documentation`_
@@ -93,51 +172,116 @@ For more information on the ONAP Frankfurt release, please see:
 #. `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:
+- `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
+- `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
+
+..      ===========================
+..      * * *    FRANKFURT    * * *
+..      ===========================
+
 
-Release Notes
-=============
 
-Version: 6.0.0 (Frankfurt Release)
------------------------------------
-: Release Date: 2020-05-14
+Abstract
+--------
 
-Docker Image Version: 2.0.4 
 
-**New Features**
+This document provides the release notes for the Frankfurt release.
 
-- the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
-- The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
 
-**Bug Fixes**
-       NA
+Summary
+-------
 
-**Known Issues**
-       NA
+The Frankfurt release focused on improved packaging and deployment.
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **DMaaP Bus Controller Project**     |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | - dmaap-bc 2.0.4                     |
+|                                      | - dbc-client 1.0.9                   |
++--------------------------------------+--------------------------------------+
+| **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.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
+* the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
+
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
+
+
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+* CVE-2018-11307
+* CVE-2018-12022
+* CVE-2018-12023
+* CVE-2019-17571
+* CVE-2016-2510
+* CVE-2017-18640
+
+
+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
 
-**Security Notes**
-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 `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
 
 Quick Links:
 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
 
-**Upgrade Notes**
-       NA
-
-**Deprecation Notes**
-- `Project Vulnerability Review Table for DMAAP seems to be discontinued`
-
+..      ==========================
+..      * * *     EL ALTO    * * *
+..      ==========================
 
+Version: 1.1.5 
+--------------
 
-Version: 1.1.5 (El Alto)
-: Release Date: 2019-06-06
+: Release Date: 2019-06-06 (El Alto)
 
 **New Features**
 
Provides a northbound REST API to ONAP clients to manage DMaaP resources. This includes DMaaP components such as MR and DR, as well as provisioning of topics and feeds. Southbound, it communicates with the respective component APIs.