X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=c1fc73869ab43a7f289e8ae78c9fad926e58fc74;hb=71eb3ab680b9d51cfd6fb324d49bcd09c6ff7464;hp=21ff338cfd9927c3763d966b298bfceb4da210e9;hpb=c8fe9db234df3bfdce5f82c553172a1e117eb356;p=sdnc%2Foam.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 21ff338c..c1fc7386 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,45 +1,163 @@ -.. 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 +======== + +This document provides the release notes for the Honolulu release of the Software Defined +Network Controller (SDNC) + +Summary +======= + +The Honolulu release of SDNC introduces new functionality to support network slicing and extends support +for Netconf/TLS to address certificate management. It also includes a major OpenDaylight release +upgrade (to Sodium), as well as a major Java upgrade (from Java 8 to Java 11). -Version: x.y.z --------------- +Release Data +============ -:Release Date: yyyy-mm-dd ++-------------------------+-------------------------------------------+ +| **Project** | SDNC | +| | | ++-------------------------+-------------------------------------------+ +| **Docker images** | See :ref:`dockercontainers` section below | ++-------------------------+-------------------------------------------+ +| **Release designation** | Honolulu | +| | | ++-------------------------+-------------------------------------------+ +| **Release date** | 4/22/2021 | +| | | ++-------------------------+-------------------------------------------+ +New features +------------ -**New Features** +The SDNC Honolulu release includes the following features: -One or two sentences explaining the purpose of this Release. +* SDN-C (SDN-R) support of E2E Network Slicing in Honolulu (Jira `SDNC-1415 `_) +* ONAP CNF Orchestration - Honolulu Enhancements (SDNC) (Jira `SDNC-1451 `_) +* Decouple SDNC from OpenDaylight / Karaf : phase 3 (Jira `SDNC-1348 `_) + +This release also includes an upgrade to the OpenDaylight Aluminum release, which SDNC consumes from CCSDK. + +For the complete list of `SDNC Honolulu release epics `_ and +`SDNC Honolulu release user stories `_ , please see the `ONAP Jira`_. + +**Bug fixes** + +The full list of `bugs fixed in the SDNC Honolulu 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 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.1.5 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ansible-server-image | Ansible server | 2.1.5 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-dmaap-listener-image | DMaaP listener | 2.1.5 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-image | SDNC controller image, without AAF integration | 2.1.5 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-ueb-listener-image | SDC listener | 2.1.5 | ++--------------------------------+-----------------------------------------------------+---------+ +| onap/sdnc-web-image | Web tier (currently only used by SDN-R persona) | 2.1.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 Honolulu. + - 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 Honolulu 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/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html