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