Update release notes for Istanbul mtce release
[sdnc/oam.git] / docs / release-notes.rst
index 6f1bbc4..3ccbfdc 100644 (file)
@@ -2,6 +2,7 @@
    International License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) ONAP Project and its contributors
+.. _release_notes:
 
 ******************
 SDNC Release Notes
@@ -11,14 +12,19 @@ SDNC Release Notes
 Abstract
 ========
 
-This document provides the release notes for the Frankfurt release of the Software Defined
+This document provides the release notes for the Istanbul release of the Software Defined
 Network Controller (SDNC)
 
 Summary
 =======
 
-The Frankfurt release of SDNC introduces new functionality to support PNFs (Physical Network Functions), extends support
-for Netconf/TLS to support CMPv2, and adds support for the Multi Domain Optical Network Service use case.
+The Istanbul release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
+upgrade (to Silicon).
+
+The Istanbul release of SDNC also includes substantial improvements in automated test coverage integrated into
+the project's CI/CD framework.  In this release, each time a new SDNC is built, a regression suite is run
+and the docker is only saved if it passes this regression suite.
+
 
 
 Release Data
@@ -30,10 +36,7 @@ Release Data
 +-------------------------+-------------------------------------------+
 | **Docker images**       | See :ref:`dockercontainers` section below |
 +-------------------------+-------------------------------------------+
-| **Release designation** | Frankfurt                                 |
-|                         |                                           |
-+-------------------------+-------------------------------------------+
-| **Release date**        | 06/04/2020                                |
+| **Release designation** | Istanbul Maintenance Release 1            |
 |                         |                                           |
 +-------------------------+-------------------------------------------+
 
@@ -41,26 +44,32 @@ Release Data
 New features
 ------------
 
-The SDNC Frankfurt release includes the following features:
+The SDNC Istanbul release includes the following features, most of which are inherited from CCSDK:
 
-* ORAN-compliant A1 adaptor (Jira `SDNC-965 <https://jira.onap.org/browse/SDNC-965>`_)
-* Multi-Domain Optical Service (Jira `SDNC-928 <https://jira.onap.org/browse/SDNC-928>`_)
-* Python 2 -> Python 3 migration (Jira `SDNC-967 <https://jira.onap.org/browse/SDNC-967>`_)
-* Upgrade to new Policy lifecycle API (Jira `SDNC-968 <https://jira.onap.org/browse/SDNC-968>`_)
+* Enhance CSIT testing for SDNC (Jira `SDNC-1544 <https://jira.onap.org/browse/SDNC-1544>`)
+* Upgrade to OpenDaylight Silicon Release (Jira `CCSDK-3390 <https://jira.onap.org/browse/CCSDK-3390>`_)
+* A1 Adapter and A1 Policy Management Extensions in Istanbul Release - CCSDK (Jira `CCSDK-3229 <https://jira.onap.org/browse/CCSDK-3229>`_)
+* Support of O-RAN-SC D-Release (Jira `CCSDK-3158 <https://jira.onap.org/browse/CCSDK-3158>`_)
+* CCSDK impacts for Network slicing in Istanbul Release (Jira `CCSDK-3297 <https://jira.onap.org/browse/CCSDK-3297>`_)
 
-
-
-For the complete list of `SDNC Frankfurt release epics <https://jira.onap.org/issues/?filter=12322>`_ and 
-`SDNC Frankfurt release user stories <https://jira.onap.org/issues/?filter=12323>`_ , please see the `ONAP Jira`_.
+For the complete list of `SDNC Istanbul release epics <https://jira.onap.org/issues/?filter=12638>`_ and 
+`SDNC Honolulu release user stories <https://jira.onap.org/issues/?filter=12637>`_ , please see the `ONAP Jira`_.
 
 **Bug fixes**
 
-The full list of `bugs fixed in the SDNC Frankfurt release <https://jira.onap.org/issues/?filter=12324>`_ is maintained on the `ONAP Jira`_.
+The SDNC Istanbul Maintenance Release 1 addresses a critical vulnerability discovered in log4j by
+upgrading to version 2.17.1 of the log4j-core package.  It also removes the 'data-migrator' package, which
+was an old Proof of Concept that is no longer maintained and which was using a vulnerable version of log4j.
+These changes are described further in Jira `SDNC-1655 <https://jira.onap.org/browse/SDNC-1655>` 
+
+The full list of `bugs fixed in the SDNC Istanbul release <https://jira.onap.org/issues/?filter=12643>`_ is maintained on the `ONAP Jira`_.
 
 **Known Issues**
 
 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
 
