-.. 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.5.3
--------------
-:Release Date: 2019-06-13
-**New Features**
+Abstract
+========
-The full list of Dublin epics and user stories for SDNC maybe be found at <https://jira.onap.org/issues/?filter=11803>.
+This document provides the release notes for the Guilin release of the Software Defined
+Network Controller (SDNC)
-The following list summarizes some of the most significant epics:
+Summary
+=======
-+------------+----------------------------------------------------------------------------+
-| Jira # | Abstract |
-+============+============================================================================+
-| [SDNC-551] | OpenDaylight Fluorine Support |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-564] | 5G Use Case |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-565] | CCVPN Use Case Extension |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-570] | SDN-R: Server side component |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-579] | SDN-R : UX-Client |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-631] | SDNC support for the PNF Use Case Network Assign for Plug and Play feature |
-+------------+----------------------------------------------------------------------------+
+The Guilin 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).
-**Bug Fixes**
-The full list of bug fixes in the SDNC Dublin release may be found at <https://jira.onap.org/issues/?filter=11805>
-**Known Issues**
-The full list of known issues in SDNC may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
-
-**Security Notes**
-
-*Fixed Security Issues*
-
-- CVE-2019-12132 `OJSI-41 <https://jira.onap.org/browse/OJSI-41>`_ SDNC service allows for arbitrary code execution in sla/dgUpload form
- Fixed temporarily by disabling admportal
+Release Data
+============
-*Known Security Issues*
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Guilin |
+| | |
++-------------------------+-------------------------------------------+
+| **Release date** | 11/19/2020 |
+| | |
++-------------------------+-------------------------------------------+
-*Known Vulnerabilities in Used Modules*
-Quick Links:
+New features
+------------
-- `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>`_
-
-Version: 1.4.4
---------------
-
-**Bugs Fixes**
-
-The following bugs are fixed in the SDNC Casablanca January 2019 maintenance release:
-
-+------------+------------------------------------------------------------------------------------------+
-| Jira # | Abstract |
-+============+==========================================================================================+
-| [SDNC-405] | SDNC API documentation is missing on ReadTheDocs |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-523] | vnf-information.vnf-id validation check should not be mandatory in validate-vnf-input DG |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-532] | oof query failed due to hostname change, returning unknown host |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-534] | wrong "input" field in DMaaP message template |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-536] | Upgrade zjsonpatch version to remediate vulnerabilities |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-537] | Update to spring-boot 2.1.0-RELEASE |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-540] | CCVPN closed loop testing failed. |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-542] | [PORT] Network Discovery microservice does not log |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-546] | CCVPN bugs fix for manual free integration test |
-+------------+------------------------------------------------------------------------------------------+
-| [SDNC-549] | Retain MD-SAL data on pod recreate |
-+------------+------------------------------------------------------------------------------------------+
-
-
-
-Version: 1.4.3
---------------
+The SDNC Guilin release includes the following features:
+* Upgrade to Java 11 (Jira `SDNC-1242 <https://jira.onap.org/browse/SDNC-1242>`_)
+* Network slicing (Jira `SDNC-915 <https://jira.onap.org/browse/SDNC-915>`_)
+* NETCONF/TLS Certificate Management (Jira `SDNC-966 <https://jira.onap.org/browse/SDNC-966>`_)
+* Decouple SDNC from OpenDaylight / Karaf : phase 2 (Jira `SDNC-1207 <https://jira.onap.org/browse/SDNC-1207>`_)
-:Release Date: 2018-11-30
+This release also includes an upgrade to the OpenDaylight Sodium release, which SDNC consumes from CCSDK.
+Downstream projects that are consuming SDNC maven artifacts, or that plan to ingest SDNC as source and do local compiles should be
+aware that the upgrades to OpenDaylight Sodium and to Java 11 are both potentially breaking changes. Therefore, we consider
+Guilin to be a major release and have reflected this in our version numbering.
-**New Features**
+For the complete list of `SDNC Guilin release epics <https://jira.onap.org/issues/?filter=12464>`_ and
+`SDNC Guilin release user stories <https://jira.onap.org/issues/?filter=12465>`_ , please see the `ONAP Jira`_.
-The Casablanca release of SDNC introduces the following new features:
+**Bug fixes**
- - Network Discovery, in support of POMBA
- - Support for CCVPN use case
- - Change Management enhancements
+The full list of `bugs fixed in the SDNC Guilin release <https://jira.onap.org/issues/?filter=12466>`_ is maintained on the `ONAP Jira`_.
-**Bug Fixes**
+**Known Issues**
-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>
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
-**Known Issues**
+Removed Features
+-------------------
-The list of known issues in the SDNC project may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
+**SDNC portal**
+The SDNC portal was deprecated in the Frankfurt release, due
+to resource contraints. This functionality was delivered dormant
+in Frankfurt (i.e. it is disabled in the Frankfurt helm charts) and was
+removed entirely in the Guilin release.
-**Security Notes**
+**VNF-API**
-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>`_.
+The functionality provided by the VNF-API is now provided as part
+of the GENERIC-RESOURCE-API. Therefore, the VNF-API was deprecated
+in Frankfurt and has been removed in Guilin.
-Quick Links:
-- `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>`_
+Deliverables
+------------
-**Upgrade Notes**
- NA
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
-**Deprecation Notes**
- NA
+.. _dockercontainers:
-**Other**
- NA
+Docker Containers
+`````````````````
-Version: 1.3.4
---------------
+The following table lists the docker containers comprising the SDNC Frankfurt
+release along with the current stable Frankfurt 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}
-:Release Date: 2018-07-06
-**New Features**
+Note: users that want to use the latest in-development Frankfurt version may use the
+tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
-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.
++--------------------------------+-----------------------------------------------------+---------+
+| Image name | Description | Version |
++================================+=====================================================+=========+
+| onap/sdnc-aaf-image | SDNC controller image, integrated with AAF for RBAC | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image | SDNC controller image, without AAF integration | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image | SDC listener | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 2.0.4 |
++--------------------------------+-----------------------------------------------------+---------+
-+------------+-------------------------------------------------------------------------------------------------------------+
-| 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> |
-+------------+-------------------------------------------------------------------------------------------------------------+
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-**Bug Fixes**
+* `SDN Controller for Radio user guide`_
-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 Limitations, Issues and Workarounds
+=========================================
+System Limitations
+------------------
-**Known Issues**
+No system limitations noted.
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| 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> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
+Known Vulnerabilities
+---------------------
-**Security Notes**
+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.
-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>`_.
-Quick Links:
+Workarounds
+-----------
-- `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>`_
+Not applicable.
-**Upgrade Notes**
- NA
-**Deprecation Notes**
- NA
+Security Notes
+--------------
-**Other**
- NA
+Fixed Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-Version: 1.2.1
---------------
+The following security issue, related to the SDNC portal, is no longer applicable due to removal
+of the SDNC portal:
-:Release Date: 2018-01-18
+* `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
-**Bug Fixes**
+.. _secissues :
-- `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
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-Version: 1.2.0
---------------
+There are no known outstanding security issues related to SDNC Guilin.
-:Release Date: 2017-11-16
-**New Features**
+Test Results
+============
+Not applicable
-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**
- 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
+References
+==========
-**Security Issues**
- NA
+For more information on the ONAP Frankfurt release, please see:
-**Upgrade Notes**
- NA
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
-**Deprecation Notes**
- NA
-**Other**
- NA
+.. _`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
Code Review / sdnc / oam.git / blobdiff