-.. 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 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).
+
+
+
+Release Data
+============
+
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Guilin |
+| | |
++-------------------------+-------------------------------------------+
+| **Release date** | 11/19/2020 |
+| | |
++-------------------------+-------------------------------------------+
+
+
+New features
+------------
+
+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>`_)
+
+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**
-:Release Date: 2018-11-16
-
-
-
-**New Features**
-
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| Jira # | Abstract |
-+=============+=========================================================================================================================+
-| [SDNC-278] | Change management in-place software upgrade execution using Ansible <https://jira.onap.org/browse/SDNC-278> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-275] | Unit tests for GenericResourceApiProvider class <https://jira.onap.org/browse/SDNC-275> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-266] | Junit Test Coverage for Epic SDNC-232 <https://jira.onap.org/browse/SDNC-266> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-250] | Multi-site High-availability - health-monitor reporting <https://jira.onap.org/browse/SDNC-250> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-223] | Maintain MD-SAL data across docker container upgrades <https://jira.onap.org/browse/SDNC-223> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-214] | Multi-site High-availability - Kubernetes Federation + Manual Failover (POC) <https://jira.onap.org/browse/SDNC-214> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-210] | Address issued identified by Sonar <https://jira.onap.org/browse/SDNC-210> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-163] | Deploy a SDN-C high availability environment - Kubernetes <https://jira.onap.org/browse/SDNC-163> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-53] | Convert Configuration Subsystem Dependency Injection to Blueprint <https://jira.onap.org/browse/SDNC-53> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-10] | Refactor MD-SAL applications to conform to current OpenDaylight archetype format <https://jira.onap.org/browse/SDNC-10> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-6] | Deploy a SDN-C high availability environment <https://jira.onap.org/browse/SDNC-6> |
-+-------------+-------------------------------------------------------------------------------------------------------------------------+
-
-**Bug Fixes**
-
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Jira # | Abstract |
-+============+======================================================================================================================================================+
-| [SDNC-313] | LCM does not retrieve status from ansible-server correctly <https://jira.onap.org/browse/SDNC-313> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-311] | sdnc/features build fails <https://jira.onap.org/browse/SDNC-311> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-310] | General cleanup of SDNC helm charts <https://jira.onap.org/browse/SDNC-310> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-309] | ansible adapter properties file missing <https://jira.onap.org/browse/SDNC-309> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-308] | OOM: Update UEB and DMaaP charts to use new message-router name <https://jira.onap.org/browse/SDNC-308> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-306] | SDNC fails health check on HEAT deployment <https://jira.onap.org/browse/SDNC-306> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-305] | No model found for VF module customization UUID <https://jira.onap.org/browse/SDNC-305> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-303] | aaiclient.properties using wrong JKS <https://jira.onap.org/browse/SDNC-303> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-302] | SDNC VNF-API ssl certificate error updating AAI <https://jira.onap.org/browse/SDNC-302> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-299] | OOM deployment with 2+ MySQL instances fails when NFS provisioner disabled <https://jira.onap.org/browse/SDNC-299> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-298] | SDNC aaiclient.properties should reference v13 A&AI api <https://jira.onap.org/browse/SDNC-298> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-295] | Ansible server stops <https://jira.onap.org/browse/SDNC-295> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-293] | DMaaP listener not connecting to DMaaP in OOM deployment <https://jira.onap.org/browse/SDNC-293> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-292] | Daily build of unused sdnc/features repo fails <https://jira.onap.org/browse/SDNC-292> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-286] | OOM: SDN-C servers don't come up cleanly when enableClustering=true <https://jira.onap.org/browse/SDNC-286> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-285] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT <https://jira.onap.org/browse/SDNC-285> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-284] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT deleted from nexus3 <https://jira.onap.org/browse/SDNC-284> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-283] | SDNC fails CSIT <https://jira.onap.org/browse/SDNC-283> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-279] | sdnc docker build fails <https://jira.onap.org/browse/SDNC-279> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-277] | SDNC CSIT test fails <https://jira.onap.org/browse/SDNC-277> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-234] | DMAAP ID in dhcpalert.properties cannot contain "\_" <https://jira.onap.org/browse/SDNC-234> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-228] | Duplicate test file name <https://jira.onap.org/browse/SDNC-228> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-207] | generic-resource-api-model: failing on goal yang-maven-plugin - master only - force 1.2.0 over default 2.0.0 <https://jira.onap.org/browse/SDNC-207> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-203] | SDNC VM & Docker Containers Unstable <https://jira.onap.org/browse/SDNC-203> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-195] | brg-topology-operations deactivate does not pick up parameters correctly when creating AAI request <https://jira.onap.org/browse/SDNC-195> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-156] | unknown log fills up on failed DELETE <https://jira.onap.org/browse/SDNC-156> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-127] | Generated sources not placed under target directory breaks tooling apps <https://jira.onap.org/browse/SDNC-127> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-105] | Generic Resource API DGs contain old openecomp and com.att based plugin references <https://jira.onap.org/browse/SDNC-105> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-87] | Accessing invalid network-parameters from network-request-input, it should be network-input-parameters <https://jira.onap.org/browse/SDNC-87> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-73] | vnfapi: new feature to support softdelete <https://jira.onap.org/browse/SDNC-73> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+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**
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| Jira # | Abstract |
-+============+==================================================================================================================================+
-| [SDNC-304] | SDNC OOM intermittent Healthcheck failure - JSONDecodeError - on different startup order <https://jira.onap.org/browse/SDNC-304> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-291] | vCPE Model distribution error in UEB Listener SQL Insert <https://jira.onap.org/browse/SDNC-291> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-290] | Fix nodePortPrefix in service yaml <https://jira.onap.org/browse/SDNC-290> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-246] | Passwords stored in clear text in properties files <https://jira.onap.org/browse/SDNC-246> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-208] | SDNC preload - fix confusion: vnf-name=VF-Module, generic-vnf-name=VNF <https://jira.onap.org/browse/SDNC-208> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [SDNC-206] | REST calls from DG <https://jira.onap.org/browse/SDNC-206> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| [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> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-
-**Security Issues**
- You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
-
-
-**Upgrade Notes**
-
-**Deprecation Notes**
-
-**Other**
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
+
+
+Removed Features
+-------------------
+
+**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.
+
+**VNF-API**
+
+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.
+
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+.. _dockercontainers:
+
+Docker Containers
+`````````````````
+
+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}
+
+
+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
+
++--------------------------------+-----------------------------------------------------+---------+
+| 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 |
++--------------------------------+-----------------------------------------------------+---------+
+
+
+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 :ref:`secissues` section below.
+
+
+Workarounds
+-----------
+
+Not applicable.
+
+
+Security Notes
+--------------
+
+Fixed Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+The following security issue, related to the SDNC portal, is no longer applicable due to removal
+of the SDNC portal:
+
+* `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
+
+.. _secissues :
+
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+There are no known outstanding security issues related to SDNC Guilin.
+
+
+Test Results
+============
+Not applicable
+
+
+References
+==========
+
+For more information on the ONAP Frankfurt release, please see:
+
+#. `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