Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / ncmp-dmi-plugin / cd485287b10cdd407ec9f6cba6abb29ff3a95bfc / . / docs / release-notes.rst
blob: 887f6cfd5bb6cfbcdbd6713c88890e4b243d47a9 [file] [log] [blame]
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]3.. Copyright (C) 2021-2022 Nordix Foundation
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
8
9
10========================
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]11DMI-Plugin Release Notes
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]12========================
13
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]14.. contents::
15 :depth: 2
16..
leventecsanyi8db6a302024-04-02 14:37:57 +0200[diff] [blame]17
18.. =========================
19.. * * * NEW DELHI * * *
20.. =========================
21
seanbeirne2a83a1e2024-05-14 15:39:35 +0100[diff] [blame]22Version: 1.5.1
23==============
24
25Release Data
26------------
27
28+--------------------------------------+--------------------------------------------------------+
29| **CPS Project** | DMI-Plugin |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Docker images** | onap/ncmp-dmi-plugin:1.5.1 |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release designation** | 1.5.1 New Delhi |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38| **Release date** | (not yet released) |
39| | |
40+--------------------------------------+--------------------------------------------------------+
41
42Features
43--------
44
leventecsanyi8db6a302024-04-02 14:37:57 +0200[diff] [blame]45Version: 1.5.0
46==============
47
48Release Data
49------------
50
51+--------------------------------------+--------------------------------------------------------+
52| **CPS Project** | DMI-Plugin |
53| | |
54+--------------------------------------+--------------------------------------------------------+
55| **Docker images** | onap/ncmp-dmi-plugin:1.5.0 |
56| | |
57+--------------------------------------+--------------------------------------------------------+
seanbeirne2a83a1e2024-05-14 15:39:35 +0100[diff] [blame]58| **Release designation** | 1.5.0 New Delhi |
leventecsanyi8db6a302024-04-02 14:37:57 +0200[diff] [blame]59| | |
60+--------------------------------------+--------------------------------------------------------+
seanbeirne2a83a1e2024-05-14 15:39:35 +0100[diff] [blame]61| **Release date** | 2024 May 14 |
leventecsanyi8db6a302024-04-02 14:37:57 +0200[diff] [blame]62| | |
63+--------------------------------------+--------------------------------------------------------+
64
65Features
66--------
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]67 - `CPS-2030 <https://lf-onap.atlassian.net/browse/CPS-2030>`_ Add moduleSetTag to the request towards dmi plugin if moduleSetTag is set for the cmHandle.
leventecsanyi8db6a302024-04-02 14:37:57 +0200[diff] [blame]68
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]69.. ====================
70.. * * * KOHN * * *
71.. ====================
72
mpriyanka068cd42023-11-07 12:11:57 +0000[diff] [blame]73Version: 1.4.1
74==============
75
76Release Data
77------------
78
79+--------------------------------------+--------------------------------------------------------+
80| **CPS Project** | DMI-Plugin |
81| | |
82+--------------------------------------+--------------------------------------------------------+
83| **Docker images** | onap/ncmp-dmi-plugin:1.4.1 |
84| | |
85+--------------------------------------+--------------------------------------------------------+
86| **Release designation** | 1.4.1 Montreal |
87| | |
88+--------------------------------------+--------------------------------------------------------+
89| **Release date** | (not yet released) |
90| | |
91+--------------------------------------+--------------------------------------------------------+
92
93Features
94--------
95
mpriyank6128d732023-11-06 17:53:00 +0000[diff] [blame]96Version: 1.4.0
97==============
98
99Release Data
100------------
101
102+--------------------------------------+--------------------------------------------------------+
103| **CPS Project** | DMI-Plugin |
104| | |
105+--------------------------------------+--------------------------------------------------------+
106| **Docker images** | onap/ncmp-dmi-plugin:1.4.0 |
107| | |
108+--------------------------------------+--------------------------------------------------------+
109| **Release designation** | 1.4.0 Montreal |
110| | |
111+--------------------------------------+--------------------------------------------------------+
mpriyanka068cd42023-11-07 12:11:57 +0000[diff] [blame]112| **Release date** | 2023 November 7 |
mpriyank6128d732023-11-06 17:53:00 +0000[diff] [blame]113| | |
114+--------------------------------------+--------------------------------------------------------+
115
116Features
117--------
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]118 - `CPS-1775 <https://lf-onap.atlassian.net/browse/CPS-1775>`_ Migrate to Java 17.
119 - `CPS-1790 <https://lf-onap.atlassian.net/browse/CPS-1790>`_ Update to Spring Boot 3.1.2.
mpriyank6128d732023-11-06 17:53:00 +0000[diff] [blame]120
121
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]122Version: 1.2.2 (not yet released)
123=================================
124
125Release Data
126------------
127
128+--------------------------------------+--------------------------------------------------------+
129| **CPS Project** | DMI-Plugin |
130| | |
131+--------------------------------------+--------------------------------------------------------+
132| **Docker images** | onap/ncmp-dmi-plugin:1.2.2 |
133| | |
134+--------------------------------------+--------------------------------------------------------+
135| **Release designation** | 1.2.2 Kohn |
136| | |
137+--------------------------------------+--------------------------------------------------------+
138| **Release date** | (not yet released) |
139| | |
140+--------------------------------------+--------------------------------------------------------+
141
142Bug Fixes
143---------
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]144 - `CPS-1350 <https://lf-onap.atlassian.net/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]145
146
mpriyanka0acef12022-09-26 15:03:49 +0100[diff] [blame]147Version: 1.2.1
148==============
149
150Release Data
151------------
152
153+--------------------------------------+--------------------------------------------------------+
154| **CPS Project** | DMI-Plugin |
155| | |
156+--------------------------------------+--------------------------------------------------------+
157| **Docker images** | onap/ncmp-dmi-plugin:1.2.1 |
158| | |
159+--------------------------------------+--------------------------------------------------------+
160| **Release designation** | 1.2.1 Kohn |
161| | |
162+--------------------------------------+--------------------------------------------------------+
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]163| **Release date** | 2022 October 5 |
mpriyanka0acef12022-09-26 15:03:49 +0100[diff] [blame]164| | |
165+--------------------------------------+--------------------------------------------------------+
166
167Bug Fixes
168---------
169 - None
170
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]171Version: 1.2.0
172==============
173
174Release Data
175------------
176
177+--------------------------------------+--------------------------------------------------------+
178| **CPS Project** | DMI-Plugin |
179| | |
180+--------------------------------------+--------------------------------------------------------+
181| **Docker images** | onap/ncmp-dmi-plugin:1.2.0 |
182| | |
183+--------------------------------------+--------------------------------------------------------+
184| **Release designation** | 1.2.0 Kohn |
185| | |
186+--------------------------------------+--------------------------------------------------------+
187| **Release date** | 2022 September 21 |
188| | |
189+--------------------------------------+--------------------------------------------------------+
190
191Features
192--------
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]193 - `CPS-562 <https://lf-onap.atlassian.net/browse/CPS-562>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
194 - `CPS-832 <https://lf-onap.atlassian.net/browse/CPS-832>`_ Async: E2E Integration
195 - `CPS-828 <https://lf-onap.atlassian.net/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]196
197Bug Fixes
198---------
199 - None
200
201Known Limitations, Issues and Workarounds
202-----------------------------------------
203
204*System Limitations*
205
206None
207
208*Known Vulnerabilities*
209
210None
211
212*Workarounds*
213
214None
215
216Security Notes
217--------------
218
219*Fixed Security Issues*
220
221None
222
223*Known Security Issues*
224
225None
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]226
227.. ========================
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]228.. * * * JAKARTA * * *
229.. ========================
230
Bruno Sakotoe830dce2022-03-15 11:57:45 -0400[diff] [blame]231Version: 1.1.0
232==============
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]233
Bruno Sakotoe830dce2022-03-15 11:57:45 -0400[diff] [blame]234Release Data
235------------
236
237+--------------------------------------+--------------------------------------------------------+
238| **CPS Project** | DMI-Plugin |
239| | |
240+--------------------------------------+--------------------------------------------------------+
241| **Docker images** | onap/ncmp-dmi-plugin:1.1.0 |
242| | |
243+--------------------------------------+--------------------------------------------------------+
244| **Release designation** | 1.1.0 Jakarta |
245| | |
246+--------------------------------------+--------------------------------------------------------+
247| **Release date** | 2022 March 15 |
248| | |
249+--------------------------------------+--------------------------------------------------------+
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]250
251Features
252--------
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]253 - `CPS-637 <https://lf-onap.atlassian.net/browse/CPS-637>`_ Support Update operation for datastore pass-through running
254 - `CPS-639 <https://lf-onap.atlassian.net/browse/CPS-639>`_ Support Delete operation for datastore pass-through running
255 - `CPS-784 <https://lf-onap.atlassian.net/browse/CPS-784>`_ Add examples to DMI-Plugin API Spec
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]256
257Bug Fixes
258---------
259
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]260 - `CPS-841 <https://lf-onap.atlassian.net/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]261
262Known Limitations, Issues and Workarounds
263-----------------------------------------
264
265*System Limitations*
266
267None
268
269*Known Vulnerabilities*
270
271None
272
273*Workarounds*
274
275None
276
277Security Notes
278--------------
279
280*Fixed Security Issues*
281
282None
283
284*Known Security Issues*
285
286None
287
288.. ========================
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]289.. * * * ISTANBUL * * *
290.. ========================
291
Bruno Sakotob5cbf872022-02-11 15:05:35 -0500[diff] [blame]292Version: 1.0.3
293==============
294
295Release Data
296------------
297
298+--------------------------------------+--------------------------------------------------------+
299| **CPS Project** | DMI-Plugin |
300| | |
301+--------------------------------------+--------------------------------------------------------+
302| **Docker images** | onap/ncmp-dmi-plugin:1.0.3 |
303| | |
304+--------------------------------------+--------------------------------------------------------+
305| **Release designation** | 1.0.3 Istanbul |
306| | |
307+--------------------------------------+--------------------------------------------------------+
308| **Release date** | 2022-07-01 |
309| | |
310+--------------------------------------+--------------------------------------------------------+
311
312Bug Fixes
313---------
314
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]315 - `CPS-841 <https://lf-onap.atlassian.net/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
Bruno Sakotob5cbf872022-02-11 15:05:35 -0500[diff] [blame]316
317Version: 1.0.2
318==============
319
320Release Data
321------------
322
323+--------------------------------------+--------------------------------------------------------+
324| **CPS Project** | DMI-Plugin |
325| | |
326+--------------------------------------+--------------------------------------------------------+
327| **Docker images** | onap/ncmp-dmi-plugin:1.0.2 |
328| | |
329+--------------------------------------+--------------------------------------------------------+
330| **Release designation** | 1.0.2 Istanbul |
331| | |
332+--------------------------------------+--------------------------------------------------------+
333| **Release date** | 2021-16-12 |
334| | |
335+--------------------------------------+--------------------------------------------------------+
336
337Bug Fixes
338---------
339
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]340 - `CPS-820 <https://lf-onap.atlassian.net/browse/CPS-820>`_ Update log4j version due to security vulnerability
Bruno Sakotob5cbf872022-02-11 15:05:35 -0500[diff] [blame]341
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]342Version: 1.0.1
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]343==============
344
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]345Release Data
346------------
347
348+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]349| **CPS Project** | DMI-Plugin |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]350| | |
351+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]352| **Docker images** | onap/ncmp-dmi-plugin:1.0.1 |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]353| | |
354+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]355| **Release designation** | 1.0.1 Istanbul |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]356| | |
357+--------------------------------------+--------------------------------------------------------+
358| **Release date** | 2021-14-10 |
359| | |
360+--------------------------------------+--------------------------------------------------------+
361
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]362Bug Fixes
363---------
364
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]365 - `CPS-653 <https://lf-onap.atlassian.net/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
366 - `CPS-659 <https://lf-onap.atlassian.net/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
367 - `CPS-669 <https://lf-onap.atlassian.net/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
368 - `CPS-678 <https://lf-onap.atlassian.net/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
369 - `CPS-679 <https://lf-onap.atlassian.net/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
370 - `CPS-706 <https://lf-onap.atlassian.net/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]371
372Known Limitations, Issues and Workarounds
373-----------------------------------------
374
375*System Limitations*
376
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]377 - `CPS-719 <https://lf-onap.atlassian.net/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]378
379*Known Vulnerabilities*
380
381None
382
383*Workarounds*
384
385None
386
387Security Notes
388--------------
389
390*Fixed Security Issues*
391
392None
393
394*Known Security Issues*
395
396None
397
398Version: 1.0.0
399==============
400
401Release Data
402------------
403
404+--------------------------------------+--------------------------------------------------------+
405| **CPS Project** | DMI-Plugin |
406| | |
407+--------------------------------------+--------------------------------------------------------+
408| **Docker images** | onap/ncmp-dmi-plugin:1.0.0 |
409| | |
410+--------------------------------------+--------------------------------------------------------+
411| **Release designation** | 1.0.0 Istanbul |
412| | |
413+--------------------------------------+--------------------------------------------------------+
414| **Release date** | 2021-14-09 |
415| | |
416+--------------------------------------+--------------------------------------------------------+
417
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]418Features
419--------
420* Implement plugin registration.
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]421* Retrieve data from cmHandles using ncmp-datastores passthrough.
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]422* Retrieve Yang Resources from one or more modules of a CM Handle.
423
424.. _istanbul_deliverable:
425
426Deliverables
427------------
428
429Software Deliverables
430
431.. csv-table::
432 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
433 :widths: auto
434
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]435 "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]436
437Bug Fixes
438---------
439
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]440 - `CPS-504 <https://lf-onap.atlassian.net/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
441 - `CPS-589 <https://lf-onap.atlassian.net/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
442 - `CPS-617 <https://lf-onap.atlassian.net/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]443
444Summary
445-------
446
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]447Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]448
449 * Platform components
450
451 * Service components
452
453 * Additional resources that CPS utilizes deployed using ONAP common charts
454
455Below service components (mS) are available to be deployed on-demand.
456
457Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
458
459Known Limitations, Issues and Workarounds
460-----------------------------------------
461
462*System Limitations*
463
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]464None
465
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]466*Known Vulnerabilities*
467
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]468 - `CPS-653 <https://lf-onap.atlassian.net/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
469 - `CPS-659 <https://lf-onap.atlassian.net/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]470
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]471*Workarounds*
472
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]473None
474
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]475Security Notes
476--------------
477
478*Fixed Security Issues*
479
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]480None
481
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]482*Known Security Issues*
483
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]484None
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]485
486References
487----------
488
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]489For more information on the latest ONAP release, please see:
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]490
491#. `ONAP Home Page`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]492#. `ONAP Wiki Page`_
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]493#. `ONAP Documentation`_
494#. `ONAP DMI Plugin Documentation`_
495#. `ONAP Release Downloads`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]496
497
498.. _`ONAP Home Page`: https://www.onap.org
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]499.. _`ONAP Wiki Page`: https://lf-onap.atlassian.net/wiki/spaces/DW/overview
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]500.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]501.. _`ONAP DMI Plugin Documentation`: https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]502.. _`ONAP Release Downloads`: https://git.onap.org
503
504Quick Links:
505
halil.cakal46cbc862024-10-14 14:00:28 +0100[diff] [blame]506 - `CPS project page <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16398157/Configuration+Persistence+Service+Project>`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]507 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_