Fix Release Notes format

[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 02e1956..5f132bf 100644 (file)
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -1,10 +1,120 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
 
-Release Notes
-=============
-Version: 1.1.5 (El Alto)
-: Release Date: 2019-06-06
+.. 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    * * *
+..      ===========================
+
+
+
+Abstract
+========
+
+
+This document provides the release notes for the Frankfurt release.
+
+
+Summary
+=======
+
+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
+
+
+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>`_
+
+..      ==========================
+..      * * *     EL ALTO    * * *
+..      ==========================
+
+Version: 1.1.5 
+--------------
+
+: Release Date: 2019-06-06 (El Alto)
 
 **New Features**
 
@@ -22,7 +132,7 @@ DMAAP code has been formally scanned during build time using NexusIQ and all Cri
 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>`_
-- `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
+- `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`
 
 **Upgrade Notes**
        NA