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