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 Silicon Release (Jira `CCSDK-3390 <https://jira.onap.org/browse/CCSDK-3390>`_)
  50 * A1 Adapter and A1 Policy Management Extensions in Istanbul Release - CCSDK (Jira `CCSDK-3229 <https://jira.onap.org/browse/CCSDK-3229>`_)
  51 * Support of O-RAN-SC D-Release (Jira `CCSDK-3158 <https://jira.onap.org/browse/CCSDK-3158>`_)
  52 * CCSDK impacts for Network slicing in Istanbul Release (Jira `CCSDK-3297 <https://jira.onap.org/browse/CCSDK-3297>`_)
  53
  54
  55 For the complete list of `CCSDK Istanbul release epics <https://jira.onap.org/issues/?filter=12635>`_ and
  56 `CCSDK Istanbul release user stories <https://jira.onap.org/issues/?filter=12636>`_ , please see the `ONAP Jira`_.
  57
  58 **Bug fixes**
  59
  60 The SDNC Jakarta release carries forward a fix from the Istanbul Maintenance Release 1 for a critical vulnerability discovered in log4j by
  61 upgrading to version 2.17.1 of the log4j-core package.  It also removes the 'data-migrator' package, which
  62 was an old Proof of Concept that is no longer maintained and which was using a vulnerable version of log4j.
  63 These changes are described further in Jira `SDNC-1655 <https://jira.onap.org/browse/SDNC-1655>`
  64
  65 The full list of `bugs fixed in the SDNC Jakarta release <https://jira.onap.org/issues/?filter=12802>`_ is maintained on the `ONAP Jira`_.
  66
  67 **Known Issues**
  68
  69 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
  70
  71
  72
  73 Deliverables
  74 ------------
  75
  76 Software Deliverables
  77 ~~~~~~~~~~~~~~~~~~~~~
  78
  79 .. _dockercontainers:
  80
  81 Docker Containers
  82 `````````````````
  83
  84 The following table lists the docker containers comprising the SDNC Jakarta
  85 release along with the current stable Jakarta version/tag.  Each of these is
  86 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  87 with the following command::
  88
  89    docker pull nexus3.onap.org:10001/{image-name}:{version}
  90
  91
  92
  93 +--------------------------------+-----------------------------------------------------+---------+
  94 | Image name                     | Description                                         | Version |
  95 +================================+=====================================================+=========+
  96 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.3.0   |
  97 +--------------------------------+-----------------------------------------------------+---------+
  98 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.3.0   |
  99 +--------------------------------+-----------------------------------------------------+---------+
 100 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.3.0  |
 101 +--------------------------------+-----------------------------------------------------+---------+
 102 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.3.0   |
 103 +--------------------------------+-----------------------------------------------------+---------+
 104 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.3.0   |
 105 +--------------------------------+-----------------------------------------------------+---------+
 106 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.3.0   |
 107 +--------------------------------+-----------------------------------------------------+---------+
 108
 109
 110 Documentation Deliverables
 111 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 112
 113 * `SDN Controller for Radio user guide`_
 114
 115 Known Limitations, Issues and Workarounds
 116 =========================================
 117
 118 System Limitations
 119 ------------------
 120
 121 No system limitations noted.
 122
 123
 124 Known Vulnerabilities
 125 ---------------------
 126
 127 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 128 pertain to SDNC are listed in the :ref:`secissues` section below.
 129
 130
 131 Workarounds
 132 -----------
 133
 134 Not applicable.
 135
 136
 137 Security Notes
 138 --------------
 139
 140
 141 Known Security Issues
 142 ~~~~~~~~~~~~~~~~~~~~~
 143
 144 There are no known outstanding security issues related to SDNC Istanbul.
 145
 146
 147 Test Results
 148 ============
 149 Not applicable
 150
 151
 152 References
 153 ==========
 154
 155 For more information on the ONAP Istanbul release, please see:
 156
 157 #. `ONAP Home Page`_
 158 #. `ONAP Documentation`_
 159 #. `ONAP Release Downloads`_
 160 #. `ONAP Wiki Page`_
 161
 162
 163 .. _`ONAP Home Page`: https://www.onap.org
 164 .. _`ONAP Wiki Page`: https://wiki.onap.org
 165 .. _`ONAP Documentation`: https://docs.onap.org
 166 .. _`ONAP Release Downloads`: https://git.onap.org
 167 .. _`ONAP Jira`: https://jira.onap.org
 168 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html