-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0
+ International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) ONAP Project and its contributors
+.. _release_notes:
-Release Notes
-=============
+******************
+SDNC Release Notes
+******************
-.. note::
- * This Release Notes must be updated each time the team decides to Release new artifacts.
- * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
- * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
- * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
- * This note must be removed after content has been added.
+Abstract
+========
-Version: x.y.z
---------------
+This document provides the release notes for the Istanbul release of the Software Defined
+Network Controller (SDNC)
+
+Summary
+=======
+
+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
+============
+
++-------------------------+-------------------------------------------+
+| **Project** | SDNC |
+| | |
++-------------------------+-------------------------------------------+
+| **Docker images** | See :ref:`dockercontainers` section below |
++-------------------------+-------------------------------------------+
+| **Release designation** | Istanbul Maintenance Release 1 |
+| | |
++-------------------------+-------------------------------------------+
+
+
+New features
+------------
+The SDNC Istanbul release includes the following features, most of which are inherited from CCSDK:
-:Release Date: yyyy-mm-dd
+* 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 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**
-**New Features**
+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>`
-One or two sentences explaining the purpose of this Release.
+The full list of `bugs fixed in the SDNC Istanbul release <https://jira.onap.org/issues/?filter=12643>`_ is maintained on the `ONAP Jira`_.
-**Bug Fixes**
- - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
**Known Issues**
- - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
- One sentences explaining what is the issue.
- Another sentence explaining the impact of the issue.
+The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
+
+
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+.. _dockercontainers:
+
+Docker Containers
+`````````````````
+
+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}
+
+
+
++--------------------------------+-----------------------------------------------------+---------+
+| Image name | Description | Version |
++================================+=====================================================+=========+
+| onap/sdnc-aaf-image | SDNC controller image, integrated with AAF for RBAC | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ansible-server-image | Ansible server | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-dmaap-listener-image | DMaaP listener | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-image | SDNC controller image, without AAF integration | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-ueb-listener-image | SDC listener | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 2.2.5 |
++--------------------------------+-----------------------------------------------------+---------+
+
+
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* `SDN Controller for Radio user guide`_
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+No system limitations noted.
+
+
+Known Vulnerabilities
+---------------------
+
+Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project. Any outstanding OJSI issues that
+pertain to SDNC are listed in the :ref:`secissues` section below.
+
+
+Workarounds
+-----------
+
+Not applicable.
+
+
+Security Notes
+--------------
+
+
+Known Security Issues
+~~~~~~~~~~~~~~~~~~~~~
+
+There are no known outstanding security issues related to SDNC Istanbul.
+
- And an optional sentence providing a workaround.
+Test Results
+============
+Not applicable
-**Security Issues**
- You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+References
+==========
-**Upgrade Notes**
+For more information on the ONAP Istanbul release, please see:
-**Deprecation Notes**
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
-**Other**
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`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/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html
Code Review / sdnc / oam.git / blobdiff