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