-.. 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.3.0
---------------
-:Release Date: 2018-07-06
-
-**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> |
-+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+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.
+
+
+Release Data
+============
+
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Frankfurt |
+| | |
++-------------------------+-------------------------------------------+
+| **Release date** | 06/04/2020 |
+| | |
++-------------------------+-------------------------------------------+
+
+
+New features
+------------
+
+The SDNC Frankfurt release includes the following features:
+
+* 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>`_)
+
+
+
+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`_.
+
+**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`_.
**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 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>`_.
-
-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 SDNC <https://wiki.onap.org/pages/viewpage.action?pageId=28379582>`_
-
-**Upgrade Notes**
- NA
-
-**Deprecation Notes**
- NA
-
-**Other**
- NA
-
-Version: 1.2.1
---------------
+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 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::
-:Release Date: 2018-01-18
+ docker pull nexus3.onap.org:10001/{image-name}:{version}
-**Bug Fixes**
-- `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
+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.2.0
++--------------------------------+-----------------------------------------------------+---------+
+| 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
--------------
-:Release Date: 2017-11-16
+Fixed Security Issues
+~~~~~~~~~~~~~~~~~~~~~
-**New Features**
+The following security issues have been addressed in the Frankfurt SDNC release:
-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
+* `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
-**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
+.. _secissues :
+
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+There is currently one known SDNC security issue, related to the SDNC portal
+
+* `OJSI-91 <https://jira.onap.org/browse/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**
- NA
-**Upgrade Notes**
- NA
+References
+==========
-**Deprecation Notes**
- NA
+For more information on the ONAP Frankfurt release, please see:
-**Other**
- NA
+#. `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
Code Review / sdnc / oam.git / blobdiff