Add version into root pom for platform-logic-setup
[sdnc/oam.git] / docs / release-notes.rst
index 7579604..c1fc738 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.4.3
---------------
 
+Abstract
+========
 
-:Release Date: 2018-11-30
+This document provides the release notes for the Honolulu release of the Software Defined
+Network Controller (SDNC)
 
-**New Features**
+Summary
+=======
 
-The Casablanca release of SDNC introduces the following new features:
+The Honolulu release of SDNC introduces new functionality to support network slicing and extends support
+for Netconf/TLS to address certificate management.  It also includes a major OpenDaylight release
+upgrade (to Sodium), as well as a major Java upgrade (from Java 8 to Java 11).
 
-       - Network Discovery, in support of POMBA
-       - Support for CCVPN use case
-       - Change Management enhancements
 
-**Bug Fixes**
 
-The list of bugs fixed in the SDNC Casablanca release may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11544>
+Release Data
+============
 
++-------------------------+-------------------------------------------+
+| **Project**             | SDNC                                      |
+|                         |                                           |
++-------------------------+-------------------------------------------+
+| **Docker images**       | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Honolulu                                  |
+|                         |                                           |
++-------------------------+-------------------------------------------+
+| **Release date**        | 4/22/2021                                 |
+|                         |                                           |
++-------------------------+-------------------------------------------+
 
-**Known Issues**
 
-The list of known issues in the SDNC project may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
+New features
+------------
 
+The SDNC Honolulu release includes the following features:
 
-**Security Notes**
+* SDN-C (SDN-R) support of E2E Network Slicing in Honolulu (Jira `SDNC-1415 <https://jira.onap.org/browse/SDNC-1415>`_)
+* ONAP CNF Orchestration - Honolulu Enhancements (SDNC) (Jira `SDNC-1451 <https://jira.onap.org/browse/SDNC-1451>`_)
+* Decouple SDNC from OpenDaylight / Karaf : phase 3 (Jira `SDNC-1348 <https://jira.onap.org/browse/SDNC-1348>`_)
 
-SDNC 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 SDNC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_.
+This release also includes an upgrade to the OpenDaylight Aluminum release, which SDNC consumes from CCSDK.
 
-Quick Links:
+For the complete list of `SDNC Honolulu release epics <https://jira.onap.org/issues/?filter=12498>`_ and 
+`SDNC Honolulu release user stories <https://jira.onap.org/issues/?filter=12499>`_ , please see the `ONAP Jira`_.
 
-- `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
-- `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
-- `Project Vulnerability Review Table for Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45307811>`_
+**Bug fixes**
 
-**Upgrade Notes**
-   NA
+The full list of `bugs fixed in the SDNC Honolulu release <https://jira.onap.org/issues/?filter=12500>`_ is maintained on the `ONAP Jira`_.
 
-**Deprecation Notes**
-   NA
+**Known Issues**
 
-**Other**
-   NA
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
 
-Version: 1.3.4
---------------
 
 
-:Release Date: 2018-07-06
+Deliverables
+------------
 
-**New Features**
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
 
-The full list of SDNC Beijing Epics and user stories can be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=10791>.  The
-following table lists the major features included in the Beijing release.
+.. _dockercontainers:
 
