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 Istanbul release of the Software Defined
  16 Network Controller (SDNC)
  17
  18 Summary
  19 =======
  20
  21 The Istanbul release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
  22 upgrade (to Silicon).
  23
  24 The Istanbul 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** | Istanbul                                  |
  40 |                         |                                           |
  41 +-------------------------+-------------------------------------------+
  42
  43
  44 New features
  45 ------------
  46
  47 The SDNC Istanbul release includes the following features, most of which are inherited from CCSDK:
  48
  49 * Enhance CSIT testing for SDNC (Jira `SDNC-1544 <https://jira.onap.org/browse/SDNC-1544>`)
  50 * Upgrade to OpenDaylight Silicon Release (Jira `CCSDK-3390 <https://jira.onap.org/browse/CCSDK-3390>`_)
  51 * A1 Adapter and A1 Policy Management Extensions in Istanbul Release - CCSDK (Jira `CCSDK-3229 <https://jira.onap.org/browse/CCSDK-3229>`_)
  52 * Support of O-RAN-SC D-Release (Jira `CCSDK-3158 <https://jira.onap.org/browse/CCSDK-3158>`_)
  53 * CCSDK impacts for Network slicing in Istanbul Release (Jira `CCSDK-3297 <https://jira.onap.org/browse/CCSDK-3297>`_)
  54
  55 For the complete list of `SDNC Istanbul release epics <https://jira.onap.org/issues/?filter=12638>`_ and
  56 `SDNC Honolulu release user stories <https://jira.onap.org/issues/?filter=12637>`_ , please see the `ONAP Jira`_.
  57
  58 **Bug fixes**
  59
  60 The full list of `bugs fixed in the SDNC Istanbul release <https://jira.onap.org/issues/?filter=12643>`_ is maintained on the `ONAP Jira`_.
  61
  62 **Known Issues**
  63
  64 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
  65
  66
  67
  68 Deliverables
  69 ------------
  70
  71 Software Deliverables
  72 ~~~~~~~~~~~~~~~~~~~~~
  73
  74 .. _dockercontainers:
  75
  76 Docker Containers
  77 `````````````````
  78
  79 The following table lists the docker containers comprising the SDNC Honolulu
  80 release along with the current stable Honolulu version/tag.  Each of these is
  81 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  82 with the following command::
  83
  84    docker pull nexus3.onap.org:10001/{image-name}:{version}
  85
  86
  87
  88 +--------------------------------+-----------------------------------------------------+---------+
  89 | Image name                     | Description                                         | Version |
  90 +================================+=====================================================+=========+
  91 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.2.1   |
  92 +--------------------------------+-----------------------------------------------------+---------+
  93 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.2.1   |
  94 +--------------------------------+-----------------------------------------------------+---------+
  95 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.2.1   |
  96 +--------------------------------+-----------------------------------------------------+---------+
  97 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.2.1   |
  98 +--------------------------------+-----------------------------------------------------+---------+
  99 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.2.1   |
 100 +--------------------------------+-----------------------------------------------------+---------+
 101 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.2.1   |
 102 +--------------------------------+-----------------------------------------------------+---------+
 103
 104
 105 Documentation Deliverables
 106 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 107
 108 * `SDN Controller for Radio user guide`_
 109
 110 Known Limitations, Issues and Workarounds
 111 =========================================
 112
 113 System Limitations
 114 ------------------
 115
 116 No system limitations noted.
 117
 118
 119 Known Vulnerabilities
 120 ---------------------
 121
 122 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 123 pertain to SDNC are listed in the :ref:`secissues` section below.
 124
 125
 126 Workarounds
 127 -----------
 128
 129 Not applicable.
 130
 131
 132 Security Notes
 133 --------------
 134
 135
 136 Known Security Issues
 137 ~~~~~~~~~~~~~~~~~~~~~
 138
 139 There are no known outstanding security issues related to SDNC Istanbul.
 140
 141
 142 Test Results
 143 ============
 144 Not applicable
 145
 146
 147 References
 148 ==========
 149
 150 For more information on the ONAP Istanbul release, please see:
 151
 152 #. `ONAP Home Page`_
 153 #. `ONAP Documentation`_
 154 #. `ONAP Release Downloads`_
 155 #. `ONAP Wiki Page`_
 156
 157
 158 .. _`ONAP Home Page`: https://www.onap.org
 159 .. _`ONAP Wiki Page`: https://wiki.onap.org
 160 .. _`ONAP Documentation`: https://docs.onap.org
 161 .. _`ONAP Release Downloads`: https://git.onap.org
 162 .. _`ONAP Jira`: https://jira.onap.org
 163 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html