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
   6 *******************
   7 CCSDK Release Notes
   8 *******************
   9
  10
  11 Abstract
  12 ========
  13
  14 This document provides the release notes for the Frankfurt release of the Common Controller Software
  15 Development Kit (CCSDK).
  16
  17 Summary
  18 =======
  19
  20 The Frankfurt release of CCSDK introduces new functionality to support PNFs (Physical Network Functions), extends support
  21 for Netconf/TLS to support CMPv2, and extends CDS to act as an agent in self-serve control loops.
  22
  23
  24 Release Data
  25 ============
  26
  27 +-------------------------+-------------------------------------------+
  28 | **Project**             | CCSDK                                     |
  29 |                         |                                           |
  30 +-------------------------+-------------------------------------------+
  31 | **Docker images**       | See :ref:`dockercontainers` section below |
  32 +-------------------------+-------------------------------------------+
  33 | **Release designation** | Frankfurt                                 |
  34 |                         |                                           |
  35 +-------------------------+-------------------------------------------+
  36 | **Release date**        | 06/04/2020                                |
  37 |                         |                                           |
  38 +-------------------------+-------------------------------------------+
  39
  40
  41 New features
  42 ------------
  43
  44 The CCSDK Frankfurt release includes the following features:
  45
  46 * First phase of OpenDaylight separation (Jira `CCSDK-8 <https://jira.onap.org/browse/CCSDK-8>`_), currently targeted for completion in Guilin
  47 * Integration of CDS as an actor in Control loops (Jira `CCSDK-1898 <https://jira.onap.org/browse/CCSDK-1898>`_)
  48 * ORAN-compliant A1 adaptor (Jira `CCSDK-1796 <https://jira.onap.org/browse/CCSDK-1796>`_)
  49 * Multi-Domain Optical Service (Jira `CCSDK-1828 <https://jira.onap.org/browse/CCSDK-1828>`_)
  50 * Python 2 -> Python 3 migration (Jira `CCSDK-1905 <https://jira.onap.org/browse/CCSDK-1905>`_)
  51
  52
  53 For the complete list of `CCSDK Frankfurt release epics <https://jira.onap.org/issues/?filter=12316>`_ and
  54 `CCSDK Frankfurt release user stories <https://jira.onap.org/issues/?filter=12319>`_ , please see the `ONAP Jira`_.
  55
  56 **Bug fixes**
  57
  58 The full list of `bugs fixed in the CCSDK Frankfurt release <https://jira.onap.org/issues/?filter=12320>`_ is maintained on the `ONAP Jira`_.
  59
  60 **Known Issues**
  61
  62 The full list of `known issues in CCSDK <https://jira.onap.org/issues/?filter=11341>`_ is maintained on the `ONAP Jira`_.
  63
  64 Deliverables
  65 ------------
  66
  67 Software Deliverables
  68 ~~~~~~~~~~~~~~~~~~~~~
  69
  70 .. _dockercontainers:
  71
  72 Docker Containers
  73 `````````````````
  74
  75 The following table lists the docker containers comprising the CCSDK Frankfurt
  76 release along with the current stable Frankfurt version/tag.  Each of these is
  77 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  78 with the following command::
  79
  80    docker pull nexus3.onap.org:10001/{image-name}:{version}
  81
  82
  83 Note: users that want to use the latest in-development Frankfurt version may use the
  84 tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
  85
  86 +-----------------------------------+--------------------------------------------+---------+
  87 | Image name                        | Description                                | Version |
  88 +===================================+============================================+=========+
  89 | onap/ccsdk-alpine-image           | Base Alpine Linux image for CCSDK          | 0.7.3   |
  90 +-----------------------------------+--------------------------------------------+---------+
  91 | onap/ccsdk-ansible-server-image   | Ansible server image                       | 0.7.3   |
  92 +-----------------------------------+--------------------------------------------+---------+
  93 | onap/ccsdk-apps-ms-neng           | Naming microservice                        | 0.7.1   |
  94 +-----------------------------------+--------------------------------------------+---------+
  95 | onap/ccsdk-blueprints-processor   | CDS blueprint processor                    | 0.7.2   |
  96 +-----------------------------------+--------------------------------------------+---------+
  97 | onap/ccsdk-cds-ui                 | CDS web interface                          | 0.7.2   |
  98 +-----------------------------------+--------------------------------------------+---------+
  99 | onap/ccsdk-cds-ui-server          | CDS user interface back end                | 0.7.2   |
 100 +-----------------------------------+--------------------------------------------+---------+
 101 | onap/ccsdk-commandexecutor        | CDS command executor                       | 0.7.2   |
 102 +-----------------------------------+--------------------------------------------+---------+
 103 | onap/ccsdk-controllerblueprint    | CDS controller blueprints                  | 0.7.2   |
 104 +-----------------------------------+--------------------------------------------+---------+
 105 | onap/ccsdk-dgbuilder-image        | Directed graph builder                     | 0.7.2   |
 106 +-----------------------------------+--------------------------------------------+---------+
 107 | onap/ccsdk-odl-neon-alpine-image  | Alpine based OpenDaylight Neon SR1 image   | 0.7.3   |
 108 +-----------------------------------+--------------------------------------------+---------+
 109 | onap/ccsdk-odlsli-alpine-image    | Alpine based OpenDaylight image with CCSDK | 0.7.3   |
 110 +-----------------------------------+--------------------------------------------+---------+
 111 | onap/ccsdk-saltstack-server-image | Saltstack server                           | 0.7.3   |
 112 +-----------------------------------+--------------------------------------------+---------+
 113 | onap/ccsdk-sdclistener            | CDS SDC listener                           | 0.7.2   |
 114 +-----------------------------------+--------------------------------------------+---------+
 115 | onap/ccsdk-ubuntu-image           | Base Ubuntu image for CCSDK                | 0.7.3   |
 116 +-----------------------------------+--------------------------------------------+---------+
 117
 118 Maven Artifacts
 119 ```````````````
 120 In addition to docker containers, CCSDK also provides libraries that are intended to be used by
 121 client applications (e.g. APPC, SDNC) as maven dependencies.
 122
 123
 124 ccsdk/parent
 125 ^^^^^^^^^^^^
 126 Many CCSDK clients need to be able to inherit settings from third party parent poms provided
 127 by OpenDaylight or springboot, and therefore are unable to use the standard ONAP parent pom.
 128 The CCSDK parent repository provides its own version of parent poms whose contents are consistent
 129 with ONAP standard settings (as defined in oparent), but whose parent is the OpenDaylight or
 130 springboot parent, so that clients can effectively merge both sets of settings.
 131
 132 The following table lists the parent poms provided by CCSDK and the current stable
 133 Frankfurt version of each.
 134
 135 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 136 | groupId               | artifactId                   | version | Description                                                                                      |
 137 +=======================+==============================+=========+==================================================================================================+
 138 | org.onap.ccsdk.parent | binding-parent               | 1.5.4   | Parent used in place of OpenDaylight binding-parent                                              |
 139 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 140 | org.onap.ccsdk.parent | bundle-parent                | 1.5.4   | Parent used in place of OpenDaylight bundle-parent                                               |
 141 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 142 | org.onap.ccsdk.parent | client-parent                | 1.5.4   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
 143 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 144 | org.onap.ccsdk.parent | dependencies-bom             | 1.5.4   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
 145 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 146 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 147 | org.onap.ccsdk.parent | dependencies-odl-bom         | 1.5.4   | Bill of Materials POM that defines versions of third party libraries used within ODL container.  |
 148 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 149 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 150 | org.onap.ccsdk.parent | feature-repo-parent          | 1.5.4   | Parent used in place of OpenDaylight feature-repo-parent                                         |
 151 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 152 | org.onap.ccsdk.parent | karaf4-parent                | 1.5.4   | Parent used in place of OpenDaylight karaf4-parent                                               |
 153 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 154 | org.onap.ccsdk.parent | mdsal-it-parent              | 1.5.4   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
 155 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 156 | org.onap.ccsdk.parent | odlparent                    | 1.5.4   | Parent used in place of OpenDaylight odlparent                                                   |
 157 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 158 | org.onap.ccsdk.parent | odlparent-lite               | 1.5.4   | Parent used in place of OpenDaylight odlparent-lite                                              |
 159 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 160 | org.onap.ccsdk.parent | single-feature-parent        | 1.5.4   | Parent used in place of OpenDaylight single-feature-parent                                       |
 161 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 162 | org.onap.ccsdk.parent | spring-boot-1-starter-parent | 1.5.4   | Parent used in place of spring-boot-starter-parent for Springboot 1.x.                           |
 163 |                       |                              |         | *NOTE* This is deprecated and will be removed in Guilin, since springboot 1.x should no          |
 164 |                       |                              |         | longer be used due to security issues                                                            |
 165 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 166 | org.onap.ccsdk.parent | spring-boot-starter-parent   | 1.5.4   | Parent used in place of spring-boot-starter-parent for Springboot 2.x                            |
 167 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 168 | org.onap.ccsdk.parent | standalone-parent            | 1.5.4   | Parent used for projects that have no need for other third party parent poms                     |
 169 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 170
 171 ccsdk/sli/core
 172 ^^^^^^^^^^^^^^
 173 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
 174 provides a number of libraries that can be used by other CCSDK client projects.
 175
 176 The following table lists the maven artifacts provided for use by CCSDK client
 177 projects.
 178
 179 +-------------------------+-------------------------+---------+--------------------------------------------+
 180 | groupId                 | artifactId              | version | Description                                |
 181 +=========================+=========================+=========+============================================+
 182 | org.onap.ccsdk.sli.core | dblib-provider          | 0.7.2   | Database access library                    |
 183 +-------------------------+-------------------------+---------+--------------------------------------------+
 184 | org.onap.ccsdk.sli.core | sli-common              | 0.7.2   | Common SLI data objects                    |
 185 +-------------------------+-------------------------+---------+--------------------------------------------+
 186 | org.onap.ccsdk.sli.core | sli-provider-base       | 0.7.2   | ODL-independent SLI implementation objects |
 187 +-------------------------+-------------------------+---------+--------------------------------------------+
 188 | org.onap.ccsdk.sli.core | sli-provider            | 0.7.2   | ODL-dependent SLI implementation objects   |
 189 +-------------------------+-------------------------+---------+--------------------------------------------+
 190 | org.onap.ccsdk.sli.core | sliPluginUtils-provider | 0.7.2   | Utilities for use in SLI adaptors/plugins  |
 191 +-------------------------+-------------------------+---------+--------------------------------------------+
 192 | org.onap.ccsdk.sli.core | utils-provider          | 0.7.2   | Utilities                                  |
 193 +-------------------------+-------------------------+---------+--------------------------------------------+
 194
 195 ccsdk/sli/adaptors
 196 ^^^^^^^^^^^^^^^^^^
 197 The ccsdk/sli/adaptors library provides interface adaptors meant to be used in resource nodes in directed graphs.
 198
 199 The following table lists the maven artifacts provided for use by CCSDK client
 200 projects.
 201
 202 +-----------------------------+------------------------------+---------+--------------------------------+
 203 | groupId                     | artifactId                   | version | Description                    |
 204 +=============================+==============================+=========+================================+
 205 | org.onap.ccsdk.sli.adaptors | aai-service-provider         | 0.7.2   | A&AI interface adaptor         |
 206 +-----------------------------+------------------------------+---------+--------------------------------+
 207 | org.onap.ccsdk.sli.adaptors | ansible-adapter-bundle       | 0.7.2   | Ansible interface adaptor      |
 208 +-----------------------------+------------------------------+---------+--------------------------------+
 209 | org.onap.ccsdk.sli.adaptors | mdsal-resource-provider      | 0.7.2   | MD-SAL interface adaptor       |
 210 +-----------------------------+------------------------------+---------+--------------------------------+
 211 | org.onap.ccsdk.sli.adaptors | netbox-client-provider       | 0.7.2   | netbox interface adaptor       |
 212 +-----------------------------+------------------------------+---------+--------------------------------+
 213 | org.onap.ccsdk.sli.adaptors | resource-assignment-provider | 0.7.2   | resource allocator             |
 214 +-----------------------------+------------------------------+---------+--------------------------------+
 215 | org.onap.ccsdk.sli.adaptors | saltstack-adaptor-provider   | 0.7.2   | saltstack interface adaptor    |
 216 +-----------------------------+------------------------------+---------+--------------------------------+
 217 | org.onap.ccsdk.sli.adaptors | sql-resource-provider        | 0.7.2   | SQL database interface adaptor |
 218 +-----------------------------+------------------------------+---------+--------------------------------+
 219
 220 ccsdk/sli/northbound
 221 ^^^^^^^^^^^^^^^^^^^^
 222 The ccsdk/sli/northbound library contains the code for northbound interfaces which typically invoke
 223 the SLI.
 224
 225 The following table lists the maven artifacts provided for use by CCSDK client projects.
 226
 227 +-------------------------------+---------------------+---------+-----------------------------------------+
 228 | groupId                       | artifactId          | version | Description                             |
 229 +===============================+=====================+=========+=========================================+
 230 | org.onap.ccsdk.sli.northbound | asdcApi-provider    | 0.7.2   | ODL-based SDC interface                 |
 231 +-------------------------------+---------------------+---------+-----------------------------------------+
 232 | org.onap.ccsdk.sli.northbound | dataChange-provider | 0.7.2   | A&AI data change notification interface |
 233 +-------------------------------+---------------------+---------+-----------------------------------------+
 234 | org.onap.ccsdk.sli.northbound | dmaap-listener      | 0.7.2   | DMaaP listener interface                |
 235 +-------------------------------+---------------------+---------+-----------------------------------------+
 236 | org.onap.ccsdk.sli.northbound | lcm-provider        | 0.7.2   | Life Cycle Management event interface   |
 237 +-------------------------------+---------------------+---------+-----------------------------------------+
 238 | org.onap.ccsdk.sli.northbound | ueb-listener        | 0.7.2   | SDC event listener                      |
 239 +-------------------------------+---------------------+---------+-----------------------------------------+
 240
 241 ccsdk/sli/plugins
 242 ^^^^^^^^^^^^^^^^^
 243 The ccsdk/sli/northbound library contains the code for plugins meant to be called from an 'execute' node
 244 in a directed graph.
 245
 246 The following table lists the maven artifacts provided for use by CCSDK client projects.
 247
 248 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 249 | groupId                    | artifactId                 | version | Description                                           |
 250 +============================+============================+=========+=======================================================+
 251 | org.onap.ccsdk.sli.plugins | properties-node-provider   | 0.7.2   | Used to load a properties file for use in             |
 252 |                            |                            |         | a directed graph                                      |
 253 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 254 | org.onap.ccsdk.sli.plugins | restapi-call-node-provider | 0.7.2   | Used to call a generic REST API from a directed       |
 255 |                            |                            |         | graph                                                 |
 256 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 257 | org.onap.ccsdk.sli.plugins | restconf-client-provider   | 0.7.2   | Used to call a RESTCONF API from a directed graph     |
 258 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 259 | org.onap.ccsdk.sli.plugins | sshapi-call-node           | 0.7.2   | Used to invoke an SSH interface from a directed graph |
 260 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 261 | org.onap.ccsdk.sli.plugins | template-node-provider     | 0.7.2   | Provides velocity template support                    |
 262 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 263
 264 Documentation Deliverables
 265 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 266 * `CDS user guide`_
 267 * `SDN Controller for Radio user guide`_
 268 * `ccsdk/sli/core Javadoc`_
 269 * `ccsdk/sli/adaptors Javadoc`_
 270 * `ccsdk/sli/northbound Javadoc`_
 271 * `ccsdk/sli/plugins Javadoc`_
 272
 273 Known Limitations, Issues and Workarounds
 274 =========================================
 275
 276 System Limitations
 277 ------------------
 278
 279 No system limitations noted.
 280
 281
 282 Known Vulnerabilities
 283 ---------------------
 284
 285 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 286 pertain to CCSDK are listed in the :ref:`secissues` section below.
 287
 288
 289 Workarounds
 290 -----------
 291
 292 Not applicable.
 293
 294
 295 Security Notes
 296 --------------
 297
 298 Fixed Security Issues
 299 ~~~~~~~~~~~~~~~~~~~~~
 300
 301 The following security issues have been addressed in the Frankfurt CCSDK release:
 302
 303 * `OSJI-197 <https://jira.onap.org/browse/OJSI-197>`_ : cds-blueprints-processor-http exposes plain text HTTP endpoint using port 30499
 304 * `CCSDK-2149 <https://jira.onap.org/browse/CCSDK-2149>`_ : Pods still run as root
 305 * `CCSDK-1910 <https://jira.onap.org/browse/CCSDK-1910>`_ : Password removal from OOM Helm charts
 306
 307 With these fixes, CCSDK no longer exposes any external http ports and no CCSDK pod runs as root.
 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