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
   6 ******************
   7 SDNC Release Notes
   8 ******************
   9
  10
  11 Abstract
  12 ========
  13
  14 This document provides the release notes for the Frankfurt release of the Software Defined
  15 Network Controller (SDNC)
  16
  17 Summary
  18 =======
  19
  20 The Frankfurt release of SDNC introduces new functionality to support PNFs (Physical Network Functions), extends support
  21 for Netconf/TLS to support CMPv2, and adds support for the Multi Domain Optical Network Service use case.
  22
  23
  24 Release Data
  25 ============
  26
  27 +-------------------------+-------------------------------------------+
  28 | **Project**             | SDNC                                      |
  29 |                         |                                           |
  30 +-------------------------+-------------------------------------------+
  31 | **Docker images**       | See :ref:`dockercontainers` section below |
  32 +-------------------------+-------------------------------------------+
  33 | **Release designation** | Frankfurt                                 |
  34 |                         |                                           |
  35 +-------------------------+-------------------------------------------+
  36 | **Release date**        | 06/04/2020                                |
  37 |                         |                                           |
  38 +-------------------------+-------------------------------------------+
  39
  40
  41 New features
  42 ------------
  43
  44 The SDNC Frankfurt release includes the following features:
  45
  46 * ORAN-compliant A1 adaptor (Jira `SDNC-965 <https://jira.onap.org/browse/SDNC-965>`_)
  47 * Multi-Domain Optical Service (Jira `SDNC-928 <https://jira.onap.org/browse/SDNC-928>`_)
  48 * Python 2 -> Python 3 migration (Jira `SDNC-967 <https://jira.onap.org/browse/SDNC-967>`_)
  49 * Upgrade to new Policy lifecycle API (Jira `SDNC-968 <https://jira.onap.org/browse/SDNC-968>`_)
  50
  51
  52
  53 For the complete list of `SDNC Frankfurt release epics <https://jira.onap.org/issues/?filter=12322>`_ and
  54 `SDNC Frankfurt release user stories <https://jira.onap.org/issues/?filter=12323>`_ , please see the `ONAP Jira`_.
  55
  56 **Bug fixes**
  57
  58 The full list of `bugs fixed in the SDNC Frankfurt release <https://jira.onap.org/issues/?filter=12324>`_ is maintained on the `ONAP Jira`_.
  59
  60 **Known Issues**
  61
  62 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
  63
  64 Deliverables
  65 ------------
  66
  67 Software Deliverables
  68 ~~~~~~~~~~~~~~~~~~~~~
  69
  70 .. _dockercontainers:
  71
  72 Docker Containers
  73 `````````````````
  74
  75 The following table lists the docker containers comprising the SDNC Frankfurt
  76 release along with the current stable Frankfurt version/tag.  Each of these is
  77 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
  78 with the following command::
  79
  80    docker pull nexus3.onap.org:10001/{image-name}:{version}
  81
  82
  83 Note: users that want to use the latest in-development Frankfurt version may use the
  84 tag 0.7-STAGING-latest to pull the latest daily Frankfurt build
  85
  86 +--------------------------------+-----------------------------------------------------+---------+
  87 | Image name                     | Description                                         | Version |
  88 +================================+=====================================================+=========+
  89 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 1.8.2   |
  90 +--------------------------------+-----------------------------------------------------+---------+
  91 | onap/sdnc-ansible-server-image | Ansible server                                      | 1.8.2   |
  92 +--------------------------------+-----------------------------------------------------+---------+
  93 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 1.8.2   |
  94 +--------------------------------+-----------------------------------------------------+---------+
  95 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 1.8.2   |
  96 +--------------------------------+-----------------------------------------------------+---------+
  97 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 1.8.2   |
  98 +--------------------------------+-----------------------------------------------------+---------+
  99 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 1.8.2   |
 100 +--------------------------------+-----------------------------------------------------+---------+
 101
 102
 103 Documentation Deliverables
 104 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 105
 106 * `SDN Controller for Radio user guide`_
 107
 108 Known Limitations, Issues and Workarounds
 109 =========================================
 110
 111 System Limitations
 112 ------------------
 113
 114 No system limitations noted.
 115
 116
 117 Known Vulnerabilities
 118 ---------------------
 119
 120 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
 121 pertain to SDNC are listed in the :ref:`secissues` section below.
 122
 123
 124 Workarounds
 125 -----------
 126
 127 Not applicable.
 128
 129
 130 Security Notes
 131 --------------
 132
 133 Fixed Security Issues
 134 ~~~~~~~~~~~~~~~~~~~~~
 135
 136 The following security issues have been addressed in the Frankfurt SDNC release:
 137
 138 * `OSJI-34 <https://jira.onap.org/browse/OJSI-34>`_ : Multiple SQL Injection issues in SDNC
 139 * `OSJI-40 <https://jira.onap.org/browse/OJSI-40>`_ : SDNC service allows for arbitrary code execution
 140 * `OSJI-41 <https://jira.onap.org/browse/OJSI-41>`_ : SDNC service allows for arbitrary code execution in sla/dgUpload form (CVE-2019-12132)
 141 * `OSJI-42 <https://jira.onap.org/browse/OJSI-42>`_ : SDNC service allows for arbitrary code execution in sla/printAsXml form (CVE-2019-12123)
 142 * `OSJI-43 <https://jira.onap.org/browse/OJSI-43>`_ : SDNC service allows for arbitrary code execution in sla/printAsGv form (CVE-2019-12113)
 143 * `OSJI-199 <https://jira.onap.org/browse/OJSI-199>`_ : SDNC service allows for arbitrary code execution in sla/upload form (CVE-2019-12112)
 144 * `SDNC-1145 <https://jira.onap.org/browse/SDNC-1145>`_ : Pods still run as root
 145 * `SDNC-970 <https://jira.onap.org/browse/SDNC-970>`_ : Password removal from OOM Helm charts
 146
 147 .. _secissues :
 148
 149 Known Security Issues
 150 ~~~~~~~~~~~~~~~~~~~~~
 151
 152 There is currently one known SDNC security issue, related to the SDNC portal
 153
 154 * `OJSI-91 <https://jira.onap.org/browse/OJSI-91>`_ : SDNC exposes unprotected API for user creation
 155
 156 The current implementation of the SDNC portal has a self-subscription model - so anyone can create an account by going to
 157 the setup link.  This is not appropriate for production deployment and will be fixed in a future release.
 158 The SDNC portal is disabled in the Frankfurt helm charts and we recommend that it NOT be enabled in a production
 159 deployment until this issue is corrected.
 160
 161
 162
 163 Test Results
 164 ============
 165 Not applicable
 166
 167
 168 References
 169 ==========
 170
 171 For more information on the ONAP Frankfurt release, please see:
 172
 173 #. `ONAP Home Page`_
 174 #. `ONAP Documentation`_
 175 #. `ONAP Release Downloads`_
 176 #. `ONAP Wiki Page`_
 177
 178
 179 .. _`ONAP Home Page`: https://www.onap.org
 180 .. _`ONAP Wiki Page`: https://wiki.onap.org
 181 .. _`ONAP Documentation`: https://docs.onap.org
 182 .. _`ONAP Release Downloads`: https://git.onap.org
 183 .. _`ONAP Jira`: https://jira.onap.org
 184 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html