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