-.. 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 Jakarta release of the Software Defined
+Network Controller (SDNC)
+
+Summary
+=======
+
+The Jakarta release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
+upgrade (to Phosphorus).
+
+The Jakarta release of SDNC also includes substantial improvements in automated test coverage integrated into
+the project's CI/CD framework. In this release, each time a new SDNC is built, a regression suite is run
+and the docker is only saved if it passes this regression suite.
+
+
+
+Release Data
+============
+
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Jakarta |
+| | |
++-------------------------+-------------------------------------------+
+
+
+New features
+------------
+
+The SDNC Jakarta release includes the following features, which are inherited from CCSDK:
+
+* Upgrade to OpenDaylight Phosphorus Release (Jira `CCSDK-3451 <https://jira.onap.org/browse/CCSDK-3451>`_)
+* A1 Adapter and A1 Policy Management Extensions in Jakarta Release - CCSDK (Jira `CCSDK-3463 <https://jira.onap.org/browse/CCSDK-3463>`_)
+* CCSDK impacts for Network slicing in Jakarta Release (Jira `CCSDK-3554 <https://jira.onap.org/browse/CCSDK-3554>`_)
-: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> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+For the complete list of `CCSDK Jakarta release epics <https://jira.onap.org/issues/?filter=12711>`_ and
+`CCSDK Jakarta release user stories <https://jira.onap.org/issues/?filter=12800>`_ , please see the `ONAP Jira`_.
+
+**Bug fixes**
+
+The SDNC Jakarta release carries forward a fix from the Istanbul Maintenance Release 1 for a critical vulnerability discovered in log4j by
+upgrading to version 2.17.1 of the log4j-core package. It also removes the 'data-migrator' package, which
+was an old Proof of Concept that is no longer maintained and which was using a vulnerable version of log4j.
+These changes are described further in Jira `SDNC-1655 <https://jira.onap.org/browse/SDNC-1655>`
+
+The full list of `bugs fixed in the SDNC Jakarta release <https://jira.onap.org/issues/?filter=12802>`_ 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`_.
+
+
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+.. _dockercontainers:
+
+Docker Containers
+`````````````````
+
+The following table lists the docker containers comprising the SDNC Jakarta
+release along with the current stable Jakarta 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.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server | 2.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener | 2.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image | SDNC controller image, without AAF integration | 2.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image | SDC listener | 2.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 2.3.1 |
++--------------------------------+-----------------------------------------------------+---------+
+
+
+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
+--------------
+
+
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+There are no known outstanding security issues related to SDNC Jakarta.
+
+
+Test Results
+============
+Not applicable
+
+
+References
+==========
+
+For more information on the ONAP Jakarta 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/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html