Merge "[POLICY] Update core images/config for RC istanbul"
[oom.git] / docs / release-notes.rst
index f3e3d8f..bb9c2e8 100644 (file)
-.. 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:
+
+*************************************
+ONAP Operations Manager Release Notes
+*************************************
+
+Previous Release Notes
+======================
+
+- :ref:`Honolulu <release_notes_honolulu>`
+- :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 Istanbul release.
+
+Summary
+=======
 
-Release Notes
-=============
 
-Version: 1.1.0
---------------
 
-:Release Date: 2017-11-16
+Release Data
+============
 
-**New Features**
++--------------------------------------+--------------------------------------+
+| **Project**                          | OOM                                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | N/A                                  |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Istanbul                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
-The Amsterdam release is the first release of the ONAP Operations Manager (OOM).
+New features
+------------
 
-The main goal of the Amsterdam release was to:
 
-    - 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.
+**Bug fixes**
 
-**Bug Fixes**
+A list of issues resolved in this release can be found here:
+https://jira.onap.org/projects/OOM/versions/11074
 
-    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.
 
 **Known Issues**
-    `OOM-6 <https://jira.onap.org/browse/OOM-6>`_ Automated platform deployment on Docker/Kubernetes - VFC, AAF, MSB minor issues.
 
-        Workaround:
 
-    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.
+Deliverables
+------------
 
-        OOM ONAP Configuration Management - Handling of Secrets.
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
 
-        Workaround:
+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>`.
 
-        Automated workaround to be able to pull from protected docker repositories.
+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>`
 
-**Security Issues**
-    N/A
+Known Limitations, Issues and Workarounds
+=========================================
 
+Known Vulnerabilities
+---------------------
 
-**Upgrade Notes**
 
-    N/A
+Workarounds
+-----------
 
-**Deprecation Notes**
+- `OOM-2754 <https://jira.onap.org/browse/OOM-2754>`_
+  Because of *updateEndpoint* property added to *cmpv2issuer* CRD
+  it is impossible to upgrade platform component from Honolulu to Istanbul
+  release without manual steps. Actions that should be performed:
+
+  #. Update the CRD definition::
+
+     > kubectl -n onap apply -f oom/kubernetes/platform/components/cmpv2-cert-provider/crds/cmpv2issuer.yaml
+  #. Upgrade the component::
+
+     > helm -n onap upgrade dev-platform oom/kubernetes/platform
+  #. Make sure that *cmpv2issuer* contains correct value for
+     *spec.updateEndpoint*. The value should be: *v1/certificate-update*.
+     If it's not, edit the resource::
+
+     > kubectl -n onap edit cmpv2issuer cmpv2-issuer-onap
+
+
+Security Notes
+--------------
 
-    N/A
+**Fixed Security Issues**
 
-**Other**
+References
+==========
 
+For more information on the ONAP Istanbul 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