docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) ONAP Project and its contributors
   5 .. _release_notes:
   6
   7 ******************
   8 SDNC Release Notes
   9 ******************
  10
  11
  12 Abstract
  13 ========
  14
  15 This document provides the release notes for the Guilin release of the Software Defined
  16 Network Controller (SDNC)
  17
  18 Summary
  19 =======
  20
  21 The Guilin release of SDNC introduces new functionality to support network slicing and extends support
  22 for Netconf/TLS to address certificate management.  It also includes a major OpenDaylight release
  23 upgrade (to Sodium), as well as a major Java upgrade (from Java 8 to Java 11).
  24
  25
  26
  27 Release Data
  28 ============
  29
  30 +-------------------------+-------------------------------------------+
  31 | **Project**             | SDNC                                      |
  32 |                         |                                           |
  33 +-------------------------+-------------------------------------------+
  34 | **Docker images**       | See :ref:`dockercontainers` section below |
  35 +-------------------------+-------------------------------------------+
  36 | **Release designation** | Guilin Maintenance Release 1              |
  37 |                         |                                           |
  38 +-------------------------+-------------------------------------------+
  39 | **Release date**        | 11/19/2020  (initial release)             |
  40 |                         | 4/19/2021   (maintenance release 1)       |
  41 +-------------------------+-------------------------------------------+
  42
  43
  44 New features
  45 ------------
  46
  47 The SDNC Guilin release includes the following features:
  48
  49 * Upgrade to Java 11 (Jira `SDNC-1242 <https://jira.onap.org/browse/SDNC-1242>`_)
  50 * Network slicing (Jira `SDNC-915 <https://jira.onap.org/browse/SDNC-915>`_)
  51 * NETCONF/TLS Certificate Management (Jira `SDNC-966 <https://jira.onap.org/browse/SDNC-966>`_)
  52 * Decouple SDNC from OpenDaylight / Karaf : phase 2 (Jira `SDNC-1207 <https://jira.onap.org/browse/SDNC-1207>`_)
  53
  54 This release also includes an upgrade to the OpenDaylight Sodium release, which SDNC consumes from CCSDK.
  55 Downstream projects that are consuming SDNC maven artifacts, or that plan to ingest SDNC as source and do local compiles should be
  56 aware that the upgrades to OpenDaylight Sodium and to Java 11 are both potentially breaking changes.  Therefore, we consider
  57 Guilin to be a  major release and have reflected this in our version numbering.
  58
  59 For the complete list of `SDNC Guilin release epics <https://jira.onap.org/issues/?filter=12464>`_ and
  60 `SDNC Guilin release user stories <https://jira.onap.org/issues/?filter=12465>`_ , please see the `ONAP Jira`_.
  61
  62 **Bug fixes**
  63
  64 Guilin Maintenance Release 1 fixes the following bugs:
  65
  66 * SDNC does not retain OpenDaylight state across restarts (Jira `SDNC-1455 <https://jira.onap.org/browse/SDNC-1455>`_)
  67 * CCVPN - Transport Slicing: SDNC development - Using Same names for OTN tunnels and Ethernet Services in both domains, plus bug fixing (Jira `SDNC-1431 <https://jira.onap.org/browse/SDNC-1431>`_)
  68 * SDNC restart needed every 24-36h during stability test (Jira `SDNC-1430 <https://jira.onap.org/browse/SDNC-1430>`_)
  69
  70 The full list of `bugs fixed in the SDNC Guilin release <https://jira.onap.org/issues/?filter=12466>`_ is maintained on the `ONAP Jira`_.
  71
  72 **Known Issues**
  73
  74 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
  75
  76
  77 Removed Features
  78 -------------------
  79
  80 **SDNC portal**
  81
  82 The SDNC portal was deprecated in the Frankfurt release, due
  83 to resource contraints.  This functionality was delivered dormant
  84 in Frankfurt (i.e. it is disabled in the Frankfurt helm charts) and was
  85 removed entirely in the Guilin release.
  86
  87 **VNF-API**
  88
  89 The functionality provided by the VNF-API is now provided as part
  90 of the GENERIC-RESOURCE-API.  Therefore, the VNF-API was deprecated
  91 in Frankfurt and has been removed in Guilin.
  92
  93
  94 Deliverables
  95 ------------
  96
  97 Software Deliverables
  98 ~~~~~~~~~~~~~~~~~~~~~
  99
 100 .. _dockercontainers:
 101
 102 Docker Containers
 103 `````````````````
 104
 105 The following table lists the docker containers comprising the SDNC Frankfurt
 106 release along with the current stable Frankfurt version/tag.  Each of these is
 107 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
 108 with the following command::
 109
 110    docker pull nexus3.onap.org:10001/{image-name}:{version}
 111
 112
 113 Note: users that want to use the latest in-development Frankfurt version may use the
 114 tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
 115
 116 +--------------------------------+-----------------------------------------------------+---------+
 117 | Image name                     | Description                                         | Version |
 118 +================================+=====================================================+=========+
 119 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.0.6   |
 120 +--------------------------------+-----------------------------------------------------+---------+
 121 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.0.6   |
 122 +--------------------------------+-----------------------------------------------------+---------+
 123 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.0.6   |
 124 +--------------------------------+-----------------------------------------------------+---------+
 125 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.0.6   |
 126 +--------------------------------+-----------------------------------------------------+---------+
 127 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.0.6   |
 128 +--------------------------------+-----------------------------------------------------+---------+
 129 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.0.6   |
 130 +--------------------------------+-----------------------------------------------------+---------+
 131
 132
 133 Documentation Deliverables
 134 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 135
 136 * `SDN Controller for Radio user guide`_
 137
 138 Known Limitations, Issues and Workarounds
 139 =========================================
 140
 141 System Limitations
 142 ------------------
 143
 144 No system limitations noted.
 145
 146
 147 Known Vulnerabilities
 148 ---------------------
 149
 150 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 151 pertain to SDNC are listed in the :ref:`secissues` section below.
 152
 153
 154 Workarounds
 155 -----------
 156
 157 Not applicable.
 158
 159
 160 Security Notes
 161 --------------
 162
 163 Fixed Security Issues
 164 ~~~~~~~~~~~~~~~~~~~~~
 165
 166 The following security issue, related to the SDNC portal, is no longer applicable due to removal
 167 of the SDNC portal:
 168
 169 * `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
 170
 171 .. _secissues :
 172
 173 Known Security Issues
 174 ~~~~~~~~~~~~~~~~~~~~~
 175
 176 There are no known outstanding security issues related to SDNC Guilin.
 177
 178
 179 Test Results
 180 ============
 181 Not applicable
 182
 183
 184 References
 185 ==========
 186
 187 For more information on the ONAP Frankfurt release, please see:
 188
 189 #. `ONAP Home Page`_
 190 #. `ONAP Documentation`_
 191 #. `ONAP Release Downloads`_
 192 #. `ONAP Wiki Page`_
 193
 194
 195 .. _`ONAP Home Page`: https://www.onap.org
 196 .. _`ONAP Wiki Page`: https://wiki.onap.org
 197 .. _`ONAP Documentation`: https://docs.onap.org
 198 .. _`ONAP Release Downloads`: https://git.onap.org
 199 .. _`ONAP Jira`: https://jira.onap.org
 200 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html