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