Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / ncmp-dmi-plugin / ad6dfda45cecb80b8bc56be2325aa8697313dd98 / . / docs / release-notes.rst
blob: b8290e751284a5379b2470bf3e7164a2b51246ca [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..
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]17.. ====================
18.. * * * KOHN * * *
19.. ====================
20
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]21Version: 1.2.2 (not yet released)
22=================================
23
24Release Data
25------------
26
27+--------------------------------------+--------------------------------------------------------+
28| **CPS Project** | DMI-Plugin |
29| | |
30+--------------------------------------+--------------------------------------------------------+
31| **Docker images** | onap/ncmp-dmi-plugin:1.2.2 |
32| | |
33+--------------------------------------+--------------------------------------------------------+
34| **Release designation** | 1.2.2 Kohn |
35| | |
36+--------------------------------------+--------------------------------------------------------+
37| **Release date** | (not yet released) |
38| | |
39+--------------------------------------+--------------------------------------------------------+
40
41Bug Fixes
42---------
JosephKeenandfe45ff2022-10-26 15:17:59 +0100[diff] [blame]43 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ [CPS/NCMP] Add Basic Auth to CPS/NCMP OpenAPI Definitions
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]44
45
mpriyanka0acef12022-09-26 15:03:49 +0100[diff] [blame]46Version: 1.2.1
47==============
48
49Release Data
50------------
51
52+--------------------------------------+--------------------------------------------------------+
53| **CPS Project** | DMI-Plugin |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Docker images** | onap/ncmp-dmi-plugin:1.2.1 |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Release designation** | 1.2.1 Kohn |
60| | |
61+--------------------------------------+--------------------------------------------------------+
mpriyankf3565592022-10-05 12:26:20 +0100[diff] [blame]62| **Release date** | 2022 October 5 |
mpriyanka0acef12022-09-26 15:03:49 +0100[diff] [blame]63| | |
64+--------------------------------------+--------------------------------------------------------+
65
66Bug Fixes
67---------
68 - None
69
lukegleeson7a8c68d2022-09-21 14:56:09 +0100[diff] [blame]70Version: 1.2.0
71==============
72
73Release Data
74------------
75
76+--------------------------------------+--------------------------------------------------------+
77| **CPS Project** | DMI-Plugin |
78| | |
79+--------------------------------------+--------------------------------------------------------+
80| **Docker images** | onap/ncmp-dmi-plugin:1.2.0 |
81| | |
82+--------------------------------------+--------------------------------------------------------+
83| **Release designation** | 1.2.0 Kohn |
84| | |
85+--------------------------------------+--------------------------------------------------------+
86| **Release date** | 2022 September 21 |
87| | |
88+--------------------------------------+--------------------------------------------------------+
89
90Features
91--------
92 - `CPS-562 <https://jira.onap.org/browse/CPS-562>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (DMI Plugin.)
93 - `CPS-832 <https://jira.onap.org/browse/CPS-832>`_ Async: E2E Integration
94 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
95
96Bug Fixes
97---------
98 - None
99
100Known Limitations, Issues and Workarounds
101-----------------------------------------
102
103*System Limitations*
104
105None
106
107*Known Vulnerabilities*
108
109None
110
111*Workarounds*
112
113None
114
115Security Notes
116--------------
117
118*Fixed Security Issues*
119
120None
121
122*Known Security Issues*
123
124None
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]125
126.. ========================
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]127.. * * * JAKARTA * * *
128.. ========================
129
Bruno Sakotoe830dce2022-03-15 11:57:45 -0400[diff] [blame]130Version: 1.1.0
131==============
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]132
Bruno Sakotoe830dce2022-03-15 11:57:45 -0400[diff] [blame]133Release Data
134------------
135
136+--------------------------------------+--------------------------------------------------------+
137| **CPS Project** | DMI-Plugin |
138| | |
139+--------------------------------------+--------------------------------------------------------+
140| **Docker images** | onap/ncmp-dmi-plugin:1.1.0 |
141| | |
142+--------------------------------------+--------------------------------------------------------+
143| **Release designation** | 1.1.0 Jakarta |
144| | |
145+--------------------------------------+--------------------------------------------------------+
146| **Release date** | 2022 March 15 |
147| | |
148+--------------------------------------+--------------------------------------------------------+
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]149
150Features
151--------
DylanB95EST1954daa2021-12-08 10:05:12 +0000[diff] [blame]152 - `CPS-637 <https://jira.onap.org/browse/CPS-637>`_ Support Update operation for datastore pass-through running
153 - `CPS-639 <https://jira.onap.org/browse/CPS-639>`_ Support Delete operation for datastore pass-through running
lukegleeson996152a2021-11-30 17:06:03 +0000[diff] [blame]154 - `CPS-784 <https://jira.onap.org/browse/CPS-784>`_ Add examples to DMI-Plugin API Spec
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]155
156Bug Fixes
157---------
158
puthuparambil.adityaed9c4882022-01-05 13:41:29 +0000[diff] [blame]159 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
niamhcore3b592bf2021-11-17 11:23:36 +0000[diff] [blame]160
161Known Limitations, Issues and Workarounds
162-----------------------------------------
163
164*System Limitations*
165
166None
167
168*Known Vulnerabilities*
169
170None
171
172*Workarounds*
173
174None
175
176Security Notes
177--------------
178
179*Fixed Security Issues*
180
181None
182
183*Known Security Issues*
184
185None
186
187.. ========================
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]188.. * * * ISTANBUL * * *
189.. ========================
190
Bruno Sakotob5cbf872022-02-11 15:05:35 -0500[diff] [blame]191Version: 1.0.3
192==============
193
194Release Data
195------------
196
197+--------------------------------------+--------------------------------------------------------+
198| **CPS Project** | DMI-Plugin |
199| | |
200+--------------------------------------+--------------------------------------------------------+
201| **Docker images** | onap/ncmp-dmi-plugin:1.0.3 |
202| | |
203+--------------------------------------+--------------------------------------------------------+
204| **Release designation** | 1.0.3 Istanbul |
205| | |
206+--------------------------------------+--------------------------------------------------------+
207| **Release date** | 2022-07-01 |
208| | |
209+--------------------------------------+--------------------------------------------------------+
210
211Bug Fixes
212---------
213
214 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
215
216Version: 1.0.2
217==============
218
219Release Data
220------------
221
222+--------------------------------------+--------------------------------------------------------+
223| **CPS Project** | DMI-Plugin |
224| | |
225+--------------------------------------+--------------------------------------------------------+
226| **Docker images** | onap/ncmp-dmi-plugin:1.0.2 |
227| | |
228+--------------------------------------+--------------------------------------------------------+
229| **Release designation** | 1.0.2 Istanbul |
230| | |
231+--------------------------------------+--------------------------------------------------------+
232| **Release date** | 2021-16-12 |
233| | |
234+--------------------------------------+--------------------------------------------------------+
235
236Bug Fixes
237---------
238
239 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
240
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]241Version: 1.0.1
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]242==============
243
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]244Release Data
245------------
246
247+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]248| **CPS Project** | DMI-Plugin |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]249| | |
250+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]251| **Docker images** | onap/ncmp-dmi-plugin:1.0.1 |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]252| | |
253+--------------------------------------+--------------------------------------------------------+
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]254| **Release designation** | 1.0.1 Istanbul |
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]255| | |
256+--------------------------------------+--------------------------------------------------------+
257| **Release date** | 2021-14-10 |
258| | |
259+--------------------------------------+--------------------------------------------------------+
260
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]261Bug Fixes
262---------
263
264 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
265 - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
266 - `CPS-669 <https://jira.onap.org/browse/CPS-669>`_ Improvements in the NCMP-DMI plugin OOM charts
267 - `CPS-678 <https://jira.onap.org/browse/CPS-678>`_ Passthrough read only supports known parameters (depth&field)
268 - `CPS-679 <https://jira.onap.org/browse/CPS-679>`_ Passthrough does not support resourceIdentifier with / tokens
269 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ get moduleschema/yangresouce endpoint not working
270
271Known Limitations, Issues and Workarounds
272-----------------------------------------
273
274*System Limitations*
275
276 - `CPS-719 <https://jira.onap.org/browse/CPS-719>`_ Passthrough query options do not support comma (,) token in values
277
278*Known Vulnerabilities*
279
280None
281
282*Workarounds*
283
284None
285
286Security Notes
287--------------
288
289*Fixed Security Issues*
290
291None
292
293*Known Security Issues*
294
295None
296
297Version: 1.0.0
298==============
299
300Release Data
301------------
302
303+--------------------------------------+--------------------------------------------------------+
304| **CPS Project** | DMI-Plugin |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307| **Docker images** | onap/ncmp-dmi-plugin:1.0.0 |
308| | |
309+--------------------------------------+--------------------------------------------------------+
310| **Release designation** | 1.0.0 Istanbul |
311| | |
312+--------------------------------------+--------------------------------------------------------+
313| **Release date** | 2021-14-09 |
314| | |
315+--------------------------------------+--------------------------------------------------------+
316
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]317Features
318--------
319* Implement plugin registration.
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]320* Retrieve data from cmHandles using ncmp-datastores passthrough.
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]321* Retrieve Yang Resources from one or more modules of a CM Handle.
322
323.. _istanbul_deliverable:
324
325Deliverables
326------------
327
328Software Deliverables
329
330.. csv-table::
331 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
332 :widths: auto
333
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]334 "cps/ncmp-dmi-plugin", "", "onap/ncmp-dmi-plugin:1.0.0"
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]335
336Bug Fixes
337---------
338
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]339 - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
340 - `CPS-589 <https://jira.onap.org/browse/CPS-589>`_ Json for Yang Resources does not contain name and revision tags
341 - `CPS-617 <https://jira.onap.org/browse/CPS-617>`_ DMI base path does not conform to agreed API URL
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]342
343Summary
344-------
345
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]346Following DMI-Plugin components are available with default ONAP/DMI-plugin installation.
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]347
348 * Platform components
349
350 * Service components
351
352 * Additional resources that CPS utilizes deployed using ONAP common charts
353
354Below service components (mS) are available to be deployed on-demand.
355
356Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
357
358Known Limitations, Issues and Workarounds
359-----------------------------------------
360
361*System Limitations*
362
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]363None
364
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]365*Known Vulnerabilities*
366
367 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
368 - `CPS-659 <https://jira.onap.org/browse/CPS-659>`_ DMI does not set CREATE Response code for passthrough-running create use-case
369
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]370*Workarounds*
371
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]372None
373
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]374Security Notes
375--------------
376
377*Fixed Security Issues*
378
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]379None
380
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]381*Known Security Issues*
382
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]383None
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]384
385References
386----------
387
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]388For more information on the latest ONAP release, please see:
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]389
390#. `ONAP Home Page`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]391#. `ONAP Wiki Page`_
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]392#. `ONAP Documentation`_
393#. `ONAP DMI Plugin Documentation`_
394#. `ONAP Release Downloads`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]395
396
397.. _`ONAP Home Page`: https://www.onap.org
398.. _`ONAP Wiki Page`: https://wiki.onap.org
399.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelink3a7c3752023-06-22 10:16:06 +0100[diff] [blame]400.. _`ONAP DMI Plugin Documentation`: https://docs.onap.org/projects/onap-cps-ncmp-dmi-plugin
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]401.. _`ONAP Release Downloads`: https://git.onap.org
402
403Quick Links:
404
DylanB95ESTb1556c02021-10-11 13:39:21 +0100[diff] [blame]405 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
shivasubedi3d1579c2021-09-13 16:43:20 +0100[diff] [blame]406 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_