-.. 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
+******************
-Version 1.5.3
--------------
-:Release Date: 2019-06-13
-**New Features**
+Abstract
+========
-The full list of Dublin epics and user stories for SDNC maybe be found at <https://jira.onap.org/issues/?filter=11803>.
+This document provides the release notes for the Frankfurt release of the Software Defined
+Network Controller (SDNC)
-The following list summarizes some of the most significant epics:
+Summary
+=======
-+------------+----------------------------------------------------------------------------+
-| Jira # | Abstract |
-+============+============================================================================+
-| [SDNC-551] | OpenDaylight Fluorine Support |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-564] | 5G Use Case |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-565] | CCVPN Use Case Extension |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-570] | SDN-R: Server side component |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-579] | SDN-R : UX-Client |
-+------------+----------------------------------------------------------------------------+
-| [SDNC-631] | SDNC support for the PNF Use Case Network Assign for Plug and Play feature |
-+------------+----------------------------------------------------------------------------+
+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.
-**Bug Fixes**
-The full list of bug fixes in the SDNC Dublin release may be found at <https://jira.onap.org/issues/?filter=11805>
-**Known Issues**
-The full list of known issues in SDNC may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
+Release Data
+============
-**Security Notes**
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Frankfurt |
+| | |
++-------------------------+-------------------------------------------+
+| **Release date** | 06/04/2020 |
+| | |
++-------------------------+-------------------------------------------+
-*Fixed Security Issues*
-- CVE-2019-12132 `OJSI-41 <https://jira.onap.org/browse/OJSI-41>`_ SDNC service allows for arbitrary code execution in sla/dgUpload form
- Fixed temporarily by disabling admportal
+New features
+------------
-*Known Security Issues*
+The SDNC Frankfurt release includes the following features:
-*Known Vulnerabilities in Used Modules*
+* ORAN-compliant A1 adaptor (Jira `SDNC-965 <https://jira.onap.org/browse/SDNC-965>`_)
+* Multi-Domain Optical Service (Jira `SDNC-928 <https://jira.onap.org/browse/SDNC-928>`_)
+* Python 2 -> Python 3 migration (Jira `SDNC-967 <https://jira.onap.org/browse/SDNC-967>`_)
+* Upgrade to new Policy lifecycle API (Jira `SDNC-968 <https://jira.onap.org/browse/SDNC-968>`_)
-Quick Links:
-- `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>`_
-Version: 1.4.4
---------------
+For the complete list of `SDNC Frankfurt release epics <https://jira.onap.org/issues/?filter=12322>`_ and
+`SDNC Frankfurt release user stories <https://jira.onap.org/issues/?filter=12323>`_ , please see the `ONAP Jira`_.
-**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
---------------
+**Bug fixes**
+The full list of `bugs fixed in the SDNC Frankfurt release <https://jira.onap.org/issues/?filter=12324>`_ is maintained on the `ONAP Jira`_.
-:Release Date: 2018-11-30
+**Known Issues**
-**New Features**
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
-The Casablanca release of SDNC introduces the following new features:
- - Network Discovery, in support of POMBA
- - Support for CCVPN use case
- - Change Management enhancements
+Deprecated Features
+-------------------
-**Bug Fixes**
+** SDNC portal **
-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>
+The SDNC portal is considered deprecated in the Frankfurt release, due
+to resource contraints. This functionality is delivered dormant
+in Frankfurt (i.e. it is disabled in the Frankfurt helm charts) and we
+plan to remove the code entirely in the Guilin release.
+** VNF-API **
-**Known Issues**
+The functionality provided by the VNF-API is now provided as part
+of the GENERIC-RESOURCE-API. Therefore, the VNF-API is deprecated
+in Frankfurt and will be removed in Guilin.
-The list of known issues in the SDNC project may be found in the ONAP Jira at <https://jira.onap.org/issues/?filter=11119>
+Deliverables
+------------
-**Security Notes**
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
-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>`_.
+.. _dockercontainers:
-Quick Links:
+Docker Containers
+`````````````````
-- `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>`_
+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::
-**Upgrade Notes**
- NA
+ docker pull nexus3.onap.org:10001/{image-name}:{version}
-**Deprecation Notes**
- NA
-**Other**
- NA
+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
-Version: 1.3.4
---------------
++--------------------------------+-----------------------------------------------------+---------+
+| Image name | Description | Version |
++================================+=====================================================+=========+
+| onap/sdnc-aaf-image | SDNC controller image, integrated with AAF for RBAC | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image | SDNC controller image, without AAF integration | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image | SDC listener | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 1.8.3 |
++--------------------------------+-----------------------------------------------------+---------+
-:Release Date: 2018-07-06
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-**New Features**
+* `SDN Controller for Radio user guide`_
-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.
+Known Limitations, Issues and Workarounds
+=========================================
-+------------+-------------------------------------------------------------------------------------------------------------+
-| 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> |
-+------------+-------------------------------------------------------------------------------------------------------------+
+System Limitations
+------------------
+No system limitations noted.
-**Bug Fixes**
-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>
+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.
-**Known Issues**
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
-| 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> |
-+------------+----------------------------------------------------------------------------------------------------------------------------------+
+Workarounds
+-----------
+Not applicable.
-**Security Notes**
-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>`_.
+Security Notes
+--------------
-Quick Links:
+Fixed Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-- `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>`_
+The following security issues have been addressed in the Frankfurt SDNC release:
-**Upgrade Notes**
- NA
+* `OSJI-34 <https://jira.onap.org/browse/OJSI-34>`_ : Multiple SQL Injection issues in SDNC
+* `OSJI-40 <https://jira.onap.org/browse/OJSI-40>`_ : SDNC service allows for arbitrary code execution
+* `OSJI-41 <https://jira.onap.org/browse/OJSI-41>`_ : SDNC service allows for arbitrary code execution in sla/dgUpload form (CVE-2019-12132)
+* `OSJI-42 <https://jira.onap.org/browse/OJSI-42>`_ : SDNC service allows for arbitrary code execution in sla/printAsXml form (CVE-2019-12123)
+* `OSJI-43 <https://jira.onap.org/browse/OJSI-43>`_ : SDNC service allows for arbitrary code execution in sla/printAsGv form (CVE-2019-12113)
+* `OSJI-199 <https://jira.onap.org/browse/OJSI-199>`_ : SDNC service allows for arbitrary code execution in sla/upload form (CVE-2019-12112)
+* `SDNC-1145 <https://jira.onap.org/browse/SDNC-1145>`_ : Pods still run as root
+* `SDNC-970 <https://jira.onap.org/browse/SDNC-970>`_ : Password removal from OOM Helm charts
-**Deprecation Notes**
- NA
+.. _secissues :
-**Other**
- NA
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-Version: 1.2.1
---------------
+There is currently one known SDNC security issue, related to the SDNC portal
-:Release Date: 2018-01-18
+* `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
-**Bug Fixes**
+The current implementation of the SDNC portal - which was intended purely
+as a test tool - 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 we strongly recommend that the SDNC portal NOT be used in
+production.
-- `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
+The SDNC portal is disabled in the Frankfurt helm charts and will be removed
+entirely in the Guilin release.
-Version: 1.2.0
---------------
-:Release Date: 2017-11-16
-**New Features**
+Test Results
+============
+Not applicable
-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
+References
+==========
-**Security Issues**
- NA
+For more information on the ONAP Frankfurt release, please see:
-**Upgrade Notes**
- NA
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
-**Deprecation Notes**
- NA
-**Other**
- NA
+.. _`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