X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=ad04990cf1348adfaa0842e2589adfe76b54f075;hb=91504af24ea88606424553c00a20a6287f381177;hp=21ff338cfd9927c3763d966b298bfceb4da210e9;hpb=7dd50864cbb3e20cc4f1b3aec8ad3672f283259b;p=sdnc%2Foam.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 21ff338c..ad04990c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,45 +1,160 @@ -.. 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 Kohn release of the Software Defined +Network Controller (SDNC) + +Summary +======= + +The Kohn release of SDNC includes enhancements network slicing as well as a major OpenDaylight release +upgrade (to Sulfur). + + + +Release Data +============ + ++-------------------------+-------------------------------------------+ +| **Project** | SDNC | +| | | ++-------------------------+-------------------------------------------+ +| **Docker images** | See :ref:`dockercontainers` section below | ++-------------------------+-------------------------------------------+ +| **Release designation** | Kohn | +| | | ++-------------------------+-------------------------------------------+ + + +New features +------------ + +The SDNC Kohn release includes the following features, which are inherited from CCSDK: +* Upgrade to OpenDaylight Sulfur Release (Jira `CCSDK-3673 `_) +* CCSDK Enhancements for 5G OOF SON use case in Kohn release (Jira `CCSDK-3644 `_) +* A1 Adapter and A1 Policy Managements Enhancements in Kohn Release - CCSDK (Jira `CCSDK-3617 `_) +* Prepare for removal of Bierman RESTCONF in ODL Chlorine release (Jira `CCSDK-3674 `_) -:Release Date: yyyy-mm-dd +For the complete list of `CCSDK Kohn release epics `_ and +`CCSDK Kohn release user stories `_ , please see the `ONAP Jira`_. +**Bug fixes** -**New Features** -One or two sentences explaining the purpose of this Release. +The full list of `bugs fixed in the SDNC Kohn release `_ is maintained on the `ONAP Jira`_. -**Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. **Known Issues** - - `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 `_ is maintained on the `ONAP Jira`_. + + + +Deliverables +------------ + +Software Deliverables +~~~~~~~~~~~~~~~~~~~~~ + +.. _dockercontainers: + +Docker Containers +````````````````` + +The following table lists the docker containers comprising the SDNC Kohn +release along with the current stable Kohn 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.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ansible-server-image | Ansible server | 2.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-dmaap-listener-image | DMaaP listener | 2.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-image | SDNC controller image, without AAF integration | 2.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ueb-listener-image | SDC listener | 2.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 2.4.0 | ++--------------------------------+-----------------------------------------------------+---------+ + + +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 Kohn. + - 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 `_ +References +========== -**Upgrade Notes** +For more information on the ONAP Kohn 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