-+------------+-------------------------------------------------------------------------------------------------------------+
-| Jira #     | Abstract                                                                                                    |
-+============+=============================================================================================================+
-| [SDNC-278] | Change management in-place software upgrade execution using Ansible <https://jira.onap.org/browse/SDNC-278> |
-+------------+-------------------------------------------------------------------------------------------------------------+
-| [SDNC-163] | Deploy a SDN-C high availability environment - Kubernetes <https://jira.onap.org/browse/SDNC-163>           |
-+------------+-------------------------------------------------------------------------------------------------------------+
+Docker Containers
+`````````````````
 
+The following table lists the docker containers comprising the SDNC Honolulu
+release along with the current stable Honolulu version/tag.  Each of these is
+available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
+with the following command::
 
-**Bug Fixes**
+   docker pull nexus3.onap.org:10001/{image-name}:{version}
 
-The list of bugs fixed in the SDNC Beijing release may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11118>
 
 
-**Known Issues**
++--------------------------------+-----------------------------------------------------+---------+
+| Image name                     | Description                                         | Version |
++================================+=====================================================+=========+
+| onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server                                      | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.1.5   |
++--------------------------------+-----------------------------------------------------+---------+
 
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| Jira #     | Abstract                                                                                                                         |
-+============+==================================================================================================================================+
-| [SDNC-324] | IPV4_ADDRESS_POOL is empty <https://jira.onap.org/browse/SDNC-324>                                                               |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-321] | dgbuilder won't save DG <https://jira.onap.org/browse/SDNC-321>                                                                  |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-304] | SDNC OOM intermittent Healthcheck failure - JSONDecodeError - on different startup order <https://jira.onap.org/browse/SDNC-304> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-115] | VNFAPI DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-115>                        |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-114] | Generic API DGs contain plugin references to software not part of ONAP <https://jira.onap.org/browse/SDNC-114>                   |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-106] | VNFAPI DGs contain old openecomp and com.att based plugin references <https://jira.onap.org/browse/SDNC-106>                     |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-64]  | SDNC is not setting FromApp identifier in logging MDC <https://jira.onap.org/browse/SDNC-64>                                     |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
 
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**Security Notes**
+* `SDN Controller for Radio user guide`_
 
-SDNC 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 SDNC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_.
+Known Limitations, Issues and Workarounds
+=========================================
 
-Quick Links:
+System Limitations
+------------------
 
-- `SDNC project page <https://wiki.onap.org/display/DW/Software+Defined+Network+Controller+Project>`_
-- `Passing Badge information for SDNC <https://bestpractices.coreinfrastructure.org/en/projects/1703>`_
-- `Project Vulnerability Review Table for SDNC <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_
+No system limitations noted.
 
-**Upgrade Notes**
-       NA
 
-**Deprecation Notes**
-       NA
+Known Vulnerabilities
+---------------------
 
-**Other**
-       NA
+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 :ref:`secissues` section below.
 
-Version: 1.2.1
---------------
 
-:Release Date: 2018-01-18
+Workarounds
+-----------
 
-**Bug Fixes**
+Not applicable.
 
-- `SDNC-145 <https://jira.onap.org/browse/SDNC-145>`_ Error message refers to wrong parameters
-- `SDNC-195 <https://jira.onap.org/browse/SDNC-195>`_ UEB listener doesn't insert correct parameters for allotted resources in DB table ALLOTTED_RESOURCE_MODEL
-- `SDNC-198 <https://jira.onap.org/browse/SDNC-198>`_ CSIT job fails
-- `SDNC-201 <https://jira.onap.org/browse/SDNC-201>`_ Fix DG bugs from integration tests
-- `SDNC-202 <https://jira.onap.org/browse/SDNC-202>`_ Search for service -data null match, set vGW LAN IP via Heat
-- `SDNC-211 <https://jira.onap.org/browse/SDNC-211>`_ Update SDNC Amsterdam branch to use maintenance release versions
-- `SDNC-212 <https://jira.onap.org/browse/SDNC-212>`_ Duplicate file name
 
-Version: 1.2.0
+Security Notes
 --------------
 
-:Release Date: 2017-11-16
 
-**New Features**
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
 
-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
+There are no known outstanding security issues related to SDNC Honolulu.
 
-**Bug Fixes**
-       NA
-**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
 
-**Security Issues**
-       NA
+Test Results
+============
+Not applicable
+
 
-**Upgrade Notes**
-       NA
+References
+==========
 
-**Deprecation Notes**
-       NA
+For more information on the ONAP Honolulu release, please see:
 
-**Other**
-       NA
+#. `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
+.. _`ONAP Jira`: https://jira.onap.org
+.. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html