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