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 Jakarta release of the Software Defined
  16 Network Controller (SDNC)
  17
  18 Summary
  19 =======
  20
  21 The Jakarta release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
  22 upgrade (to Phosphorus).
  23
  24 The Jakarta release of SDNC also includes substantial improvements in automated test coverage integrated into
  25 the project's CI/CD framework.  In this release, each time a new SDNC is built, a regression suite is run
  26 and the docker is only saved if it passes this regression suite.
  27
  28
  29
  30 Release Data
  31 ============
  32
  33 +-------------------------+-------------------------------------------+
  34 | **Project**             | SDNC                                      |
  35 |                         |                                           |
  36 +-------------------------+-------------------------------------------+
  37 | **Docker images**       | See :ref:`dockercontainers` section below |
  38 +-------------------------+-------------------------------------------+
  39 | **Release designation** | Jakarta                                   |
  40 |                         |                                           |
  41 +-------------------------+-------------------------------------------+
  42
  43
  44 New features
  45 ------------
  46
  47 The SDNC Jakarta release includes the following features,  which are inherited from CCSDK:
  48
  49 * Upgrade to OpenDaylight Phosphorus Release (Jira `CCSDK-3451 <https://jira.onap.org/browse/CCSDK-3451>`_)
  50 * A1 Adapter and A1 Policy Management Extensions in Jakarta Release - CCSDK (Jira `CCSDK-3463 <https://jira.onap.org/browse/CCSDK-3463>`_)
  51 * CCSDK impacts for Network slicing in Jakarta Release (Jira `CCSDK-3554 <https://jira.onap.org/browse/CCSDK-3554>`_)
  52
  53
  54 For the complete list of `CCSDK Jakarta release epics <https://jira.onap.org/issues/?filter=12711>`_ and
  55 `CCSDK Jakarta release user stories <https://jira.onap.org/issues/?filter=12800>`_ , please see the `ONAP Jira`_.
  56
  57 **Bug fixes**
  58
  59 The SDNC Jakarta release carries forward a fix from the Istanbul Maintenance Release 1 for a critical vulnerability discovered in log4j by
  60 upgrading to version 2.17.1 of the log4j-core package.  It also removes the 'data-migrator' package, which
  61 was an old Proof of Concept that is no longer maintained and which was using a vulnerable version of log4j.
  62 These changes are described further in Jira `SDNC-1655 <https://jira.onap.org/browse/SDNC-1655>`
  63
  64 The full list of `bugs fixed in the SDNC Jakarta release <https://jira.onap.org/issues/?filter=12802>`_ 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
  72 Deliverables
  73 ------------
  74
  75 Software Deliverables
  76 ~~~~~~~~~~~~~~~~~~~~~
  77
  78 .. _dockercontainers:
  79
  80 Docker Containers
  81 `````````````````
  82
  83 The following table lists the docker containers comprising the SDNC Jakarta
  84 release along with the current stable Jakarta version/tag.  Each of these is
  85 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  86 with the following command::
  87
  88    docker pull nexus3.onap.org:10001/{image-name}:{version}
  89
  90
  91
  92 +--------------------------------+-----------------------------------------------------+---------+
  93 | Image name                     | Description                                         | Version |
  94 +================================+=====================================================+=========+
  95 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.3.1   |
  96 +--------------------------------+-----------------------------------------------------+---------+
  97 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.3.1   |
  98 +--------------------------------+-----------------------------------------------------+---------+
  99 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.3.1  |
 100 +--------------------------------+-----------------------------------------------------+---------+
 101 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.3.1   |
 102 +--------------------------------+-----------------------------------------------------+---------+
 103 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.3.1   |
 104 +--------------------------------+-----------------------------------------------------+---------+
 105 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.3.1   |
 106 +--------------------------------+-----------------------------------------------------+---------+
 107
 108
 109 Documentation Deliverables
 110 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 111
 112 * `SDN Controller for Radio user guide`_
 113
 114 Known Limitations, Issues and Workarounds
 115 =========================================
 116
 117 System Limitations
 118 ------------------
 119
 120 No system limitations noted.
 121
 122
 123 Known Vulnerabilities
 124 ---------------------
 125
 126 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 127 pertain to SDNC are listed in the :ref:`secissues` section below.
 128
 129
 130 Workarounds
 131 -----------
 132
 133 Not applicable.
 134
 135
 136 Security Notes
 137 --------------
 138
 139
 140 Known Security Issues
 141 ~~~~~~~~~~~~~~~~~~~~~
 142
 143 There are no known outstanding security issues related to SDNC Jakarta.
 144
 145
 146 Test Results
 147 ============
 148 Not applicable
 149
 150
 151 References
 152 ==========
 153
 154 For more information on the ONAP Jakarta release, please see:
 155
 156 #. `ONAP Home Page`_
 157 #. `ONAP Documentation`_
 158 #. `ONAP Release Downloads`_
 159 #. `ONAP Wiki Page`_
 160
 161
 162 .. _`ONAP Home Page`: https://www.onap.org
 163 .. _`ONAP Wiki Page`: https://wiki.onap.org
 164 .. _`ONAP Documentation`: https://docs.onap.org
 165 .. _`ONAP Release Downloads`: https://git.onap.org
 166 .. _`ONAP Jira`: https://jira.onap.org
 167 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html