+
+
 Deliverables
 ------------
 
@@ -72,31 +81,29 @@ Software Deliverables
 Docker Containers
 `````````````````
 
-The following table lists the docker containers comprising the SDNC Frankfurt 
-release along with the current stable Frankfurt version/tag.  Each of these is
+The following table lists the docker containers comprising the SDNC Honolulu
+release along with the current stable Honolulu 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
 
 +--------------------------------+-----------------------------------------------------+---------+
 | Image name                     | Description                                         | Version |
 +================================+=====================================================+=========+
-| onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 1.8.3   |
+| onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.2.5   |
 +--------------------------------+-----------------------------------------------------+---------+
-| onap/sdnc-ansible-server-image | Ansible server                                      | 1.8.3   |
+| onap/sdnc-ansible-server-image | Ansible server                                      | 2.2.5   |
 +--------------------------------+-----------------------------------------------------+---------+
-| onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 1.8.3   |
+| onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.2.5  |
 +--------------------------------+-----------------------------------------------------+---------+
-| onap/sdnc-image                | SDNC controller image, without AAF integration      | 1.8.3   |
+| onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.2.5   |
 +--------------------------------+-----------------------------------------------------+---------+
-| onap/sdnc-ueb-listener-image   | SDC listener                                        | 1.8.3   |
+| onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.2.5   |
 +--------------------------------+-----------------------------------------------------+---------+
-| onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 1.8.3   |
+| onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.2.5   |
 +--------------------------------+-----------------------------------------------------+---------+
 
 
@@ -130,34 +137,11 @@ Not applicable.
 Security Notes
 --------------
 
-Fixed Security Issues
-~~~~~~~~~~~~~~~~~~~~~
-
-The following security issues have been addressed in the Frankfurt SDNC release:
-
-* `OSJI-34 <https://jira.onap.org/browse/OJSI-34>`_ : Multiple SQL Injection issues in SDNC
-* `OSJI-40 <https://jira.onap.org/browse/OJSI-40>`_ : SDNC service allows for arbitrary code execution
-* `OSJI-41 <https://jira.onap.org/browse/OJSI-41>`_ : SDNC service allows for arbitrary code execution in sla/dgUpload form (CVE-2019-12132)
-* `OSJI-42 <https://jira.onap.org/browse/OJSI-42>`_ : SDNC service allows for arbitrary code execution in sla/printAsXml form (CVE-2019-12123)
-* `OSJI-43 <https://jira.onap.org/browse/OJSI-43>`_ : SDNC service allows for arbitrary code execution in sla/printAsGv form (CVE-2019-12113)
-* `OSJI-199 <https://jira.onap.org/browse/OJSI-199>`_ : SDNC service allows for arbitrary code execution in sla/upload form (CVE-2019-12112)
-* `SDNC-1145 <https://jira.onap.org/browse/SDNC-1145>`_ : Pods still run as root
-* `SDNC-970 <https://jira.onap.org/browse/SDNC-970>`_ : Password removal from OOM Helm charts
-
-.. _secissues :
 
 Known Security Issues
 ~~~~~~~~~~~~~~~~~~~~~
 
-There is currently one known SDNC security issue, related to the SDNC portal
-
-* `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
-
-The current implementation of the SDNC portal has a self-subscription model - so anyone can create an account by going to
-the setup link.  This is not appropriate for production deployment and will be fixed in a future release.  
-The SDNC portal is disabled in the Frankfurt helm charts and we recommend that it NOT be enabled in a production
-deployment until this issue is corrected.
-
+There are no known outstanding security issues related to SDNC Istanbul.
 
 
 Test Results
@@ -168,7 +152,7 @@ Not applicable
 References
 ==========
 
-For more information on the ONAP Frankfurt release, please see:
+For more information on the ONAP Istanbul release, please see:
 
 #. `ONAP Home Page`_
 #. `ONAP Documentation`_
@@ -181,4 +165,4 @@ For more information on the ONAP Frankfurt release, please see:
 .. _`ONAP Documentation`: https://docs.onap.org
 .. _`ONAP Release Downloads`: https://git.onap.org
 .. _`ONAP Jira`: https://jira.onap.org
-.. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html
+.. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html