docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) ONAP Project and its contributors
   5 .. _release_notes:
   6
   7 *******************
   8 CCSDK Release Notes
   9 *******************
  10
  11
  12 Abstract
  13 ========
  14
  15 This document provides the release notes for the London release of the Common Controller Software
  16 Development Kit (CCSDK).
  17
  18 Summary
  19 =======
  20
  21 The London release of CCSDK introduces enhancements to network slicing and extends support
  22 for ORAN integration via the A1 interface.  It also includes a major OpenDaylight release
  23 upgrade (to Chlorine).
  24
  25
  26 Release Data
  27 ============
  28
  29 +-------------------------+-------------------------------------------+
  30 | **Project**             | CCSDK                                     |
  31 |                         |                                           |
  32 +-------------------------+-------------------------------------------+
  33 | **Docker images**       | See :ref:`dockercontainers` section below |
  34 +-------------------------+-------------------------------------------+
  35 | **Release designation** | London                                    |
  36 |                         |                                           |
  37 +-------------------------+-------------------------------------------+
  38
  39
  40 New features
  41 ------------
  42
  43 The CCSDK London release includes the following features:
  44
  45 *
  46
  47 * Upgrade to OpenDaylight Chlorine Release (Jira `CCSDK-3812 <https://jira.onap.org/browse/CCSDK-3812>`_)
  48 * CCSDK Enhancements for 5G OOF SON use case in London release (Jira `CCSDK-3817 <https://jira.onap.org/browse/CCSDK-3817>`_)
  49 * A1 Adapter and A1 Policy Managements Enhancements in London Release - CCSDK (Jira `CCSDK-3809 <https://jira.onap.org/browse/CCSDK-3809>`_)
  50
  51
  52 For the complete list of `CCSDK London release epics <https://jira.onap.org/issues/?filter=13112>`_ and
  53 `CCSDK London release user stories <https://jira.onap.org/issues/?filter=13113>`_ , please see the `ONAP Jira`_.
  54
  55 **Bug fixes**
  56
  57 The full list of `bugs fixed in the CCSDK London release <https://jira.onap.org/issues/?filter=13114>`_ is maintained on the `ONAP Jira`_.
  58
  59 **Known Issues**
  60
  61 The full list of `known issues in CCSDK <https://jira.onap.org/issues/?filter=11341>`_ is maintained on the `ONAP Jira`_.
  62
  63 It should be noted that several CCSDK repositories have a transitive dependency on log4j version 1.x.  While this version
  64 is not vulnerable to the recent 'log4shell' vulnerability, there are other known vulnerabilities in this
  65 version.  The following table summarizes where log4j 1.x is currently used in CCSDK:
  66
  67 +----------------+-----------------------------------------------------------------------------------+
  68 | Repository     | Transitive dependencies                                                           |
  69 +================+===================================================================================+
  70 | ccsdk/apps     | org.onap.aaf.authz:aaf-misc-env:2.1.21 -> log4j:log4j:1.2.17                      |
  71 +----------------+-----------------------------------------------------------------------------------+
  72 | ccsdk/cds      | org.hibernate:hibernate-testing:jar:5.4.32.Final -> log4j:log4j:1.2.17            |
  73 +----------------+-----------------------------------------------------------------------------------+
  74 |                | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.5 -> log4j:log4j:1.2.17  |
  75 +----------------+-----------------------------------------------------------------------------------+
  76 | ccsdk/features | org.onap.aaf.authz:aaf-misc-env:2.1.21 -> log4j:log4j:1.2.17                      |
  77 +----------------+-----------------------------------------------------------------------------------+
  78 |                | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.12 -> log4j:log4j:1.2.17 |
  79 +----------------+-----------------------------------------------------------------------------------+
  80 | ccsdk/sli      | org.onap.dmaap.messagerouter.dmaapclient:dmaapClient:1.1.12 -> log4j:log4j:1.2.17 |
  81 +----------------+-----------------------------------------------------------------------------------+
  82
  83
  84
  85 Deliverables
  86 ------------
  87
  88 Software Deliverables
  89 ~~~~~~~~~~~~~~~~~~~~~
  90
  91 .. _dockercontainers:
  92
  93 Docker Containers
  94 `````````````````
  95
  96 The following table lists the docker containers comprising the CCSDK London
  97 release along with the current stable London version/tag.  Each of these is
  98 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  99 with the following command::
 100
 101    docker pull nexus3.onap.org:10001/{image-name}:{version}
 102
 103
 104 Note: users that want to use the latest in-development London version may use the
 105 tag 1.3-STAGING-latest to pull the latest daily London build
 106
 107 +------------------------------------------+--------------------------------------------+---------+
 108 | Image name                               | Description                                | Version |
 109 +==========================================+============================================+=========+
 110 | onap/ccsdk-alpine-j11-image              | Base Alpine Linux image for CCSDK          | 1.5.2   |
 111 +------------------------------------------+--------------------------------------------+---------+
 112 | onap/ccsdk-ansible-server-image          | Ansible server image                       | 1.5.2   |
 113 +------------------------------------------+--------------------------------------------+---------+
 114 | onap/ccsdk-apps-ms-neng                  | Naming microservice                        | 1.4.1   |
 115 +------------------------------------------+--------------------------------------------+---------+
 116 | onap/ccsdk-blueprints-processor          | CDS blueprint processor                    | 1.5.1   |
 117 +------------------------------------------+--------------------------------------------+---------+
 118 | onap/ccsdk-cds-ui-server                 | CDS user interface back end                | 1.5.1   |
 119 +------------------------------------------+--------------------------------------------+---------+
 120 | onap/ccsdk-commandexecutor               | CDS command executor                       | 1.5.1   |
 121 +------------------------------------------+--------------------------------------------+---------+
 122 | onap/ccsdk-controllerblueprint           | CDS controller blueprints                  | 1.5.1   |
 123 +------------------------------------------+--------------------------------------------+---------+
 124 | onap/ccsdk-dgbuilder-image               | Directed graph builder                     | 1.5.2   |
 125 +------------------------------------------+--------------------------------------------+---------+
 126 | onap/ccsdk-odl-chlorine-alpine-image     | Alpine based OpenDaylight Chlorine image   | 1.5.2   |
 127 +------------------------------------------+--------------------------------------------+---------+
 128 | onap/ccsdk-odlsli-alpine-image           | Alpine based OpenDaylight image with CCSDK | 1.5.2   |
 129 +------------------------------------------+--------------------------------------------+---------+
 130 | onap/ccsdk-saltstack-server-image        | Saltstack server                           | 1.5.2   |
 131 +------------------------------------------+--------------------------------------------+---------+
 132 | onap/ccsdk-sdclistener                   | CDS SDC listener                           | 1.5.1   |
 133 +------------------------------------------+--------------------------------------------+---------+
 134 | onap/ccsdk-ubuntu-image                  | Base Ubuntu image for CCSDK                | 1.5.2   |
 135 +------------------------------------------+--------------------------------------------+---------+
 136
 137 Maven Artifacts
 138 ```````````````
 139 In addition to docker containers, CCSDK also provides libraries that are intended to be used by
 140 client applications (e.g. APPC, SDNC) as maven dependencies.
 141
 142
 143 ccsdk/parent
 144 ^^^^^^^^^^^^
 145 Many CCSDK clients need to be able to inherit settings from third party parent poms provided
 146 by OpenDaylight or springboot, and therefore are unable to use the standard ONAP parent pom.
 147 The CCSDK parent repository provides its own version of parent poms whose contents are consistent
 148 with ONAP standard settings (as defined in oparent), but whose parent is the OpenDaylight or
 149 springboot parent, so that clients can effectively merge both sets of settings.
 150
 151 The following table lists the parent poms provided by CCSDK and the current stable
 152 Frankfurt version of each.
 153
 154 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 155 | groupId               | artifactId                    | version | Description                                                                                      |
 156 +=======================+===============================+=========+==================================================================================================+
 157 | org.onap.ccsdk.parent | binding-parent                | 2.5.4   | Parent used in place of OpenDaylight binding-parent                                              |
 158 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 159 | org.onap.ccsdk.parent | bundle-parent                 | 2.5.4   | Parent used in place of OpenDaylight bundle-parent                                               |
 160 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 161 | org.onap.ccsdk.parent | client-parent                 | 2.5.4   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
 162 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 163 | org.onap.ccsdk.parent | dependencies-bom              | 2.5.4   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
 164 |                       |                               |         | Intended to be imported in dependencyManagement section.                                         |
 165 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 166 | 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.  |
 167 |                       |                               |         | Intended to be imported in dependencyManagement section.                                         |
 168 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 169 | org.onap.ccsdk.parent | feature-repo-parent           | 2.5.4   | Parent used in place of OpenDaylight feature-repo-parent                                         |
 170 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 171 | org.onap.ccsdk.parent | karaf4-parent                 | 2.5.4   | Parent used in place of OpenDaylight karaf4-parent                                               |
 172 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 173 | org.onap.ccsdk.parent | mdsal-it-parent               | 2.5.4   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
 174 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 175 | org.onap.ccsdk.parent | odlparent                     | 2.5.4   | Parent used in place of OpenDaylight odlparent                                                   |
 176 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 177 | org.onap.ccsdk.parent | odlparent-lite                | 2.5.4   | Parent used in place of OpenDaylight odlparent-lite                                              |
 178 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 179 | org.onap.ccsdk.parent | single-feature-parent         | 2.5.4   | Parent used in place of OpenDaylight single-feature-parent                                       |
 180 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 181 | 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.                           |
 182 |                       |                               |         | *NOTE* This is deprecated and will be removed in a future release, since springboot 1.x should   |
 183 |                       |                               |         | no longer be used due to security issues                                                         |
 184 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 185 | 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                          |
 186 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 187 | 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                          |
 188 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 189 | 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                          |
 190 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 191 | org.onap.ccsdk.parent | standalone-parent             | 2.5.4   | Parent used for projects that have no need for other third party parent poms                     |
 192 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
 193
 194 ccsdk/sli
 195 ^^^^^^^^^^^^^^
 196 The ccsdk/sli library provides the Service Logic Interpreter (SLI), which is the engine that runs directed graphs.  It also
 197 provides a number of libraries that can be used by other CCSDK client projects.
 198
 199 The following table lists the maven artifacts provided for use by CCSDK client
 200 projects.
 201
 202 +-------------------------------+------------------------------+---------+--------------------------------------------+
 203 | groupId                       | artifactId                   | version | Description                                |
 204 +===============================+==============================+=========+============================================+
 205 | org.onap.ccsdk.sli.core       | dblib-provider               | 1.6.3   | Database access library                    |
 206 +-------------------------------+------------------------------+---------+--------------------------------------------+
 207 | org.onap.ccsdk.sli.core       | sli-common                   | 1.6.3   | Common SLI data objects                    |
 208 +-------------------------------+------------------------------+---------+--------------------------------------------+
 209 | org.onap.ccsdk.sli.core       | sli-provider-base            | 1.6.3   | ODL-independent SLI implementation objects |
 210 +-------------------------------+------------------------------+---------+--------------------------------------------+
 211 | org.onap.ccsdk.sli.core       | sli-provider                 | 1.6.3   | ODL-dependent SLI implementation objects   |
 212 +-------------------------------+------------------------------+---------+--------------------------------------------+
 213 | org.onap.ccsdk.sli.core       | sliPluginUtils-provider      | 1.6.3   | Utilities for use in SLI adaptors/plugins  |
 214 +-------------------------------+------------------------------+---------+--------------------------------------------+
 215 | org.onap.ccsdk.sli.core       | utils-provider               | 1.6.3   | Utilities                                  |
 216 +-------------------------------+------------------------------+---------+--------------------------------------------+
 217 | org.onap.ccsdk.sli.adaptors   | aai-service-provider         | 1.6.3   | A&AI interface adaptor                     |
 218 +-------------------------------+------------------------------+---------+--------------------------------------------+
 219 | org.onap.ccsdk.sli.adaptors   | ansible-adapter-bundle       | 1.6.3   | Ansible interface adaptor                  |
 220 +-------------------------------+------------------------------+---------+--------------------------------------------+
 221 | org.onap.ccsdk.sli.adaptors   | mdsal-resource-provider      | 1.6.3   | MD-SAL interface adaptor                   |
 222 +-------------------------------+------------------------------+---------+--------------------------------------------+
 223 | org.onap.ccsdk.sli.adaptors   | netbox-client-provider       | 1.6.3   | netbox interface adaptor                   |
 224 +-------------------------------+------------------------------+---------+--------------------------------------------+
 225 | org.onap.ccsdk.sli.adaptors   | resource-assignment-provider | 1.6.3   | resource allocator                         |
 226 +-------------------------------+------------------------------+---------+--------------------------------------------+
 227 | org.onap.ccsdk.sli.adaptors   | saltstack-adaptor-provider   | 1.6.3   | saltstack interface adaptor                |
 228 +-------------------------------+------------------------------+---------+--------------------------------------------+
 229 | org.onap.ccsdk.sli.adaptors   | sql-resource-provider        | 1.6.3   | SQL database interface adaptor             |
 230 +-------------------------------+------------------------------+---------+--------------------------------------------+
 231 | org.onap.ccsdk.sli.northbound | asdcApi-provider             | 1.6.3   | ODL-based SDC interface                    |
 232 +-------------------------------+------------------------------+---------+--------------------------------------------+
 233 | org.onap.ccsdk.sli.northbound | dataChange-provider          | 1.6.3   | A&AI data change notification interface    |
 234 +-------------------------------+------------------------------+---------+--------------------------------------------+
 235 | org.onap.ccsdk.sli.northbound | dmaap-listener               | 1.6.3   | DMaaP listener interface                   |
 236 +-------------------------------+------------------------------+---------+--------------------------------------------+
 237 | org.onap.ccsdk.sli.northbound | lcm-provider                 | 1.6.3   | Life Cycle Management event interface      |
 238 +-------------------------------+------------------------------+---------+--------------------------------------------+
 239 | org.onap.ccsdk.sli.northbound | ueb-listener                 | 1.6.3   | SDC event listener                         |
 240 +-------------------------------+------------------------------+---------+--------------------------------------------+
 241 | org.onap.ccsdk.sli.plugins    | properties-node-provider     | 1.6.3   | Used to load a properties file for use in  |
 242 |                               |                              |         | a directed graph                           |
 243 +-------------------------------+------------------------------+---------+--------------------------------------------+
 244 | org.onap.ccsdk.sli.plugins    | restapi-call-node-provider   | 1.6.3   | Used to call a generic REST API from a     |
 245 |                               |                              |         | directed graph                             |
 246 +-------------------------------+------------------------------+---------+--------------------------------------------+
 247 | org.onap.ccsdk.sli.plugins    | restconf-client-provider     | 1.6.3   | Used to call a RESTCONF API from a         |
 248 |                               |                              |         | directed graph                             |
 249 +-------------------------------+------------------------------+---------+--------------------------------------------+
 250 | org.onap.ccsdk.sli.plugins    | sshapi-call-node             | 1.6.3   | Used to invoke an SSH interface from a     |
 251 |                               |                              |         | directed graph                             |
 252 +-------------------------------+------------------------------+---------+--------------------------------------------+
 253 | org.onap.ccsdk.sli.plugins    | template-node-provider       | 1.6.3   | Provides velocity template support         |
 254 +-------------------------------+------------------------------+---------+--------------------------------------------+
 255
 256 Documentation Deliverables
 257 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 258 * `CDS user guide`_
 259 * `SDN Controller for Radio user guide`_
 260
 261 Known Limitations, Issues and Workarounds
 262 =========================================
 263
 264 System Limitations
 265 ------------------
 266
 267 No system limitations noted.
 268
 269
 270 Known Vulnerabilities
 271 ---------------------
 272
 273 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 274 pertain to CCSDK are listed in the :ref:`secissues` section below.
 275
 276
 277 Workarounds
 278 -----------
 279
 280 Not applicable.
 281
 282
 283 Security Notes
 284 --------------
 285
 286 Fixed Security Issues
 287 ~~~~~~~~~~~~~~~~~~~~~
 288
 289 There are no new security fixes in the London release.
 290
 291 .. _secissues :
 292
 293 Known Security Issues
 294 ~~~~~~~~~~~~~~~~~~~~~
 295
 296 There is currently only one known CCSDK security issue, related to a third party application (netbox) that CCSDK uses:
 297
 298 * `OJSI-160 <https://jira.onap.org/browse/OJSI-160>`_ : netbox-nginx exposes plain text HTTP endpoint using port 30420
 299
 300
 301
 302 Test Results
 303 ============
 304 Not applicable
 305
 306
 307 References
 308 ==========
 309
 310 For more information on the ONAP London release, please see:
 311
 312 #. `ONAP Home Page`_
 313 #. `ONAP Documentation`_
 314 #. `ONAP Release Downloads`_
 315 #. `ONAP Wiki Page`_
 316
 317
 318 .. _`ONAP Home Page`: https://www.onap.org
 319 .. _`ONAP Wiki Page`: https://wiki.onap.org
 320 .. _`ONAP Documentation`: https://docs.onap.org
 321 .. _`ONAP Release Downloads`: https://git.onap.org
 322 .. _`ONAP Jira`: https://jira.onap.org
 323 .. _`CDS user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html
 324 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html