X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=339925ad5f731d517d5bf1ec8684ae0fd0f02084;hb=557628a23bf7e1f841b392324687799bc7064d54;hp=f3e3d8f790bad4933c0df8a2c0e0a643428916eb;hpb=bbbab8060cd9b5ebaa917be725a1ce487004073c;p=oom.git

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index f3e3d8f790..d8e529a347 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,65 +1,125 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 Bell Canada & Amdocs Intellectual Property.  All rights reserved.
+.. (c) ONAP Project and its contributors
+.. _release_notes:
 
-Release Notes
-=============
+*************************************
+ONAP Operations Manager Release Notes
+*************************************
 
-Version: 1.1.0
---------------
+Previous Release Notes
+======================
+
+- :ref:`Guilin <release_notes_guilin>`
+- :ref:`Frankfurt <release_notes_frankfurt>`
+- :ref:`El Alto <release_notes_elalto>`
+- :ref:`Dublin <release_notes_dublin>`
+- :ref:`Casablanca <release_notes_casablanca>`
+- :ref:`Beijing <release_notes_beijing>`
+- :ref:`Amsterdam <release_notes_amsterdam>`
+
+Abstract
+========
+
+This document provides the release notes for the Honolulu release.
+
+Summary
+=======
 
-:Release Date: 2017-11-16
+The focus of this release is to strengthen the foundation of OOM installer.
 
-**New Features**
+Release Data
+============
 
-The Amsterdam release is the first release of the ONAP Operations Manager (OOM).
++--------------------------------------+--------------------------------------+
+| **Project**                          | OOM                                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | N/A                                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Honolulu                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020/12/03                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
-The main goal of the Amsterdam release was to:
+New features
+------------
 
-    - Support Flexible Platform Deployment via Kubernetes of fully containerized OMAP components - on any type of environment.
-    - Support State Management of ONAP platform components.
-    - Support full production ONAP deployment and any variation of component level deployment for development.
-    - Platform Operations Orchestration / Control Loop Actions.
-    - Platform centralized logging with ELK stack.
+* Kubernetes support for version up to 1.20
+* Helm support for version up to 3.5
+* Limits are set for most of the components
 
-**Bug Fixes**
+**Bug fixes**
 
-    The full list of implemented user stories and epics is available on `JIRA <https://jira.onap.org/secure/RapidBoard.jspa?rapidView=41&view=planning.nodetail&epics=visible>`_
-    This is the first release of OOM, the defects fixed in this release were raised during the course of the release.
-    Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above.
+A list of issues resolved in this release can be found here:
+https://jira.onap.org/projects/OOM/versions/10826
 
 **Known Issues**
-    `OOM-6 <https://jira.onap.org/browse/OOM-6>`_ Automated platform deployment on Docker/Kubernetes - VFC, AAF, MSB minor issues.
 
-        Workaround:
+- `<https://github.com/bitnami/bitnami-docker-mariadb-galera/issues/35>`_
+  bitnami mariadb galera image doesn't support single quote in password.
 
-    Manual configuration changes - however the reference vFirewall use case does not currently require these components
-.
-    - `OOM-10 <https://jira.onap.org/browse/OOM-10>`_ Platform configuration management.
 
-        OOM ONAP Configuration Management - Handling of Secrets.
 
-        Workaround:
+Deliverables
+------------
 
-        Automated workaround to be able to pull from protected docker repositories.
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
 
+OOM provides `Helm charts <https://git.onap.org/oom/>`_ that needs to be
+"compiled" into Helm package. see step 6 in
+:doc:`quickstart guide <oom_quickstart_guide>`.
 
-**Security Issues**
-    N/A
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+- :doc:`Project Description <oom_project_description>`
+- :doc:`Cloud Setup Guide <oom_cloud_setup_guide>`
+- :doc:`Quick Start Guide <oom_quickstart_guide>`
+- :doc:`Setup Ingress Controller <oom_setup_ingress_controller>`
+- :doc:`Developer Guide <oom_developer_guide>`
+- :doc:`Hardcoded Certificates <oom_hardcoded_certificates>`
 
-**Upgrade Notes**
+Known Limitations, Issues and Workarounds
+=========================================
 
-    N/A
+Known Vulnerabilities
+---------------------
 
-**Deprecation Notes**
+- Hard coded password used for all OOM deployments
+  [`OJSI-188 <https://jira.onap.org/browse/OJSI-188>`_]
+- :doc:`Hard coded certificates <oom_hardcoded_certificates>` in Helm packages
+
+Workarounds
+-----------
+
+- `<https://github.com/bitnami/bitnami-docker-mariadb-galera/issues/35>`_
+  Workaround is to generate a password with "short" strenght or pregenerate
+  passwords without single quote in it. Default deployment is using "short"
+  password generation for mariadb.
+
+Security Notes
+--------------
 
-    N/A
+**Fixed Security Issues**
 
-**Other**
+References
+==========
 
+For more information on the ONAP Frankfurt release, please see:
 
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
 
-===========
 
-End of Release Notes
+.. _`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