X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=076bfc2fd735d35dea12d12b47145c72f1316104;hb=3eb32648ea58265ff87d0bc3b1867d0ce0006d69;hp=c58636380ddd8ac7c3fe5eb73e25cbd7f0429f00;hpb=7dadacb67020f018f1e1f151aced2e9fca2759df;p=sdnc%2Foam.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index c5863638..076bfc2f 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,41 +1,184 @@ -.. 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 -============= +****************** +SDNC Release Notes +****************** + + +Abstract +======== + +This document provides the release notes for the Frankfurt release of the Software Defined +Network Controller (SDNC) + +Summary +======= + +The Frankfurt release of SDNC introduces new functionality to support PNFs (Physical Network Functions), extends support +for Netconf/TLS to support CMPv2, and adds support for the Multi Domain Optical Network Service use case. -Version: 1.2.0 --------------- +Release Data +============ -:Release Date: 2018-11-16 ++-------------------------+-------------------------------------------+ +| **Project** | SDNC | +| | | ++-------------------------+-------------------------------------------+ +| **Docker images** | See :ref:`dockercontainers` section below | ++-------------------------+-------------------------------------------+ +| **Release designation** | Frankfurt | +| | | ++-------------------------+-------------------------------------------+ +| **Release date** | 06/04/2020 | +| | | ++-------------------------+-------------------------------------------+ +New features +------------ -**New Features** +The SDNC Frankfurt release includes the following features: -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 +* ORAN-compliant A1 adaptor (Jira `SDNC-965 `_) +* Multi-Domain Optical Service (Jira `SDNC-928 `_) +* Python 2 -> Python 3 migration (Jira `SDNC-967 `_) +* Upgrade to new Policy lifecycle API (Jira `SDNC-968 `_) + + + +For the complete list of `SDNC Frankfurt release epics `_ and +`SDNC Frankfurt release user stories `_ , please see the `ONAP Jira`_. + +**Bug fixes** + +The full list of `bugs fixed in the SDNC Frankfurt 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 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 | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ansible-server-image | Ansible server | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-dmaap-listener-image | DMaaP listener | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-image | SDNC controller image, without AAF integration | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ueb-listener-image | SDC listener | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 1.8.2 | ++--------------------------------+-----------------------------------------------------+---------+ + + +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 issues have been addressed in the Frankfurt SDNC release: + +* `OSJI-34 `_ : Multiple SQL Injection issues in SDNC +* `OSJI-40 `_ : SDNC service allows for arbitrary code execution +* `OSJI-41 `_ : SDNC service allows for arbitrary code execution in sla/dgUpload form (CVE-2019-12132) +* `OSJI-42 `_ : SDNC service allows for arbitrary code execution in sla/printAsXml form (CVE-2019-12123) +* `OSJI-43 `_ : SDNC service allows for arbitrary code execution in sla/printAsGv form (CVE-2019-12113) +* `OSJI-199 `_ : SDNC service allows for arbitrary code execution in sla/upload form (CVE-2019-12112) +* `SDNC-1145 `_ : Pods still run as root +* `SDNC-970 `_ : Password removal from OOM Helm charts + +.. _secissues : + +Known Security Issues +~~~~~~~~~~~~~~~~~~~~~ + +There is currently one known SDNC security issue, related to the SDNC portal + +* `OJSI-91 `_ : SDNC exposes unprotected API for user creation + +The current implementation of the SDNC portal has a self-subscription model - so anyone can create an account by going to +the setup link. This is not appropriate for production deployment and will be fixed in a future release. +The SDNC portal is disabled in the Frankfurt helm charts and we recommend that it NOT be enabled in a production +deployment until this issue is corrected. + + + +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 Frankfurt 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/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html