X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=f52d36f9cb078fe547a5795c46e974d1769b8328;hb=5d8a59fc3a4086901af1b0036654211709d5d185;hp=c58636380ddd8ac7c3fe5eb73e25cbd7f0429f00;hpb=dc7588271af715296f53a4528cf7195eabf95be0;p=sdnc%2Foam.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index c5863638..f52d36f9 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,41 +1,167 @@ -.. 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 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 | +| | | ++-------------------------+-------------------------------------------+ -Version: 1.2.0 --------------- +New features +------------ -:Release Date: 2018-11-16 +The SDNC Jakarta release includes the following features, which are inherited from CCSDK: +* Upgrade to OpenDaylight Phosphorus Release (Jira `CCSDK-3451 `_) +* A1 Adapter and A1 Policy Management Extensions in Jakarta Release - CCSDK (Jira `CCSDK-3463 `_) +* CCSDK impacts for Network slicing in Jakarta Release (Jira `CCSDK-3554 `_) -**New Features** +For the complete list of `CCSDK Jakarta release epics `_ and +`CCSDK Jakarta release user stories `_ , please see the `ONAP Jira`_. -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** + +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 ` + +The full list of `bugs fixed in the SDNC Jakarta release `_ is maintained on the `ONAP Jira`_. -**Bug Fixes** **Known Issues** -The following known high priority issues are being worked and are expected to be delivered -in release 1.2.1: - - `SDNC-179 `_ Failed to make HTTPS connection in restapicall node - - `SDNC-181 `_ Change call to brg-wan-ip-address vbrg-wan-ip brg topo activate DG - - `SDNC-182 `_ Fix VNI Consistency: Add vG vxlan tunnel setup and bridge domain setup to brg-topo-activate DG +The full list of `known issues in SDNC `_ 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 -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ +References +========== -**Upgrade Notes** +For more information on the ONAP Jakarta release, please see: -**Deprecation Notes** +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ -**Other** +.. _`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