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