-.. 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
+******************
+
+
+Abstract
+========
+
+This document provides the release notes for the Guilin release of the Software Defined
+Network Controller (SDNC)
+
+Summary
+=======
+
+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).
-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
---------------
+Release Data
+============
-:Release Date: 2018-11-30
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Guilin |
+| | |
++-------------------------+-------------------------------------------+
+| **Release date** | 11/19/2020 |
+| | |
++-------------------------+-------------------------------------------+
-**New Features**
-The Casablanca release of SDNC introduces the following new features:
+New features
+------------
- - Network Discovery, in support of POMBA
- - Support for CCVPN use case
- - Change Management enhancements
+The SDNC Guilin release includes the following features:
-**Bug Fixes**
+* 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>`_)
-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>
+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.
+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`_.
+
+**Bug fixes**
+
+The full list of `bugs fixed in the SDNC Guilin release <https://jira.onap.org/issues/?filter=12466>`_ is maintained on the `ONAP Jira`_.
**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>
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
-**Security Notes**
+Removed Features
+-------------------
-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>`_.
+**SDNC portal**
-Quick Links:
+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.
-- `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>`_
+**VNF-API**
-**Upgrade Notes**
- NA
+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.
-**Deprecation Notes**
- NA
-**Other**
- NA
+Deliverables
+------------
-Version: 1.3.4
---------------
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+.. _dockercontainers:
-:Release Date: 2018-07-06
+Docker Containers
+`````````````````
-**New Features**
+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::
-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.
+ docker pull nexus3.onap.org:10001/{image-name}:{version}
-+------------+-------------------------------------------------------------------------------------------------------------+
-| 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> |
-+------------+-------------------------------------------------------------------------------------------------------------+
+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
-**Bug Fixes**
++--------------------------------+-----------------------------------------------------+---------+
+| 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 |
++--------------------------------+-----------------------------------------------------+---------+
-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>
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-**Known Issues**
+* `SDN Controller for Radio user guide`_
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| 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 Limitations, Issues and Workarounds
+=========================================
+System Limitations
+------------------
-**Security Notes**
+No system limitations noted.
-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:
+Known Vulnerabilities
+---------------------
-- `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>`_
+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.
-**Upgrade Notes**
- NA
-**Deprecation Notes**
- NA
+Workarounds
+-----------
-**Other**
- NA
+Not applicable.
-Version: 1.2.1
+
+Security Notes
--------------
-:Release Date: 2018-01-18
+Fixed Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-**Bug Fixes**
+The following security issue, related to the SDNC portal, is no longer applicable due to removal
+of the SDNC portal:
-- `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
+* `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
-Version: 1.2.0
---------------
+.. _secissues :
-:Release Date: 2017-11-16
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-**New Features**
+There are no known outstanding security issues related to SDNC Guilin.
-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
+Test Results
+============
+Not applicable
-**Security Issues**
- NA
-**Upgrade Notes**
- NA
+References
+==========
-**Deprecation Notes**
- NA
+For more information on the ONAP Frankfurt 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
Code Review / sdnc / oam.git / blobdiff