X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=076bfc2fd735d35dea12d12b47145c72f1316104;hb=3eb32648ea58265ff87d0bc3b1867d0ce0006d69;hp=762c7ed2814982f047aa63ec6ac155cb1050ef28;hpb=389e05bb482e7a775fe9f0b6828042ee0d76f724;p=sdnc%2Foam.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 762c7ed2..076bfc2f 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,143 +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 + +****************** +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. + + +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 `_) +* Multi-Domain Optical Service (Jira `SDNC-928 `_) +* Python 2 -> Python 3 migration (Jira `SDNC-967 `_) +* Upgrade to new Policy lifecycle API (Jira `SDNC-968 `_) -Release Notes -============= -Version: 1.2.0 --------------- +For the complete list of `SDNC Frankfurt release epics `_ and +`SDNC Frankfurt release user stories `_ , please see the `ONAP Jira`_. -:Release Date: 2018-11-16 - - - -**New Features** - -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| Jira # | Abstract | -+=============+=========================================================================================================================+ -| [SDNC-278] | Change management in-place software upgrade execution using Ansible | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-275] | Unit tests for GenericResourceApiProvider class | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-266] | Junit Test Coverage for Epic SDNC-232 | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-250] | Multi-site High-availability - health-monitor reporting | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-223] | Maintain MD-SAL data across docker container upgrades | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-214] | Multi-site High-availability - Kubernetes Federation + Manual Failover (POC) | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-210] | Address issued identified by Sonar | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-163] | Deploy a SDN-C high availability environment - Kubernetes | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-53] | Convert Configuration Subsystem Dependency Injection to Blueprint | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-10] | Refactor MD-SAL applications to conform to current OpenDaylight archetype format | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-6] | Deploy a SDN-C high availability environment | -+-------------+-------------------------------------------------------------------------------------------------------------------------+ - -**Bug Fixes** - -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Jira # | Abstract | -+============+======================================================================================================================================================+ -| [SDNC-313] | LCM does not retrieve status from ansible-server correctly | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-311] | sdnc/features build fails | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-310] | General cleanup of SDNC helm charts | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-309] | ansible adapter properties file missing | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-308] | OOM: Update UEB and DMaaP charts to use new message-router name | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-306] | SDNC fails health check on HEAT deployment | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-305] | No model found for VF module customization UUID | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-303] | aaiclient.properties using wrong JKS | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-302] | SDNC VNF-API ssl certificate error updating AAI | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-299] | OOM deployment with 2+ MySQL instances fails when NFS provisioner disabled | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-298] | SDNC aaiclient.properties should reference v13 A&AI api | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-295] | Ansible server stops | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-293] | DMaaP listener not connecting to DMaaP in OOM deployment | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-292] | Daily build of unused sdnc/features repo fails | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-286] | OOM: SDN-C servers don't come up cleanly when enableClustering=true | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-285] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-284] | sdnc-dgbuilder container image error with onap/ccsdk-dgbuilder-image:0.2.1-SNAPSHOT deleted from nexus3 | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-283] | SDNC fails CSIT | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-279] | sdnc docker build fails | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-277] | SDNC CSIT test fails | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-234] | DMAAP ID in dhcpalert.properties cannot contain "\_" | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-228] | Duplicate test file name | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-207] | generic-resource-api-model: failing on goal yang-maven-plugin - master only - force 1.2.0 over default 2.0.0 | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-203] | SDNC VM & Docker Containers Unstable | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-195] | brg-topology-operations deactivate does not pick up parameters correctly when creating AAI request | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-156] | unknown log fills up on failed DELETE | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-127] | Generated sources not placed under target directory breaks tooling apps | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-105] | Generic Resource API DGs contain old openecomp and com.att based plugin references | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-87] | Accessing invalid network-parameters from network-request-input, it should be network-input-parameters | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-73] | vnfapi: new feature to support softdelete | -+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +**Bug fixes** + +The full list of `bugs fixed in the SDNC Frankfurt release `_ is maintained on the `ONAP Jira`_. **Known Issues** -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| Jira # | Abstract | -+============+==================================================================================================================================+ -| [SDNC-304] | SDNC OOM intermittent Healthcheck failure - JSONDecodeError - on different startup order | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-291] | vCPE Model distribution error in UEB Listener SQL Insert | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-290] | Fix nodePortPrefix in service yaml | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-246] | Passwords stored in clear text in properties files | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-208] | SDNC preload - fix confusion: vnf-name=VF-Module, generic-vnf-name=VNF | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-206] | REST calls from DG | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-115] | VNFAPI DGs contain plugin references to software not part of ONAP | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-114] | Generic API DGs contain plugin references to software not part of ONAP | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-106] | VNFAPI DGs contain old openecomp and com.att based plugin references | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ -| [SDNC-64] | SDNC is not setting FromApp identifier in logging MDC | -+------------+----------------------------------------------------------------------------------------------------------------------------------+ - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** +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 + + +References +========== + +For more information on the ONAP Frankfurt 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/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html