Add Guilin release notes
[ccsdk/distribution.git] / docs / release-notes.rst
index 5dc1981..3ca3694 100644 (file)
@@ -18,8 +18,9 @@ Development Kit (CCSDK).
 Summary
 =======
 
-The Frankfurt release of CCSDK introduces new functionality to support PNFs (Physical Network Functions), extends support
-for Netconf/TLS to support CMPv2, and extends CDS to act as an agent in self-serve control loops.
+The Guilin release of CCSDK introduces new functionality to support network slicing and extends support
+for ORAN integration via the A1 interface.  It also includes a major OpenDaylight release
+upgrade (to Sodium), as well as a major Java upgrade (from Java 8 to Java 11).
 
 
 Release Data
@@ -31,10 +32,10 @@ Release Data
 +-------------------------+-------------------------------------------+
 | **Docker images**       | See :ref:`dockercontainers` section below |
 +-------------------------+-------------------------------------------+
-| **Release designation** | Frankfurt                                 |
+| **Release designation** | Guilin                                    |
 |                         |                                           |
 +-------------------------+-------------------------------------------+
-| **Release date**        | 06/04/2020                                |
+| **Release date**        | 11/19/2020                                |
 |                         |                                           |
 +-------------------------+-------------------------------------------+
 
@@ -42,21 +43,25 @@ Release Data
 New features
 ------------
 
-The CCSDK Frankfurt release includes the following features:
+The CCSDK Guilin release includes the following features:
 
-* First phase of OpenDaylight separation (Jira `CCSDK-8 <https://jira.onap.org/browse/CCSDK-8>`_), currently targeted for completion in Guilin
-* Integration of CDS as an actor in Control loops (Jira `CCSDK-1898 <https://jira.onap.org/browse/CCSDK-1898>`_)
-* ORAN-compliant A1 adaptor (Jira `CCSDK-1796 <https://jira.onap.org/browse/CCSDK-1796>`_)
-* Multi-Domain Optical Service (Jira `CCSDK-1828 <https://jira.onap.org/browse/CCSDK-1828>`_)
-* Python 2 -> Python 3 migration (Jira `CCSDK-1905 <https://jira.onap.org/browse/CCSDK-1905>`_)
+* Upgrade to OpenDaylight Sodium release (Jira `CCSDK-2396 <https://jira.onap.org/browse/CCSDK-2396>`_)
+* Upgrade to Java 11 (Jira `CCSDK-2422 <https://jira.onap.org/browse/CCSDK-2422>`_)
+* Second phase of OpenDaylight Decouple (Jira `CCSDK-2093 <https://jira.onap.org/browse/CCSDK-2093>`_)
+* A1 Adapter Evolution (Jira `CCSDK-2475 <https://jira.onap.org/browse/CCSDK-2475>`_)
+* A1 Policy Management (Jira `CCSDK-2476 <https://jira.onap.org/browse/CCSDK-2476>`_)
+* Network Slicing (Jira `CCSDK-2533 <https://jira.onap.org/browse/CCSDK-2533>`_)
 
+Downstream projects that are consuming CCSDK maven artifacts, or that plan to ingest CCSDK as source and do local compiles should be
+aware that the upgrades to OpenDaylight Sodium and to Java 11 are both potentially breaking changes.  Therefore, we consider
+Guilin to be a  major release and have reflected this in our version numbering.
 
-For the complete list of `CCSDK Frankfurt release epics <https://jira.onap.org/issues/?filter=12316>`_ and 
-`CCSDK Frankfurt release user stories <https://jira.onap.org/issues/?filter=12319>`_ , please see the `ONAP Jira`_.
+For the complete list of `CCSDK Guilin release epics <https://jira.onap.org/issues/?filter=12461>`_ and 
+`CCSDK Guilin release user stories <https://jira.onap.org/issues/?filter=12462>`_ , please see the `ONAP Jira`_.
 
 **Bug fixes**
 
