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