Chore: Add gerrit maven verify GHA workflow
[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 London release of the Software Defined
16 Network Controller (SDNC)
17
18 Summary
19 =======
20
21 The London release of SDNC includes enhancements network slicing as well as a major OpenDaylight release
22 upgrade (to Chlorine).
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** | London                                    |
36 |                         |                                           |
37 +-------------------------+-------------------------------------------+
38
39
40 New features
41 ------------
42
43 The SDNC London release includes the following features,  which are inherited from CCSDK:
44
45 * Upgrade to OpenDaylight Chlorine Release (Jira `CCSDK-3812 <https://jira.onap.org/browse/CCSDK-3812>`_)
46
47
48 For the complete list of `CCSDK London release epics <https://jira.onap.org/issues/?filter=13112>`_ and
49 `CCSDK London release user stories <https://jira.onap.org/issues/?filter=13113>`_ , please see the `ONAP Jira`_.
50
51 **Bug fixes**
52
53
54 The full list of `bugs fixed in the SDNC London release <https://jira.onap.org/issues/?filter=13116>`_ is maintained on the `ONAP Jira`_.
55
56 **Known Issues**
57
58 * Impacts of PAX/JETTY V9 to oauth and websockets in SDNR (Jira `SDNC-1809 <https://jira.onap.org/browse/SDNC-1809>`_)
59
60 The full list of `known issues in SDNC <https://jira.onap.org/issues/?filter=11119>`_ is maintained on the `ONAP Jira`_.
61
62
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 London
76 release along with the current stable London 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
84 +--------------------------------+-----------------------------------------------------+---------+
85 | Image name                     | Description                                         | Version |
86 +================================+=====================================================+=========+
87 | onap/sdnc-aaf-image            | SDNC controller image, integrated with AAF for RBAC | 2.5.4   |
88 +--------------------------------+-----------------------------------------------------+---------+
89 | onap/sdnc-ansible-server-image | Ansible server                                      | 2.5.4   |
90 +--------------------------------+-----------------------------------------------------+---------+
91 | onap/sdnc-dmaap-listener-image | DMaaP listener                                      | 2.5.4   |
92 +--------------------------------+-----------------------------------------------------+---------+
93 | onap/sdnc-image                | SDNC controller image, without AAF integration      | 2.5.4   |
94 +--------------------------------+-----------------------------------------------------+---------+
95 | onap/sdnc-ueb-listener-image   | SDC listener                                        | 2.5.4   |
96 +--------------------------------+-----------------------------------------------------+---------+
97 | onap/sdnc-web-image            | Web tier (currently only used by SDN-R persona)     | 2.5.4   |
98 +--------------------------------+-----------------------------------------------------+---------+
99
100
101 Documentation Deliverables
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~
103
104 * `SDN Controller for Radio user guide`_
105
106 Known Limitations, Issues and Workarounds
107 =========================================
108
109 System Limitations
110 ------------------
111
112 No system limitations noted.
113
114
115 Known Vulnerabilities
116 ---------------------
117
118 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
119 pertain to SDNC are listed in the "Known Security Issues" section below.
120
121
122 Workarounds
123 -----------
124
125 Not applicable.
126
127
128 Security Notes
129 --------------
130
131
132 Known Security Issues
133 ~~~~~~~~~~~~~~~~~~~~~
134
135 There are no known outstanding security issues related to SDNC London.
136
137
138 Test Results
139 ============
140 Not applicable
141
142
143 References
144 ==========
145
146 For more information on the ONAP London release, please see:
147
148 #. `ONAP Home Page`_
149 #. `ONAP Documentation`_
150 #. `ONAP Release Downloads`_
151 #. `ONAP Wiki Page`_
152
153
154 .. _`ONAP Home Page`: https://www.onap.org
155 .. _`ONAP Wiki Page`: https://wiki.onap.org
156 .. _`ONAP Documentation`: https://docs.onap.org
157 .. _`ONAP Release Downloads`: https://git.onap.org
158 .. _`ONAP Jira`: https://jira.onap.org
159 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/projects/onap-ccsdk-features/en/latest/guides/onap-user/home.html