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 Honolulu maintenance release of the Common Controller Software
  16 Development Kit (CCSDK).
  17
  18 Summary
  19 =======
  20
  21 The Honolulu 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 Aluminum).
  24
  25 The Honolulu maintenance release includes a service release update to OpenDaylight Aluminum, and several bug fixes.
  26
  27
  28 Release Data
  29 ============
  30
  31 +-------------------------+-------------------------------------------+
  32 | **Project**             | CCSDK                                     |
  33 |                         |                                           |
  34 +-------------------------+-------------------------------------------+
  35 | **Docker images**       | See :ref:`dockercontainers` section below |
  36 +-------------------------+-------------------------------------------+
  37 | **Release designation** | Honolulu maintenance release              |
  38 |                         |                                           |
  39 +-------------------------+-------------------------------------------+
  40
  41
  42 New features
  43 ------------
  44
  45 The CCSDK Honolulu release includes the following features:
  46
  47 * Upgrade to OpenDaylight Aluminum release (Jira `CCSDK-2982 <https://jira.onap.org/browse/CCSDK-2982>`_)
  48 * Decouple CCSDK from OpenDaylight / Karaf : phase 3 (Jira `CCSDK-2987 <https://jira.onap.org/browse/CCSDK-2987>`_)
  49 * A1 Adapter and A1 Policy Management Extension - CCSDK (Jira `CCSDK-2991 <https://jira.onap.org/browse/CCSDK-2991>`_)
  50 * CCSDK support of Network Slicing in Honolulu (Jira `CCSDK-2988 <https://jira.onap.org/browse/CCSDK-2988>`_)
  51 * Native CNF Day-2 operations support (Jira `CCSDK-2922 <https://jira.onap.org/browse/CCSDK-2922>`_)
  52
  53 The CCSDK Honululu maintenance release includes the following features:
  54
  55 * Update to Aluminum SR3 (Jira `CCSDK-1542 <https://jira.onap.org/browse/CCSDK-1542>`)
  56
  57
  58 For the complete list of `CCSDK Honolulu release epics <https://jira.onap.org/issues/?filter=12493>`_ and
  59 `CCSDK Honolulu release user stories <https://jira.onap.org/issues/?filter=12494>`_ , please see the `ONAP Jira`_.
  60
  61 **Bug fixes**
  62
  63 The Honolulu maintenance release contains the following bug fixes:
  64
  65 * Dashboard fails readiness check (Jira `CCSDK-3233 <https://jira.onap.org/browse/CCSDK-3233>`)
  66 * ODLUX GUI unusable in Honululu (Jira `CCSDK-3312 <https://jira.onap.org/browse/CCSDK-3312>`)
  67 * RanSlice DG-Integration Testing fixes (Jira `CCSDK-3314 <https://jira.onap.org/browse/CCSDK-3314>`)
  68 * CDS:when testing Scaleout, error in resource Assignment due to policy not found (Jira `CCSDK-3319 <https://jira.onap.org/browse/CCSDK-3319>`)
  69 * Renaming BluePrint* classes caused breaking API changes (Jira `CCSDK-3385 <https://jira.onap.org/browse/CCSDK-3385>`)
  70
  71 The full list of `bugs fixed in the CCSDK Honolulu release <https://jira.onap.org/issues/?filter=12495>`_ is maintained on the `ONAP Jira`_.
  72
  73 **Known Issues**
  74
  75 The full list of `known issues in CCSDK <https://jira.onap.org/issues/?filter=11341>`_ is maintained on the `ONAP Jira`_.
  76
  77 Deliverables
  78 ------------
  79
  80 Software Deliverables
  81 ~~~~~~~~~~~~~~~~~~~~~
  82
  83 .. _dockercontainers:
  84
  85 Docker Containers
  86 `````````````````
  87
  88 The following table lists the docker containers comprising the CCSDK Guilin
  89 release along with the current stable Guilin version/tag.  Each of these is
  90 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  91 with the following command::
  92
  93    docker pull nexus3.onap.org:10001/{image-name}:{version}
  94
  95
  96 Note: users that want to use the latest in-development Guilin version may use the
  97 tag 1.0-STAGING-latest to pull the latest daily Guilin build
  98
  99 +---------------------------------------+--------------------------------------------+---------+
 100 | Image name                            | Description                                | Version |
 101 +=======================================+============================================+=========+
 102 | onap/ccsdk-alpine-j11-image           | Base Alpine Linux image for CCSDK          | 1.1.6   |
 103 +---------------------------------------+--------------------------------------------+---------+
 104 | onap/ccsdk-ansible-server-image       | Ansible server image                       | 1.1.6   |
 105 +---------------------------------------+--------------------------------------------+---------+
 106 | onap/ccsdk-apps-ms-neng               | Naming microservice                        | 1.1.1   |
 107 +---------------------------------------+--------------------------------------------+---------+
 108 | onap/ccsdk-blueprints-processor       | CDS blueprint processor                    | 1.1.5   |
 109 +---------------------------------------+--------------------------------------------+---------+
 110 | onap/ccsdk-cds-ui-server              | CDS user interface back end                | 1.1.5   |
 111 +---------------------------------------+--------------------------------------------+---------+
 112 | onap/ccsdk-commandexecutor            | CDS command executor                       | 1.1.5   |
 113 +---------------------------------------+--------------------------------------------+---------+
 114 | onap/ccsdk-controllerblueprint        | CDS controller blueprints                  | 1.1.5   |
 115 +---------------------------------------+--------------------------------------------+---------+
 116 | onap/ccsdk-dgbuilder-image            | Directed graph builder                     | 1.1.6   |
 117 +---------------------------------------+--------------------------------------------+---------+
 118 | onap/ccsdk-odl-aluminum-alpine-image  | Alpine based OpenDaylight Aluminum image   | 1.1.6   |
 119 +---------------------------------------+--------------------------------------------+---------+
 120 | onap/ccsdk-odlsli-alpine-image        | Alpine based OpenDaylight image with CCSDK | 1.1.6   |
 121 +---------------------------------------+--------------------------------------------+---------+
 122 | onap/ccsdk-saltstack-server-image     | Saltstack server                           | 1.1.6   |
 123 +---------------------------------------+--------------------------------------------+---------+
 124 | onap/ccsdk-sdclistener                | CDS SDC listener                           | 1.1.5   |
 125 +---------------------------------------+--------------------------------------------+---------+
 126 | onap/ccsdk-ubuntu-image               | Base Ubuntu image for CCSDK                | 1.1.6   |
 127 +---------------------------------------+--------------------------------------------+---------+
 128
 129 Maven Artifacts
 130 ```````````````
 131 In addition to docker containers, CCSDK also provides libraries that are intended to be used by
 132 client applications (e.g. APPC, SDNC) as maven dependencies.
 133
 134
 135 ccsdk/parent
 136 ^^^^^^^^^^^^
 137 Many CCSDK clients need to be able to inherit settings from third party parent poms provided
 138 by OpenDaylight or springboot, and therefore are unable to use the standard ONAP parent pom.
 139 The CCSDK parent repository provides its own version of parent poms whose contents are consistent
 140 with ONAP standard settings (as defined in oparent), but whose parent is the OpenDaylight or
 141 springboot parent, so that clients can effectively merge both sets of settings.
 142
 143 The following table lists the parent poms provided by CCSDK and the current stable
 144 Frankfurt version of each.
 145
 146 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 147 | groupId               | artifactId                   | version | Description                                                                                      |
 148 +=======================+==============================+=========+==================================================================================================+
 149 | org.onap.ccsdk.parent | binding-parent               | 2.1.8   | Parent used in place of OpenDaylight binding-parent                                              |
 150 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 151 | org.onap.ccsdk.parent | bundle-parent                | 2.1.8   | Parent used in place of OpenDaylight bundle-parent                                               |
 152 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 153 | org.onap.ccsdk.parent | client-parent                | 2.1.8   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
 154 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 155 | org.onap.ccsdk.parent | dependencies-bom             | 2.1.8   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
 156 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 157 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 158 | org.onap.ccsdk.parent | dependencies-odl-bom         | 2.1.8   | Bill of Materials POM that defines versions of third party libraries used within ODL container.  |
 159 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 160 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 161 | org.onap.ccsdk.parent | feature-repo-parent          | 2.1.8   | Parent used in place of OpenDaylight feature-repo-parent                                         |
 162 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 163 | org.onap.ccsdk.parent | karaf4-parent                | 2.1.8   | Parent used in place of OpenDaylight karaf4-parent                                               |
 164 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 165 | org.onap.ccsdk.parent | mdsal-it-parent              | 2.1.8   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
 166 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 167 | org.onap.ccsdk.parent | odlparent                    | 2.1.8   | Parent used in place of OpenDaylight odlparent                                                   |
 168 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 169 | org.onap.ccsdk.parent | odlparent-lite               | 2.1.8   | Parent used in place of OpenDaylight odlparent-lite                                              |
 170 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 171 | org.onap.ccsdk.parent | single-feature-parent        | 2.1.8   | Parent used in place of OpenDaylight single-feature-parent                                       |
 172 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 173 | org.onap.ccsdk.parent | spring-boot-1-starter-parent | 2.1.8   | Parent used in place of spring-boot-starter-parent for Springboot 1.x.                           |
 174 |                       |                              |         | *NOTE* This is deprecated and will be removed in Honolulu, since springboot 1.x should no        |
 175 |                       |                              |         | longer be used due to security issues                                                            |
 176 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 177 | org.onap.ccsdk.parent | spring-boot-starter-parent   | 2.1.8   | Parent used in place of spring-boot-starter-parent for Springboot 2.x                            |
 178 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 179 | org.onap.ccsdk.parent | standalone-parent            | 2.1.8   | Parent used for projects that have no need for other third party parent poms                     |
 180 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 181
 182 ccsdk/sli
 183 ^^^^^^^^^^^^^^
 184 The ccsdk/sli library provides the Service Logic Interpreter (SLI), which is the engine that runs directed graphs.  It also
 185 provides a number of libraries that can be used by other CCSDK client projects.
 186
 187 The following table lists the maven artifacts provided for use by CCSDK client
 188 projects.
 189
 190 +-------------------------------+------------------------------+---------+--------------------------------------------+
 191 | groupId                       | artifactId                   | version | Description                                |
 192 +===============================+==============================+=========+============================================+
 193 | org.onap.ccsdk.sli.core       | dblib-provider               | 1.2.4   | Database access library                    |
 194 +-------------------------------+------------------------------+---------+--------------------------------------------+
 195 | org.onap.ccsdk.sli.core       | sli-common                   | 1.2.4   | Common SLI data objects                    |
 196 +-------------------------------+------------------------------+---------+--------------------------------------------+
 197 | org.onap.ccsdk.sli.core       | sli-provider-base            | 1.2.4   | ODL-independent SLI implementation objects |
 198 +-------------------------------+------------------------------+---------+--------------------------------------------+
 199 | org.onap.ccsdk.sli.core       | sli-provider                 | 1.2.4   | ODL-dependent SLI implementation objects   |
 200 +-------------------------------+------------------------------+---------+--------------------------------------------+
 201 | org.onap.ccsdk.sli.core       | sliPluginUtils-provider      | 1.2.4   | Utilities for use in SLI adaptors/plugins  |
 202 +-------------------------------+------------------------------+---------+--------------------------------------------+
 203 | org.onap.ccsdk.sli.core       | utils-provider               | 1.2.4   | Utilities                                  |
 204 +-------------------------------+------------------------------+---------+--------------------------------------------+
 205 | org.onap.ccsdk.sli.adaptors   | aai-service-provider         | 1.2.4   | A&AI interface adaptor                     |
 206 +-------------------------------+------------------------------+---------+--------------------------------------------+
 207 | org.onap.ccsdk.sli.adaptors   | ansible-adapter-bundle       | 1.2.4   | Ansible interface adaptor                  |
 208 +-------------------------------+------------------------------+---------+--------------------------------------------+
 209 | org.onap.ccsdk.sli.adaptors   | mdsal-resource-provider      | 1.2.4   | MD-SAL interface adaptor                   |
 210 +-------------------------------+------------------------------+---------+--------------------------------------------+
 211 | org.onap.ccsdk.sli.adaptors   | netbox-client-provider       | 1.2.4   | netbox interface adaptor                   |
 212 +-------------------------------+------------------------------+---------+--------------------------------------------+
 213 | org.onap.ccsdk.sli.adaptors   | resource-assignment-provider | 1.2.4   | resource allocator                         |
 214 +-------------------------------+------------------------------+---------+--------------------------------------------+
 215 | org.onap.ccsdk.sli.adaptors   | saltstack-adaptor-provider   | 1.2.4   | saltstack interface adaptor                |
 216 +-------------------------------+------------------------------+---------+--------------------------------------------+
 217 | org.onap.ccsdk.sli.adaptors   | sql-resource-provider        | 1.2.4   | SQL database interface adaptor             |
 218 +-------------------------------+------------------------------+---------+--------------------------------------------+
 219 | org.onap.ccsdk.sli.northbound | asdcApi-provider             | 1.2.4   | ODL-based SDC interface                    |
 220 +-------------------------------+------------------------------+---------+--------------------------------------------+
 221 | org.onap.ccsdk.sli.northbound | dataChange-provider          | 1.2.4   | A&AI data change notification interface    |
 222 +-------------------------------+------------------------------+---------+--------------------------------------------+
 223 | org.onap.ccsdk.sli.northbound | dmaap-listener               | 1.2.4   | DMaaP listener interface                   |
 224 +-------------------------------+------------------------------+---------+--------------------------------------------+
 225 | org.onap.ccsdk.sli.northbound | lcm-provider                 | 1.2.4   | Life Cycle Management event interface      |
 226 +-------------------------------+------------------------------+---------+--------------------------------------------+
 227 | org.onap.ccsdk.sli.northbound | ueb-listener                 | 1.2.4   | SDC event listener                         |
 228 +-------------------------------+------------------------------+---------+--------------------------------------------+
 229 | org.onap.ccsdk.sli.plugins    | properties-node-provider     | 1.2.4   | Used to load a properties file for use in  |
 230 |                               |                              |         | a directed graph                           |
 231 +-------------------------------+------------------------------+---------+--------------------------------------------+
 232 | org.onap.ccsdk.sli.plugins    | restapi-call-node-provider   | 1.2.4   | Used to call a generic REST API from a     |
 233 |                               |                              |         | directed graph                             |
 234 +-------------------------------+------------------------------+---------+--------------------------------------------+
 235 | org.onap.ccsdk.sli.plugins    | restconf-client-provider     | 1.2.4   | Used to call a RESTCONF API from a         |
 236 |                               |                              |         | directed graph                             |
 237 +-------------------------------+------------------------------+---------+--------------------------------------------+
 238 | org.onap.ccsdk.sli.plugins    | sshapi-call-node             | 1.2.4   | Used to invoke an SSH interface from a     |
 239 |                               |                              |         | directed graph                             |
 240 +-------------------------------+------------------------------+---------+--------------------------------------------+
 241 | org.onap.ccsdk.sli.plugins    | template-node-provider       | 1.2.4   | Provides velocity template support         |
 242 +-------------------------------+------------------------------+---------+--------------------------------------------+
 243
 244 Documentation Deliverables
 245 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 246 * `CDS user guide`_
 247 * `SDN Controller for Radio user guide`_
 248
 249 Known Limitations, Issues and Workarounds
 250 =========================================
 251
 252 System Limitations
 253 ------------------
 254
 255 No system limitations noted.
 256
 257
 258 Known Vulnerabilities
 259 ---------------------
 260
 261 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 262 pertain to CCSDK are listed in the :ref:`secissues` section below.
 263
 264
 265 Workarounds
 266 -----------
 267
 268 Not applicable.
 269
 270
 271 Security Notes
 272 --------------
 273
 274 Fixed Security Issues
 275 ~~~~~~~~~~~~~~~~~~~~~
 276
 277 There are no new security fixes in the Guilin release.
 278
 279 .. _secissues :
 280
 281 Known Security Issues
 282 ~~~~~~~~~~~~~~~~~~~~~
 283
 284 There is currently only one known CCSDK security issue, related to a third party application (netbox) that CCSDK uses:
 285
 286 * `OJSI-160 <https://jira.onap.org/browse/OJSI-160>`_ : netbox-nginx exposes plain text HTTP endpoint using port 30420
 287
 288
 289
 290 Test Results
 291 ============
 292 Not applicable
 293
 294
 295 References
 296 ==========
 297
 298 For more information on the ONAP Frankfurt release, please see:
 299
 300 #. `ONAP Home Page`_
 301 #. `ONAP Documentation`_
 302 #. `ONAP Release Downloads`_
 303 #. `ONAP Wiki Page`_
 304
 305
 306 .. _`ONAP Home Page`: https://www.onap.org
 307 .. _`ONAP Wiki Page`: https://wiki.onap.org
 308 .. _`ONAP Documentation`: https://docs.onap.org
 309 .. _`ONAP Release Downloads`: https://git.onap.org
 310 .. _`ONAP Jira`: https://jira.onap.org
 311 .. _`CDS user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html
 312 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html