-The full list of `bugs fixed in the CCSDK Frankfurt release <https://jira.onap.org/issues/?filter=12320>`_ is maintained on the `ONAP Jira`_.
+The full list of `bugs fixed in the CCSDK Guilin release <https://jira.onap.org/issues/?filter=12463>`_ is maintained on the `ONAP Jira`_.
 
 **Known Issues**
 
@@ -73,47 +78,47 @@ Software Deliverables
 Docker Containers
 `````````````````
 
-The following table lists the docker containers comprising the CCSDK Frankfurt 
-release along with the current stable Frankfurt version/tag.  Each of these is
+The following table lists the docker containers comprising the CCSDK Guilin 
+release along with the current stable Guilin version/tag.  Each of these is
 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
 with the following command::
 
    docker pull nexus3.onap.org:10001/{image-name}:{version}
 
 
-Note: users that want to use the latest in-development Frankfurt version may use the
-tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
+Note: users that want to use the latest in-development Guilin version may use the
+tag 1.0-STAGING-latest to pull the latest daily Guilin build
 
 +-----------------------------------+--------------------------------------------+---------+
 | Image name                        | Description                                | Version |
 +===================================+============================================+=========+
-| onap/ccsdk-alpine-image           | Base Alpine Linux image for CCSDK          | 0.7.4   |
+| onap/ccsdk-alpine-image           | Base Alpine Linux image for CCSDK          | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-ansible-server-image   | Ansible server image                       | 0.7.4   |
+| onap/ccsdk-ansible-server-image   | Ansible server image                       | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-apps-ms-neng           | Naming microservice                        | 0.7.1   |
+| onap/ccsdk-apps-ms-neng           | Naming microservice                        | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-blueprints-processor   | CDS blueprint processor                    | 0.7.5   |
+| onap/ccsdk-blueprints-processor   | CDS blueprint processor                    | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-cds-ui                 | CDS web interface                          | 0.7.5   |
+| onap/ccsdk-cds-ui                 | CDS web interface                          | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-cds-ui-server          | CDS user interface back end                | 0.7.5   |
+| onap/ccsdk-cds-ui-server          | CDS user interface back end                | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-commandexecutor        | CDS command executor                       | 0.7.5   |
+| onap/ccsdk-commandexecutor        | CDS command executor                       | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-controllerblueprint    | CDS controller blueprints                  | 0.7.5   |
+| onap/ccsdk-controllerblueprint    | CDS controller blueprints                  | 1.0.2   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-dgbuilder-image        | Directed graph builder                     | 0.7.4   |
+| onap/ccsdk-dgbuilder-image        | Directed graph builder                     | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-odl-neon-alpine-image  | Alpine based OpenDaylight Neon SR1 image   | 0.7.4   |
+| onap/ccsdk-odl-neon-alpine-image  | Alpine based OpenDaylight Neon SR1 image   | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-odlsli-alpine-image    | Alpine based OpenDaylight image with CCSDK | 0.7.4   |
+| onap/ccsdk-odlsli-alpine-image    | Alpine based OpenDaylight image with CCSDK | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-saltstack-server-image | Saltstack server                           | 0.7.4   |
+| onap/ccsdk-saltstack-server-image | Saltstack server                           | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-sdclistener            | CDS SDC listener                           | 0.7.3   |
+| onap/ccsdk-sdclistener            | CDS SDC listener                           | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
-| onap/ccsdk-ubuntu-image           | Base Ubuntu image for CCSDK                | 0.7.4   |
+| onap/ccsdk-ubuntu-image           | Base Ubuntu image for CCSDK                | 1.0.3   |
 +-----------------------------------+--------------------------------------------+---------+
 
 Maven Artifacts
@@ -136,37 +141,37 @@ Frankfurt version of each.
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 | groupId               | artifactId                   | version | Description                                                                                      |
 +=======================+==============================+=========+==================================================================================================+
-| org.onap.ccsdk.parent | binding-parent               | 1.5.7   | Parent used in place of OpenDaylight binding-parent                                              |
+| org.onap.ccsdk.parent | binding-parent               | 2.0.3   | Parent used in place of OpenDaylight binding-parent                                              |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | bundle-parent                | 1.5.7   | Parent used in place of OpenDaylight bundle-parent                                               |
+| org.onap.ccsdk.parent | bundle-parent                | 2.0.3   | Parent used in place of OpenDaylight bundle-parent                                               |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | client-parent                | 1.5.7   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
+| org.onap.ccsdk.parent | client-parent                | 2.0.3   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | dependencies-bom             | 1.5.7   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
+| org.onap.ccsdk.parent | dependencies-bom             | 2.0.3   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | dependencies-odl-bom         | 1.5.7   | Bill of Materials POM that defines versions of third party libraries used within ODL container.  |
+| 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.  |
 |                       |                              |         | Intended to be imported in dependencyManagement section.                                         |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | feature-repo-parent          | 1.5.7   | Parent used in place of OpenDaylight feature-repo-parent                                         |
+| org.onap.ccsdk.parent | feature-repo-parent          | 2.0.3   | Parent used in place of OpenDaylight feature-repo-parent                                         |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | karaf4-parent                | 1.5.7   | Parent used in place of OpenDaylight karaf4-parent                                               |
+| org.onap.ccsdk.parent | karaf4-parent                | 2.0.3   | Parent used in place of OpenDaylight karaf4-parent                                               |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | mdsal-it-parent              | 1.5.7   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
+| org.onap.ccsdk.parent | mdsal-it-parent              | 2.0.3   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | odlparent                    | 1.5.7   | Parent used in place of OpenDaylight odlparent                                                   |
+| org.onap.ccsdk.parent | odlparent                    | 2.0.3   | Parent used in place of OpenDaylight odlparent                                                   |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | odlparent-lite               | 1.5.7   | Parent used in place of OpenDaylight odlparent-lite                                              |
+| org.onap.ccsdk.parent | odlparent-lite               | 2.0.3   | Parent used in place of OpenDaylight odlparent-lite                                              |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | single-feature-parent        | 1.5.7   | Parent used in place of OpenDaylight single-feature-parent                                       |
+| org.onap.ccsdk.parent | single-feature-parent        | 2.0.3   | Parent used in place of OpenDaylight single-feature-parent                                       |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | spring-boot-1-starter-parent | 1.5.7   | Parent used in place of spring-boot-starter-parent for Springboot 1.x.                           |
-|                       |                              |         | *NOTE* This is deprecated and will be removed in Guilin, since springboot 1.x should no          |
+| 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.                           |
+|                       |                              |         | *NOTE* This is deprecated and will be removed in Honolulu, since springboot 1.x should no        |
 |                       |                              |         | longer be used due to security issues                                                            |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | spring-boot-starter-parent   | 1.5.7   | Parent used in place of spring-boot-starter-parent for Springboot 2.x                            |
+| org.onap.ccsdk.parent | spring-boot-starter-parent   | 2.0.3   | Parent used in place of spring-boot-starter-parent for Springboot 2.x                            |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
-| org.onap.ccsdk.parent | standalone-parent            | 1.5.7   | Parent used for projects that have no need for other third party parent poms                     |
+| org.onap.ccsdk.parent | standalone-parent            | 2.0.3   | Parent used for projects that have no need for other third party parent poms                     |
 +-----------------------+------------------------------+---------+--------------------------------------------------------------------------------------------------+
 
 ccsdk/sli/core
@@ -180,17 +185,17 @@ projects.
 +-------------------------+-------------------------+---------+--------------------------------------------+
 | groupId                 | artifactId              | version | Description                                |
 +=========================+=========================+=========+============================================+
-| org.onap.ccsdk.sli.core | dblib-provider          | 0.7.2   | Database access library                    |
+| org.onap.ccsdk.sli.core | dblib-provider          | 1.0.2   | Database access library                    |
 +-------------------------+-------------------------+---------+--------------------------------------------+
-| org.onap.ccsdk.sli.core | sli-common              | 0.7.2   | Common SLI data objects                    |
+| org.onap.ccsdk.sli.core | sli-common              | 1.0.2   | Common SLI data objects                    |
 +-------------------------+-------------------------+---------+--------------------------------------------+
-| org.onap.ccsdk.sli.core | sli-provider-base       | 0.7.2   | ODL-independent SLI implementation objects |
+| org.onap.ccsdk.sli.core | sli-provider-base       | 1.0.2   | ODL-independent SLI implementation objects |
 +-------------------------+-------------------------+---------+--------------------------------------------+
-| org.onap.ccsdk.sli.core | sli-provider            | 0.7.2   | ODL-dependent SLI implementation objects   |
+| org.onap.ccsdk.sli.core | sli-provider            | 1.0.2   | ODL-dependent SLI implementation objects   |
 +-------------------------+-------------------------+---------+--------------------------------------------+
-| org.onap.ccsdk.sli.core | sliPluginUtils-provider | 0.7.2   | Utilities for use in SLI adaptors/plugins  |
+| org.onap.ccsdk.sli.core | sliPluginUtils-provider | 1.0.2   | Utilities for use in SLI adaptors/plugins  |
 +-------------------------+-------------------------+---------+--------------------------------------------+
-| org.onap.ccsdk.sli.core | utils-provider          | 0.7.2   | Utilities                                  |
+| org.onap.ccsdk.sli.core | utils-provider          | 1.0.2   | Utilities                                  |
 +-------------------------+-------------------------+---------+--------------------------------------------+
 
 ccsdk/sli/adaptors
@@ -203,19 +208,19 @@ projects.
 +-----------------------------+------------------------------+---------+--------------------------------+
 | groupId                     | artifactId                   | version | Description                    |
 +=============================+==============================+=========+================================+
-| org.onap.ccsdk.sli.adaptors | aai-service-provider         | 0.7.3   | A&AI interface adaptor         |
+| org.onap.ccsdk.sli.adaptors | aai-service-provider         | 1.0.2   | A&AI interface adaptor         |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | ansible-adapter-bundle       | 0.7.3   | Ansible interface adaptor      |
+| org.onap.ccsdk.sli.adaptors | ansible-adapter-bundle       | 1.0.2   | Ansible interface adaptor      |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | mdsal-resource-provider      | 0.7.3   | MD-SAL interface adaptor       |
+| org.onap.ccsdk.sli.adaptors | mdsal-resource-provider      | 1.0.2   | MD-SAL interface adaptor       |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | netbox-client-provider       | 0.7.3   | netbox interface adaptor       |
+| org.onap.ccsdk.sli.adaptors | netbox-client-provider       | 1.0.2   | netbox interface adaptor       |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | resource-assignment-provider | 0.7.3   | resource allocator             |
+| org.onap.ccsdk.sli.adaptors | resource-assignment-provider | 1.0.2   | resource allocator             |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | saltstack-adaptor-provider   | 0.7.3   | saltstack interface adaptor    |
+| org.onap.ccsdk.sli.adaptors | saltstack-adaptor-provider   | 1.0.2   | saltstack interface adaptor    |
 +-----------------------------+------------------------------+---------+--------------------------------+
-| org.onap.ccsdk.sli.adaptors | sql-resource-provider        | 0.7.3   | SQL database interface adaptor |
+| org.onap.ccsdk.sli.adaptors | sql-resource-provider        | 1.0.2   | SQL database interface adaptor |
 +-----------------------------+------------------------------+---------+--------------------------------+
 
 ccsdk/sli/northbound
@@ -228,15 +233,15 @@ The following table lists the maven artifacts provided for use by CCSDK client p
 +-------------------------------+---------------------+---------+-----------------------------------------+
 | groupId                       | artifactId          | version | Description                             |
 +===============================+=====================+=========+=========================================+
-| org.onap.ccsdk.sli.northbound | asdcApi-provider    | 0.7.4   | ODL-based SDC interface                 |
+| org.onap.ccsdk.sli.northbound | asdcApi-provider    | 1.0.2   | ODL-based SDC interface                 |
 +-------------------------------+---------------------+---------+-----------------------------------------+
-| org.onap.ccsdk.sli.northbound | dataChange-provider | 0.7.4   | A&AI data change notification interface |
+| org.onap.ccsdk.sli.northbound | dataChange-provider | 1.0.2   | A&AI data change notification interface |
 +-------------------------------+---------------------+---------+-----------------------------------------+
-| org.onap.ccsdk.sli.northbound | dmaap-listener      | 0.7.4   | DMaaP listener interface                |
+| org.onap.ccsdk.sli.northbound | dmaap-listener      | 1.0.2   | DMaaP listener interface                |
 +-------------------------------+---------------------+---------+-----------------------------------------+
-| org.onap.ccsdk.sli.northbound | lcm-provider        | 0.7.4   | Life Cycle Management event interface   |
+| org.onap.ccsdk.sli.northbound | lcm-provider        | 1.0.2   | Life Cycle Management event interface   |
 +-------------------------------+---------------------+---------+-----------------------------------------+
-| org.onap.ccsdk.sli.northbound | ueb-listener        | 0.7.4   | SDC event listener                      |
+| org.onap.ccsdk.sli.northbound | ueb-listener        | 1.0.2   | SDC event listener                      |
 +-------------------------------+---------------------+---------+-----------------------------------------+
 
 ccsdk/sli/plugins
@@ -249,17 +254,17 @@ The following table lists the maven artifacts provided for use by CCSDK client p
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 | groupId                    | artifactId                 | version | Description                                           |
 +============================+============================+=========+=======================================================+
-| org.onap.ccsdk.sli.plugins | properties-node-provider   | 0.7.2   | Used to load a properties file for use in             |
+| org.onap.ccsdk.sli.plugins | properties-node-provider   | 1.0.2   | Used to load a properties file for use in             |
 |                            |                            |         | a directed graph                                      |
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
-| org.onap.ccsdk.sli.plugins | restapi-call-node-provider | 0.7.2   | Used to call a generic REST API from a directed       |
+| org.onap.ccsdk.sli.plugins | restapi-call-node-provider | 1.0.2   | Used to call a generic REST API from a directed       |
 |                            |                            |         | graph                                                 |
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
-| org.onap.ccsdk.sli.plugins | restconf-client-provider   | 0.7.2   | Used to call a RESTCONF API from a directed graph     |
+| org.onap.ccsdk.sli.plugins | restconf-client-provider   | 1.0.2   | Used to call a RESTCONF API from a directed graph     |
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
-| org.onap.ccsdk.sli.plugins | sshapi-call-node           | 0.7.2   | Used to invoke an SSH interface from a directed graph |
+| org.onap.ccsdk.sli.plugins | sshapi-call-node           | 1.0.2   | Used to invoke an SSH interface from a directed graph |
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
-| org.onap.ccsdk.sli.plugins | template-node-provider     | 0.7.2   | Provides velocity template support                    |
+| org.onap.ccsdk.sli.plugins | template-node-provider     | 1.0.2   | Provides velocity template support                    |
 +----------------------------+----------------------------+---------+-------------------------------------------------------+
 
 Documentation Deliverables
@@ -299,13 +304,7 @@ Security Notes
 Fixed Security Issues
 ~~~~~~~~~~~~~~~~~~~~~
 
-The following security issues have been addressed in the Frankfurt CCSDK release:
-
-* `OSJI-197 <https://jira.onap.org/browse/OJSI-197>`_ : cds-blueprints-processor-http exposes plain text HTTP endpoint using port 30499
-* `CCSDK-2149 <https://jira.onap.org/browse/CCSDK-2149>`_ : Pods still run as root
-* `CCSDK-1910 <https://jira.onap.org/browse/CCSDK-1910>`_ : Password removal from OOM Helm charts
-
-With these fixes, CCSDK no longer exposes any external http ports and no CCSDK pod runs as root.
+There are no new security fixes in the Guilin release.
 
 .. _secissues :