Update versions in release notes
[sdnc/oam.git] / 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 Honolulu release of the Software Defined
16 Network Controller (SDNC)
17
18 Summary
19 =======
20
21 The Honolulu 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** | Honolulu                                  |
37 |                         |                                           |
38 +-------------------------+-------------------------------------------+
39 | **Release date**        | 4/22/2021                                 |
40 |                         |                                           |
41 +-------------------------+-------------------------------------------+
42
43
44 New features
45 ------------
46
47 The SDNC Honolulu release includes the following features:
48
49 * SDN-C (SDN-R) support of E2E Network Slicing in Honolulu (Jira `SDNC-1415 <https://jira.onap.org/browse/SDNC-1415>`_)
50 * ONAP CNF Orchestration - Honolulu Enhancements (SDNC) (Jira `SDNC-1451 <https://jira.onap.org/browse/SDNC-1451>`_)
51 * Decouple SDNC from OpenDaylight / Karaf : phase 3 (Jira `SDNC-1348 <https://jira.onap.org/browse/SDNC-1348>`_)
52
53 This release also includes an upgrade to the OpenDaylight Aluminum release, which SDNC consumes from CCSDK.
54
55 For the complete list of `SDNC Honolulu release epics <https://jira.onap.org/issues/?filter=12498>`_ and 
56 `SDNC Honolulu release user stories <https://jira.onap.org/issues/?filter=12499>`_ , please see the `ONAP Jira`_.
57
58 **Bug fixes**
59
60 The full list of `bugs fixed in the SDNC Honolulu release <https://jira.onap.org/issues/?filter=12500>`_ 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.1.5   |
92 +--------------------------------+-----------------------------------------------------+---------+
93 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.1.5   |
94 +--------------------------------+-----------------------------------------------------+---------+
95 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.1.5   |
96 +--------------------------------+-----------------------------------------------------+---------+
97 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.1.5   |
98 +--------------------------------+-----------------------------------------------------+---------+
99 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.1.5   |
100 +--------------------------------+-----------------------------------------------------+---------+
101 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.1.5   |
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 Honolulu.
140
141
142 Test Results
143 ============
144 Not applicable
145
146
147 References
148 ==========
149
150 For more information on the ONAP Honolulu 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/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html