Chore: Add gerrit maven verify GHA workflow
[sdnc/oam.git] / docs / release-notes.rst
index c586363..ca97e29 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
+.. (c) ONAP Project and its contributors
+.. _release_notes:
 
-Release Notes
-=============
+******************
+SDNC Release Notes
+******************
 
-Version: 1.2.0
---------------
 
+Abstract
+========
+
+This document provides the release notes for the London release of the Software Defined
+Network Controller (SDNC)
+
+Summary
+=======
+
+The London release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
+upgrade (to Chlorine).
+
+
+
+Release Data
+============
+
++-------------------------+-------------------------------------------+
+| **Project**             | SDNC                                      |
+|                         |                                           |
++-------------------------+-------------------------------------------+
+| **Docker images**       | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | London                                    |
+|                         |                                           |
++-------------------------+-------------------------------------------+
+
+
+New features
+------------
+
+The SDNC London release includes the following features,  which are inherited from CCSDK:
 
-:Release Date: 2018-11-16
+* Upgrade to OpenDaylight Chlorine Release (Jira `CCSDK-3812 <https://jira.onap.org/browse/CCSDK-3812>`_)
 
 
+For the complete list of `CCSDK London release epics <https://jira.onap.org/issues/?filter=13112>`_ and
+`CCSDK London release user stories <https://jira.onap.org/issues/?filter=13113>`_ , please see the `ONAP Jira`_.
 
-**New Features**
+**Bug fixes**
 
-The ONAP Amsterdam release introduces the following changes to SDNC from
-the original openECOMP seed code:
-   - Refactored / moved common platform code to new CCSDK project
-   - Refactored code to rename openecomp to onap
-   - Introduced new GENERIC-RESOURCE-API api, used by vCPE and VoLTE use cases
-   - Introduced new docker containers for SDC and DMAAP interfaces
 
-**Bug Fixes**
+The full list of `bugs fixed in the SDNC London release <https://jira.onap.org/issues/?filter=13116>`_ is maintained on the `ONAP Jira`_.
+
 **Known Issues**
-The following known high priority issues are being worked and are expected to be delivered
-in release 1.2.1:
-   - `SDNC-179 <https://jira.onap.org/browse/SDNC-179>`_ Failed to make HTTPS connection in restapicall node
-   - `SDNC-181 <https://jira.onap.org/browse/SDNC-181>`_ Change call to brg-wan-ip-address vbrg-wan-ip brg topo activate DG
-   - `SDNC-182 <https://jira.onap.org/browse/SDNC-182>`_ Fix VNI Consistency: Add vG vxlan tunnel setup and bridge domain setup to brg-topo-activate DG
 
+* Impacts of PAX/JETTY V9 to oauth and websockets in SDNR (Jira `SDNC-1809 <https://jira.onap.org/browse/SDNC-1809>`_)
+
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
+
+
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+.. _dockercontainers:
+
+Docker Containers
+`````````````````
+
+The following table lists the docker containers comprising the SDNC London
+release along with the current stable London version/tag.  Each of these is
+available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
+with the following command::
+
+   docker pull nexus3.onap.org:10001/{image-name}:{version}
+
+
+
++--------------------------------+-----------------------------------------------------+---------+
+| Image name                     | Description                                         | Version |
++================================+=====================================================+=========+
+| onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server                                      | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.5.4   |
++--------------------------------+-----------------------------------------------------+---------+
+
+
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* `SDN Controller for Radio user guide`_
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+No system limitations noted.
+
+
+Known Vulnerabilities
+---------------------
+
+Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
+pertain to SDNC are listed in the "Known Security Issues" section below.
+
+
+Workarounds
+-----------
+
+Not applicable.
+
+
+Security Notes
+--------------
+
+
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+There are no known outstanding security issues related to SDNC London.
+
+
+Test Results
+============
+Not applicable
 
-**Security Issues**
-   You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
 
+References
+==========
 
-**Upgrade Notes**
+For more information on the ONAP London release, please see:
 
-**Deprecation Notes**
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
 
-**Other**
 
+.. _`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
+.. _`ONAP Jira`: https://jira.onap.org
+.. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html