X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Frelease-notes.rst;h=7f40550e8b97dcb7cbccc7fbfc9ef03634b1bf0a;hb=refs%2Fheads%2Fmaster;hp=94b4fc6218ae7f1740738fadee639e52022c8fcd;hpb=53afd94577da327523a887d2c8a2d2c182f76e5d;p=ccsdk%2Fdistribution.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 94b4fc62..7f40550e 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,45 +1,324 @@ -.. 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 -============= +******************* +CCSDK Release Notes +******************* -Version: 0.1.0 --------------- +Abstract +======== + +This document provides the release notes for the London release of the Common Controller Software +Development Kit (CCSDK). + +Summary +======= + +The London release of CCSDK introduces enhancements to network slicing and extends support +for ORAN integration via the A1 interface. It also includes a major OpenDaylight release +upgrade (to Chlorine). + + +Release Data +============ + ++-------------------------+-------------------------------------------+ +| **Project** | CCSDK | +| | | ++-------------------------+-------------------------------------------+ +| **Docker images** | See :ref:`dockercontainers` section below | ++-------------------------+-------------------------------------------+ +| **Release designation** | London | +| | | ++-------------------------+-------------------------------------------+ -:Release Date: 2017-11-16 +New features +------------ +The CCSDK London release includes the following features: -**New Features** +* -The Common Controller SDK provides the following functionality : - - Service Logic Interpreter - - Database access library (dblib) - - Service Logic test api (sliapi) - - MD-SAL data query adaptor - - SQL query adaptor - - Resource allocator - - SDC interface - - DMAAP interface - - REST API adaptor +* Upgrade to OpenDaylight Chlorine Release (Jira `CCSDK-3812 `_) +* CCSDK Enhancements for 5G OOF SON use case in London release (Jira `CCSDK-3817 `_) +* A1 Adapter and A1 Policy Managements Enhancements in London Release - CCSDK (Jira `CCSDK-3809 `_) -**Bug Fixes** +For the complete list of `CCSDK London release epics `_ and +`CCSDK London release user stories `_ , please see the `ONAP Jira`_. + +**Bug fixes** + +The full list of `bugs fixed in the CCSDK London release `_ is maintained on the `ONAP Jira`_. **Known Issues** - - `CCSDK-110 `_ Resolve license issues in dashboard project - - `CCSDK-136 `_ pgaas is dependent on location_prefix being all lowercase - - `CCSDK-137 `_ isolate deprecated methods -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ +The full list of `known issues in CCSDK `_ is maintained on the `ONAP Jira`_. + +It should be noted that several CCSDK repositories have a transitive dependency on log4j version 1.x. While this version +is not vulnerable to the recent 'log4shell' vulnerability, there are other known vulnerabilities in this +version. The following table summarizes where log4j 1.x is currently used in CCSDK: + ++----------------+-----------------------------------------------------------------------------------+ +| Repository | Transitive dependencies | ++================+===================================================================================+ +| ccsdk/apps | org.onap.aaf.authz:aaf-misc-env:2.1.21 -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ +| ccsdk/cds | org.hibernate:hibernate-testing:jar:5.4.32.Final -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ +| | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.5 -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ +| ccsdk/features | org.onap.aaf.authz:aaf-misc-env:2.1.21 -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ +| | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.12 -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ +| ccsdk/sli | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.12 -> log4j:log4j:1.2.17 | ++----------------+-----------------------------------------------------------------------------------+ + + + +Deliverables +------------ + +Software Deliverables +~~~~~~~~~~~~~~~~~~~~~ + +.. _dockercontainers: + +Docker Containers +````````````````` + +The following table lists the docker containers comprising the CCSDK London +release along with the current stable London 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 London version may use the +tag 1.3-STAGING-latest to pull the latest daily London build + ++------------------------------------------+--------------------------------------------+---------+ +| Image name | Description | Version | ++==========================================+============================================+=========+ +| onap/ccsdk-alpine-j11-image | Base Alpine Linux image for CCSDK | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-ansible-server-image | Ansible server image | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-apps-ms-neng | Naming microservice | 1.4.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-blueprints-processor | CDS blueprint processor | 1.5.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-cds-ui-server | CDS user interface back end | 1.5.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-commandexecutor | CDS command executor | 1.5.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-controllerblueprint | CDS controller blueprints | 1.5.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-dgbuilder-image | Directed graph builder | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-odl-chlorine-alpine-image | Alpine based OpenDaylight Chlorine image | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-odlsli-alpine-image | Alpine based OpenDaylight image with CCSDK | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-saltstack-server-image | Saltstack server | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-sdclistener | CDS SDC listener | 1.5.1 | ++------------------------------------------+--------------------------------------------+---------+ +| onap/ccsdk-ubuntu-image | Base Ubuntu image for CCSDK | 1.5.2 | ++------------------------------------------+--------------------------------------------+---------+ + +Maven Artifacts +``````````````` +In addition to docker containers, CCSDK also provides libraries that are intended to be used by +client applications (e.g. APPC, SDNC) as maven dependencies. + + +ccsdk/parent +^^^^^^^^^^^^ +Many CCSDK clients need to be able to inherit settings from third party parent poms provided +by OpenDaylight or springboot, and therefore are unable to use the standard ONAP parent pom. +The CCSDK parent repository provides its own version of parent poms whose contents are consistent +with ONAP standard settings (as defined in oparent), but whose parent is the OpenDaylight or +springboot parent, so that clients can effectively merge both sets of settings. + +The following table lists the parent poms provided by CCSDK and the current stable +Frankfurt version of each. + ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| groupId | artifactId | version | Description | ++=======================+===============================+=========+==================================================================================================+ +| org.onap.ccsdk.parent | binding-parent | 2.5.4 | Parent used in place of OpenDaylight binding-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | bundle-parent | 2.5.4 | Parent used in place of OpenDaylight bundle-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | client-parent | 2.5.4 | Parent used for projects that create client libraries for OpenDaylight APIs | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | dependencies-bom | 2.5.4 | Bill of Materials POM that defines versions of third party libraries used outside ODL container. | +| | | | Intended to be imported in dependencyManagement section. | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | dependencies-odl-bom | 2.5.4 | Bill of Materials POM that defines versions of third party libraries used within ODL container. | +| | | | Intended to be imported in dependencyManagement section. | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | feature-repo-parent | 2.5.4 | Parent used in place of OpenDaylight feature-repo-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | karaf4-parent | 2.5.4 | Parent used in place of OpenDaylight karaf4-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | mdsal-it-parent | 2.5.4 | Parent used in place of OpenDaylight mdsal-it-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | odlparent | 2.5.4 | Parent used in place of OpenDaylight odlparent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | odlparent-lite | 2.5.4 | Parent used in place of OpenDaylight odlparent-lite | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | single-feature-parent | 2.5.4 | Parent used in place of OpenDaylight single-feature-parent | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | spring-boot-1-starter-parent | 2.5.4 | Parent used in place of spring-boot-starter-parent for Springboot 1.x. | +| | | | *NOTE* This is deprecated and will be removed in a future release, since springboot 1.x should | +| | | | no longer be used due to security issues | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | spring-boot-25-starter-parent | 2.5.4 | Parent used in place of spring-boot-starter-parent for Springboot 2.5.x | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | spring-boot-26-starter-parent | 2.5.4 | Parent used in place of spring-boot-starter-parent for Springboot 2.6.x | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | spring-boot-starter-parent | 2.5.4 | Parent used in place of spring-boot-starter-parent for Springboot 2.3.x | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ +| org.onap.ccsdk.parent | standalone-parent | 2.5.4 | Parent used for projects that have no need for other third party parent poms | ++-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+ + +ccsdk/sli +^^^^^^^^^^^^^^ +The ccsdk/sli library provides the Service Logic Interpreter (SLI), which is the engine that runs directed graphs. It also +provides a number of libraries that can be used by other CCSDK client projects. + +The following table lists the maven artifacts provided for use by CCSDK client +projects. + ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| groupId | artifactId | version | Description | ++===============================+==============================+=========+============================================+ +| org.onap.ccsdk.sli.core | dblib-provider | 1.6.3 | Database access library | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.core | sli-common | 1.6.3 | Common SLI data objects | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.core | sli-provider-base | 1.6.3 | ODL-independent SLI implementation objects | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.core | sli-provider | 1.6.3 | ODL-dependent SLI implementation objects | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.core | sliPluginUtils-provider | 1.6.3 | Utilities for use in SLI adaptors/plugins | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.core | utils-provider | 1.6.3 | Utilities | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | aai-service-provider | 1.6.3 | A&AI interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | ansible-adapter-bundle | 1.6.3 | Ansible interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | mdsal-resource-provider | 1.6.3 | MD-SAL interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | netbox-client-provider | 1.6.3 | netbox interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | resource-assignment-provider | 1.6.3 | resource allocator | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | saltstack-adaptor-provider | 1.6.3 | saltstack interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.adaptors | sql-resource-provider | 1.6.3 | SQL database interface adaptor | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.northbound | asdcApi-provider | 1.6.3 | ODL-based SDC interface | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.northbound | dataChange-provider | 1.6.3 | A&AI data change notification interface | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.northbound | dmaap-listener | 1.6.3 | DMaaP listener interface | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.northbound | lcm-provider | 1.6.3 | Life Cycle Management event interface | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.northbound | ueb-listener | 1.6.3 | SDC event listener | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.plugins | properties-node-provider | 1.6.3 | Used to load a properties file for use in | +| | | | a directed graph | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.plugins | restapi-call-node-provider | 1.6.3 | Used to call a generic REST API from a | +| | | | directed graph | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.plugins | restconf-client-provider | 1.6.3 | Used to call a RESTCONF API from a | +| | | | directed graph | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.plugins | sshapi-call-node | 1.6.3 | Used to invoke an SSH interface from a | +| | | | directed graph | ++-------------------------------+------------------------------+---------+--------------------------------------------+ +| org.onap.ccsdk.sli.plugins | template-node-provider | 1.6.3 | Provides velocity template support | ++-------------------------------+------------------------------+---------+--------------------------------------------+ + +Documentation Deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~ +* `CDS user guide`_ +* `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 CCSDK are listed in the :ref:`secissues` section below. + + +Workarounds +----------- + +Not applicable. + + +Security Notes +-------------- + +Fixed Security Issues +~~~~~~~~~~~~~~~~~~~~~ + +There are no new security fixes in the London release. + +.. _secissues : + +Known Security Issues +~~~~~~~~~~~~~~~~~~~~~ + +There is currently only one known CCSDK security issue, related to a third party application (netbox) that CCSDK uses: + +* `OJSI-160 `_ : netbox-nginx exposes plain text HTTP endpoint using port 30420 + + + +Test Results +============ +Not applicable + +References +========== -**Upgrade Notes** +For more information on the ONAP London 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 +.. _`CDS user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html +.. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html