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