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                                    |
  37 |                         |                                           |
  38 +-------------------------+-------------------------------------------+
  39 | **Release date**        | 11/19/2020                                |
  40 |                         |                                           |
  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 The full list of `bugs fixed in the SDNC Guilin release <https://jira.onap.org/issues/?filter=12466>`_ is maintained on the `ONAP Jira`_.
  65
  66 **Known Issues**
  67
  68 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
  69
  70
  71 Removed Features
  72 -------------------
  73
  74 **SDNC portal**
  75
  76 The SDNC portal was deprecated in the Frankfurt release, due
  77 to resource contraints.  This functionality was delivered dormant
  78 in Frankfurt (i.e. it is disabled in the Frankfurt helm charts) and was
  79 removed entirely in the Guilin release.
  80
  81 **VNF-API**
  82
  83 The functionality provided by the VNF-API is now provided as part
  84 of the GENERIC-RESOURCE-API.  Therefore, the VNF-API was deprecated
  85 in Frankfurt and has been removed in Guilin.
  86
  87
  88 Deliverables
  89 ------------
  90
  91 Software Deliverables
  92 ~~~~~~~~~~~~~~~~~~~~~
  93
  94 .. _dockercontainers:
  95
  96 Docker Containers
  97 `````````````````
  98
  99 The following table lists the docker containers comprising the SDNC Frankfurt
 100 release along with the current stable Frankfurt version/tag.  Each of these is
 101 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
 102 with the following command::
 103
 104    docker pull nexus3.onap.org:10001/{image-name}:{version}
 105
 106
 107 Note: users that want to use the latest in-development Frankfurt version may use the
 108 tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
 109
 110 +--------------------------------+-----------------------------------------------------+---------+
 111 | Image name                     | Description                                         | Version |
 112 +================================+=====================================================+=========+
 113 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.0.4   |
 114 +--------------------------------+-----------------------------------------------------+---------+
 115 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.0.4   |
 116 +--------------------------------+-----------------------------------------------------+---------+
 117 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.0.4   |
 118 +--------------------------------+-----------------------------------------------------+---------+
 119 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.0.4   |
 120 +--------------------------------+-----------------------------------------------------+---------+
 121 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.0.4   |
 122 +--------------------------------+-----------------------------------------------------+---------+
 123 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.0.4   |
 124 +--------------------------------+-----------------------------------------------------+---------+
 125
 126
 127 Documentation Deliverables
 128 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 129
 130 * `SDN Controller for Radio user guide`_
 131
 132 Known Limitations, Issues and Workarounds
 133 =========================================
 134
 135 System Limitations
 136 ------------------
 137
 138 No system limitations noted.
 139
 140
 141 Known Vulnerabilities
 142 ---------------------
 143
 144 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 145 pertain to SDNC are listed in the :ref:`secissues` section below.
 146
 147
 148 Workarounds
 149 -----------
 150
 151 Not applicable.
 152
 153
 154 Security Notes
 155 --------------
 156
 157 Fixed Security Issues
 158 ~~~~~~~~~~~~~~~~~~~~~
 159
 160 The following security issue, related to the SDNC portal, is no longer applicable due to removal
 161 of the SDNC portal:
 162
 163 * `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
 164
 165 .. _secissues :
 166
 167 Known Security Issues
 168 ~~~~~~~~~~~~~~~~~~~~~
 169
 170 There are no known outstanding security issues related to SDNC Guilin.
 171
 172
 173 Test Results
 174 ============
 175 Not applicable
 176
 177
 178 References
 179 ==========
 180
 181 For more information on the ONAP Frankfurt release, please see:
 182
 183 #. `ONAP Home Page`_
 184 #. `ONAP Documentation`_
 185 #. `ONAP Release Downloads`_
 186 #. `ONAP Wiki Page`_
 187
 188
 189 .. _`ONAP Home Page`: https://www.onap.org
 190 .. _`ONAP Wiki Page`: https://wiki.onap.org
 191 .. _`ONAP Documentation`: https://docs.onap.org
 192 .. _`ONAP Release Downloads`: https://git.onap.org
 193 .. _`ONAP Jira`: https://jira.onap.org
 194 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html