Update release notes for Istanbul mtce rel 1
[ccsdk/distribution.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 CCSDK Release Notes
9 *******************
10
11
12 Abstract
13 ========
14
15 This document provides the release notes for the Istanbul release of the Common Controller Software
16 Development Kit (CCSDK).
17
18 Summary
19 =======
20
21 The Istanbul release of CCSDK introduces enhancements to network slicing and extends support
22 for ORAN integration via the A1 interface.  It also includes a major OpenDaylight release
23 upgrade (to Silicon).
24
25
26 Release Data
27 ============
28
29 +-------------------------+-------------------------------------------+
30 | **Project**             | CCSDK                                     |
31 |                         |                                           |
32 +-------------------------+-------------------------------------------+
33 | **Docker images**       | See :ref:`dockercontainers` section below |
34 +-------------------------+-------------------------------------------+
35 | **Release designation** | Istanbul Maintenance Release 1            |
36 |                         |                                           |
37 +-------------------------+-------------------------------------------+
38
39
40 New features
41 ------------
42
43 The CCSDK Istanbul release includes the following features:
44
45 * Upgrade to OpenDaylight Silicon Release (Jira `CCSDK-3390 <https://jira.onap.org/browse/CCSDK-3390>`_)
46 * A1 Adapter and A1 Policy Management Extensions in Istanbul Release - CCSDK (Jira `CCSDK-3229 <https://jira.onap.org/browse/CCSDK-3229>`_)
47 * Support of O-RAN-SC D-Release (Jira `CCSDK-3158 <https://jira.onap.org/browse/CCSDK-3158>`_)
48 * CCSDK impacts for Network slicing in Istanbul Release (Jira `CCSDK-3297 <https://jira.onap.org/browse/CCSDK-3297>`_)
49
50
51
52 For the complete list of `CCSDK Istanbul release epics <https://jira.onap.org/issues/?filter=12635>`_ and
53 `CCSDK Istanbul release user stories <https://jira.onap.org/issues/?filter=12636>`_ , please see the `ONAP Jira`_.
54
55 **Bug fixes**
56
57 Istanbul Maintenance Release 1 addresses a critical vulnerability discovered in the log4j library.  This
58 issue has been resolved by upgrading to version 2.17.1 of log4j-core, which is no longer vulnerable to
59 this issue.  The complete list of changes can be found in Jira `CCSDK-3556 <https://jira.onap.org/browse/CCSDK-3556>`
60
61 The full list of `bugs fixed in the CCSDK  Istanbul release <https://jira.onap.org/issues/?filter=12639>`_ is maintained on the `ONAP Jira`_.
62
63 **Known Issues**
64
65 The full list of `known issues in CCSDK <https://jira.onap.org/issues/?filter=11341>`_ is maintained on the `ONAP Jira`_.
66
67 Deliverables
68 ------------
69
70 Software Deliverables
71 ~~~~~~~~~~~~~~~~~~~~~
72
73 .. _dockercontainers:
74
75 Docker Containers
76 `````````````````
77
78 The following table lists the docker containers comprising the CCSDK Guilin
79 release along with the current stable Guilin version/tag.  Each of these is
80 available on the ONAP nexus3 site (https://nexus3.onap.org) and can be downloaded
81 with the following command::
82
83    docker pull nexus3.onap.org:10001/{image-name}:{version}
84
85
86 Note: users that want to use the latest in-development Guilin version may use the
87 tag 1.0-STAGING-latest to pull the latest daily Guilin build
88
89 +---------------------------------------+--------------------------------------------+---------+
90 | Image name                            | Description                                | Version |
91 +=======================================+============================================+=========+
92 | onap/ccsdk-alpine-j11-image           | Base Alpine Linux image for CCSDK          | 1.2.6   |
93 +---------------------------------------+--------------------------------------------+---------+
94 | onap/ccsdk-ansible-server-image       | Ansible server image                       | 1.2.6   |
95 +---------------------------------------+--------------------------------------------+---------+
96 | onap/ccsdk-apps-ms-neng               | Naming microservice                        | 1.2.1   |
97 +---------------------------------------+--------------------------------------------+---------+
98 | onap/ccsdk-blueprints-processor       | CDS blueprint processor                    | 1.2.1   |
99 +---------------------------------------+--------------------------------------------+---------+
100 | onap/ccsdk-cds-ui-server              | CDS user interface back end                | 1.2.1   |
101 +---------------------------------------+--------------------------------------------+---------+
102 | onap/ccsdk-commandexecutor            | CDS command executor                       | 1.2.1   |
103 +---------------------------------------+--------------------------------------------+---------+
104 | onap/ccsdk-controllerblueprint        | CDS controller blueprints                  | 1.2.1   |
105 +---------------------------------------+--------------------------------------------+---------+
106 | onap/ccsdk-dgbuilder-image            | Directed graph builder                     | 1.2.6   |
107 +---------------------------------------+--------------------------------------------+---------+
108 | onap/ccsdk-odl-silicon-alpine-image   | Alpine based OpenDaylight Silicon image    | 1.2.6   |
109 +---------------------------------------+--------------------------------------------+---------+
110 | onap/ccsdk-odlsli-alpine-image        | Alpine based OpenDaylight image with CCSDK | 1.2.6   |
111 +---------------------------------------+--------------------------------------------+---------+
112 | onap/ccsdk-saltstack-server-image     | Saltstack server                           | 1.2.6   |
113 +---------------------------------------+--------------------------------------------+---------+
114 | onap/ccsdk-sdclistener                | CDS SDC listener                           | 1.2.3   |
115 +---------------------------------------+--------------------------------------------+---------+
116 | onap/ccsdk-ubuntu-image               | Base Ubuntu image for CCSDK                | 1.2.6   |
117 +---------------------------------------+--------------------------------------------+---------+
118
119 Maven Artifacts
120 ```````````````
121 In addition to docker containers, CCSDK also provides libraries that are intended to be used by
122 client applications (e.g. APPC, SDNC) as maven dependencies.
123
124
125 ccsdk/parent
126 ^^^^^^^^^^^^
127 Many CCSDK clients need to be able to inherit settings from third party parent poms provided
128 by OpenDaylight or springboot, and therefore are unable to use the standard ONAP parent pom.
129 The CCSDK parent repository provides its own version of parent poms whose contents are consistent
130 with ONAP standard settings (as defined in oparent), but whose parent is the OpenDaylight or
131 springboot parent, so that clients can effectively merge both sets of settings.
132
133 The following table lists the parent poms provided by CCSDK and the current stable
134 Frankfurt version of each.
135
136 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
137 | groupId               | artifactId                    | version | Description                                                                                      |
138 +=======================+===============================+=========+==================================================================================================+
139 | org.onap.ccsdk.parent | binding-parent                | 2.2.4   | Parent used in place of OpenDaylight binding-parent                                              |
140 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
141 | org.onap.ccsdk.parent | bundle-parent                 | 2.2.4   | Parent used in place of OpenDaylight bundle-parent                                               |
142 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
143 | org.onap.ccsdk.parent | client-parent                 | 2.2.4   | Parent used for projects that create client libraries for OpenDaylight APIs                      |
144 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
145 | org.onap.ccsdk.parent | dependencies-bom              | 2.2.4   | Bill of Materials POM that defines versions of third party libraries used outside ODL container. |
146 |                       |                               |         | Intended to be imported in dependencyManagement section.                                         |
147 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
148 | org.onap.ccsdk.parent | dependencies-odl-bom          | 2.2.4   | Bill of Materials POM that defines versions of third party libraries used within ODL container.  |
149 |                       |                               |         | Intended to be imported in dependencyManagement section.                                         |
150 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
151 | org.onap.ccsdk.parent | feature-repo-parent           | 2.2.4   | Parent used in place of OpenDaylight feature-repo-parent                                         |
152 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
153 | org.onap.ccsdk.parent | karaf4-parent                 | 2.2.4   | Parent used in place of OpenDaylight karaf4-parent                                               |
154 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
155 | org.onap.ccsdk.parent | mdsal-it-parent               | 2.2.4   | Parent used in place of OpenDaylight mdsal-it-parent                                             |
156 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
157 | org.onap.ccsdk.parent | odlparent                     | 2.2.4   | Parent used in place of OpenDaylight odlparent                                                   |
158 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
159 | org.onap.ccsdk.parent | odlparent-lite                | 2.2.4   | Parent used in place of OpenDaylight odlparent-lite                                              |
160 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
161 | org.onap.ccsdk.parent | single-feature-parent         | 2.2.4   | Parent used in place of OpenDaylight single-feature-parent                                       |
162 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
163 | org.onap.ccsdk.parent | spring-boot-1-starter-parent  | 2.2.4   | Parent used in place of spring-boot-starter-parent for Springboot 1.x.                           |
164 |                       |                               |         | *NOTE* This is deprecated and will be removed in a future release, since springboot 1.x should   |
165 |                       |                               |         | no longer be used due to security issues                                                         |
166 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
167 | org.onap.ccsdk.parent | spring-boot-25-starter-parent | 2.2.4   | Parent used in place of spring-boot-starter-parent for Springboot 2.5.x                          |
168 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
169 | org.onap.ccsdk.parent | spring-boot-starter-parent    | 2.2.4   | Parent used in place of spring-boot-starter-parent for Springboot 2.3.x                          |
170 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
171 | org.onap.ccsdk.parent | standalone-parent             | 2.2.4   | Parent used for projects that have no need for other third party parent poms                     |
172 +-----------------------+-------------------------------+---------+--------------------------------------------------------------------------------------------------+
173
174 ccsdk/sli
175 ^^^^^^^^^^^^^^
176 The ccsdk/sli library provides the Service Logic Interpreter (SLI), which is the engine that runs directed graphs.  It also
177 provides a number of libraries that can be used by other CCSDK client projects.
178
179 The following table lists the maven artifacts provided for use by CCSDK client
180 projects.
181
182 +-------------------------------+------------------------------+---------+--------------------------------------------+
183 | groupId                       | artifactId                   | version | Description                                |
184 +===============================+==============================+=========+============================================+
185 | org.onap.ccsdk.sli.core       | dblib-provider               | 1.3.4   | Database access library                    |
186 +-------------------------------+------------------------------+---------+--------------------------------------------+
187 | org.onap.ccsdk.sli.core       | sli-common                   | 1.3.4   | Common SLI data objects                    |
188 +-------------------------------+------------------------------+---------+--------------------------------------------+
189 | org.onap.ccsdk.sli.core       | sli-provider-base            | 1.3.4   | ODL-independent SLI implementation objects |
190 +-------------------------------+------------------------------+---------+--------------------------------------------+
191 | org.onap.ccsdk.sli.core       | sli-provider                 | 1.3.4   | ODL-dependent SLI implementation objects   |
192 +-------------------------------+------------------------------+---------+--------------------------------------------+
193 | org.onap.ccsdk.sli.core       | sliPluginUtils-provider      | 1.3.4   | Utilities for use in SLI adaptors/plugins  |
194 +-------------------------------+------------------------------+---------+--------------------------------------------+
195 | org.onap.ccsdk.sli.core       | utils-provider               | 1.3.4   | Utilities                                  |
196 +-------------------------------+------------------------------+---------+--------------------------------------------+
197 | org.onap.ccsdk.sli.adaptors   | aai-service-provider         | 1.3.4   | A&AI interface adaptor                     |
198 +-------------------------------+------------------------------+---------+--------------------------------------------+
199 | org.onap.ccsdk.sli.adaptors   | ansible-adapter-bundle       | 1.3.4   | Ansible interface adaptor                  |
200 +-------------------------------+------------------------------+---------+--------------------------------------------+
201 | org.onap.ccsdk.sli.adaptors   | mdsal-resource-provider      | 1.3.4   | MD-SAL interface adaptor                   |
202 +-------------------------------+------------------------------+---------+--------------------------------------------+
203 | org.onap.ccsdk.sli.adaptors   | netbox-client-provider       | 1.3.4   | netbox interface adaptor                   |
204 +-------------------------------+------------------------------+---------+--------------------------------------------+
205 | org.onap.ccsdk.sli.adaptors   | resource-assignment-provider | 1.3.4   | resource allocator                         |
206 +-------------------------------+------------------------------+---------+--------------------------------------------+
207 | org.onap.ccsdk.sli.adaptors   | saltstack-adaptor-provider   | 1.3.4   | saltstack interface adaptor                |
208 +-------------------------------+------------------------------+---------+--------------------------------------------+
209 | org.onap.ccsdk.sli.adaptors   | sql-resource-provider        | 1.3.4   | SQL database interface adaptor             |
210 +-------------------------------+------------------------------+---------+--------------------------------------------+
211 | org.onap.ccsdk.sli.northbound | asdcApi-provider             | 1.3.4   | ODL-based SDC interface                    |
212 +-------------------------------+------------------------------+---------+--------------------------------------------+
213 | org.onap.ccsdk.sli.northbound | dataChange-provider          | 1.3.4   | A&AI data change notification interface    |
214 +-------------------------------+------------------------------+---------+--------------------------------------------+
215 | org.onap.ccsdk.sli.northbound | dmaap-listener               | 1.3.4   | DMaaP listener interface                   |
216 +-------------------------------+------------------------------+---------+--------------------------------------------+
217 | org.onap.ccsdk.sli.northbound | lcm-provider                 | 1.3.4   | Life Cycle Management event interface      |
218 +-------------------------------+------------------------------+---------+--------------------------------------------+
219 | org.onap.ccsdk.sli.northbound | ueb-listener                 | 1.3.4   | SDC event listener                         |
220 +-------------------------------+------------------------------+---------+--------------------------------------------+
221 | org.onap.ccsdk.sli.plugins    | properties-node-provider     | 1.3.4   | Used to load a properties file for use in  |
222 |                               |                              |         | a directed graph                           |
223 +-------------------------------+------------------------------+---------+--------------------------------------------+
224 | org.onap.ccsdk.sli.plugins    | restapi-call-node-provider   | 1.3.4   | Used to call a generic REST API from a     |
225 |                               |                              |         | directed graph                             |
226 +-------------------------------+------------------------------+---------+--------------------------------------------+
227 | org.onap.ccsdk.sli.plugins    | restconf-client-provider     | 1.3.4   | Used to call a RESTCONF API from a         |
228 |                               |                              |         | directed graph                             |
229 +-------------------------------+------------------------------+---------+--------------------------------------------+
230 | org.onap.ccsdk.sli.plugins    | sshapi-call-node             | 1.3.4   | Used to invoke an SSH interface from a     |
231 |                               |                              |         | directed graph                             |
232 +-------------------------------+------------------------------+---------+--------------------------------------------+
233 | org.onap.ccsdk.sli.plugins    | template-node-provider       | 1.3.4   | Provides velocity template support         |
234 +-------------------------------+------------------------------+---------+--------------------------------------------+
235
236 Documentation Deliverables
237 ~~~~~~~~~~~~~~~~~~~~~~~~~~
238 * `CDS user guide`_
239 * `SDN Controller for Radio user guide`_
240
241 Known Limitations, Issues and Workarounds
242 =========================================
243
244 System Limitations
245 ------------------
246
247 No system limitations noted.
248
249
250 Known Vulnerabilities
251 ---------------------
252
253 Any known vulnerabilities for ONAP are tracked in the `ONAP Jira`_ in the OJSI project.  Any outstanding OJSI issues that
254 pertain to CCSDK are listed in the :ref:`secissues` section below.
255
256
257 Workarounds
258 -----------
259
260 Not applicable.
261
262
263 Security Notes
264 --------------
265
266 Fixed Security Issues
267 ~~~~~~~~~~~~~~~~~~~~~
268
269 There are no new security fixes in the Guilin release.
270
271 .. _secissues :
272
273 Known Security Issues
274 ~~~~~~~~~~~~~~~~~~~~~
275
276 There is currently only one known CCSDK security issue, related to a third party application (netbox) that CCSDK uses:
277
278 * `OJSI-160 <https://jira.onap.org/browse/OJSI-160>`_ : netbox-nginx exposes plain text HTTP endpoint using port 30420
279
280
281
282 Test Results
283 ============
284 Not applicable
285
286
287 References
288 ==========
289
290 For more information on the ONAP Istanbul release, please see:
291
292 #. `ONAP Home Page`_
293 #. `ONAP Documentation`_
294 #. `ONAP Release Downloads`_
295 #. `ONAP Wiki Page`_
296
297
298 .. _`ONAP Home Page`: https://www.onap.org
299 .. _`ONAP Wiki Page`: https://wiki.onap.org
300 .. _`ONAP Documentation`: https://docs.onap.org
301 .. _`ONAP Release Downloads`: https://git.onap.org
302 .. _`ONAP Jira`: https://jira.onap.org
303 .. _`CDS user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html
304 .. _`SDN Controller for Radio user guide`: https://docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/home.html