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