blob: d080b037f15ca9eb47058e05990d526274b2e253 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
shivasubedi44beaa32021-09-13 15:16:30 +01003.. Copyright (C) 2021 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
8
9
10=================
11CPS Release Notes
12=================
13
14.. contents::
15 :depth: 2
16..
17
shivasubedi44beaa32021-09-13 15:16:30 +010018.. ========================
niamhcoref7b414e2021-11-17 11:02:07 +000019.. * * * JAKARTA * * *
20.. ========================
21
22Version: 2.1.0-SNAPSHOT
23=======================
24
25This section lists the main changes & fixes merged into master (snapshot) version of CPS-NCMP. This information is here to assist developers that want experiment/test using our latest code bases directly. Stability of this is not guaranteed.
26
27Features
28--------
puthuparambil.adityad0007332021-12-08 18:53:39 +000029 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +000030 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
31 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
32 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +000033 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +000034 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
niamhcoref7b414e2021-11-17 11:02:07 +000035
36Bug Fixes
37---------
38
39 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +000040 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +000041 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +000042 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
niamhcoref7b414e2021-11-17 11:02:07 +000043
44Known Limitations, Issues and Workarounds
45-----------------------------------------
46
47*System Limitations*
48
49None
50
51*Known Vulnerabilities*
52
53None
54
55*Workarounds*
56
57None
58
59Security Notes
60--------------
61
62*Fixed Security Issues*
63
64None
65
66*Known Security Issues*
67
68None
69
70.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +010071.. * * * ISTANBUL * * *
72.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +000073
lukegleeson9c583712021-09-30 17:21:11 +010074Version: 2.0.1
75==============
76
77Release Data
78------------
79
80+--------------------------------------+--------------------------------------------------------+
81| **CPS Project** | |
82| | |
83+--------------------------------------+--------------------------------------------------------+
84| **Docker images** | onap/cps-and-ncmp:2.0.1 |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Release designation** | 2.0.1 Istanbul |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release date** | 2021-14-10 |
91| | |
92+--------------------------------------+--------------------------------------------------------+
93
94Bug Fixes
95---------
96
97 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
98 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
99 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
100 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
101
102Known Limitations, Issues and Workarounds
103-----------------------------------------
104
105*System Limitations*
106
107Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
108
109*Known Vulnerabilities*
110
111 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
112
113*Workarounds*
114
115Add recursive method to save list node data to loop through all corresponding child nodes.
116
117Security Notes
118--------------
119
120*Fixed Security Issues*
121
122 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
123
124*Known Security Issues*
125
126None
127
shivasubedi44beaa32021-09-13 15:16:30 +0100128Version: 2.0.0
129==============
130
131Abstract
132--------
133
134This document provides the release notes for Istanbul release.
135
136Release Data
137------------
138
139+--------------------------------------+--------------------------------------------------------+
140| **CPS Project** | |
141| | |
142+--------------------------------------+--------------------------------------------------------+
143| **Docker images** | onap/cps-and-ncmp:2.0.0 |
144| | |
145+--------------------------------------+--------------------------------------------------------+
146| **Release designation** | 2.0.0 Istanbul |
147| | |
148+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100149| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100150| | |
151+--------------------------------------+--------------------------------------------------------+
152
153Features
154--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100155* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100156* Update, Create and Remove CM Handles.
157* Add support for retrieving and writing CM Handle data through NCMP datastores.
158* Automatic retrieval and caching of model information for CM Handles within NCMP.
159
shivasubedi44beaa32021-09-13 15:16:30 +0100160Deliverables
161------------
162
163Software Deliverables
164
165.. csv-table::
166 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
167 :widths: auto
168
169 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
170
171Bug Fixes
172---------
173
lukegleeson9c583712021-09-30 17:21:11 +0100174 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100175 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
176 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +0100177 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
178 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +0100179 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +0100180 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +0100181 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
182 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100183 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
184 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
185 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +0100186 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
187 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +0100188 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100189 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +0100190 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
191 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
192 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100193 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
194 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
195 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
196 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
197 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
198 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
199 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100200
201This document provides the release notes for Istanbul release.
202
203Summary
204-------
205
206Following CPS components are available with default ONAP/CPS installation.
207
208
209 * Platform components
210
211 - CPS (Helm charts)
212
213 * Service components
214
DylanB95EST3fcf8692021-10-11 16:29:16 +0100215 - CPS-NCMP
216 - CPS-Temporal
217 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100218
219 * Additional resources that CPS utilizes deployed using ONAP common charts
220
221 - Postgres Database
222
223
224Below service components (mS) are available to be deployed on-demand.
225 - CPS-TBDMT
226
227
228Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
229
230Known Limitations, Issues and Workarounds
231-----------------------------------------
232
shivasubedi44beaa32021-09-13 15:16:30 +0100233*System Limitations*
234
235Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
236
237*Known Vulnerabilities*
238
lukegleeson9c583712021-09-30 17:21:11 +0100239 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
240 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
241 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100242
243*Workarounds*
244
245Add recursive method to save list node data to loop through all corresponding child nodes.
246
247Security Notes
248--------------
249
250*Fixed Security Issues*
251
252 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100253
254*Known Security Issues*
255
lukegleeson9c583712021-09-30 17:21:11 +0100256 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
257
shivasubedi44beaa32021-09-13 15:16:30 +0100258Test Results
259------------
260 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000261
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100262.. ========================
263.. * * * HONOLULU * * *
264.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000265
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100266Version: 1.0.1
267==============
268
269Release Data
270------------
271
272+--------------------------------------+--------------------------------------------------------+
273| **CPS Project** | |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
277| | |
278+--------------------------------------+--------------------------------------------------------+
279| **Release designation** | 1.0.1 Honolulu |
280| | |
281+--------------------------------------+--------------------------------------------------------+
282| **Release date** | 2021-04-09 |
283| | |
284+--------------------------------------+--------------------------------------------------------+
285
286Bug Fixes
287---------
288
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100289 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100290 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
291 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
292 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
293 - `CPS-292 <https://jira.onap.org/browse/CPS-292>`_ Detailed information is missing to explain why data is not compliant with the specified YANG model
294 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
295 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
296 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
297
298Security Notes
299--------------
300
301*Fixed Security Issues*
302
303 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000304
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100305*Known Security Issues*
306
307 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
308
Rishi.Chail4359d282021-03-03 16:36:26 +0000309Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000310==============
311
312
313Abstract
314--------
315
316This document provides the release notes for Honolulu release.
317
318Summary
319-------
320
321Following CPS components are available with default ONAP/CPS installation.
322
323
Rishi.Chail4359d282021-03-03 16:36:26 +0000324 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000325
Rishi.Chail4359d282021-03-03 16:36:26 +0000326 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000327
Rishi.Chail4359d282021-03-03 16:36:26 +0000328 * Service components
329
330 - CPS Core
331
332 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000333
334 - Postgres Database
335
336
Rishi.Chail4359d282021-03-03 16:36:26 +0000337Below service components (mS) are available to be deployed on-demand.
338 - CPS-TBDMT
339
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000340
341Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
342
343
344Release Data
345------------
346
347+--------------------------------------+--------------------------------------------------------+
348| **CPS Project** | |
349| | |
350+--------------------------------------+--------------------------------------------------------+
351| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
352| | |
353+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000354| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000355| | |
356+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000357| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000358| | |
359+--------------------------------------+--------------------------------------------------------+
360
361
362Features
363--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000364Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
365CPS has been driven by the needs of the E2E Networking Slicing use case.
366It currently supports basic (rw) persistence and simple queries.
367It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000368
369.. _honolulu_deliverable:
370
371Deliverables
372------------
373
374Software Deliverables
375
376.. csv-table::
377 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
378 :widths: auto
379
Rishi.Chail4359d282021-03-03 16:36:26 +0000380 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000381
382
383Known Limitations, Issues and Workarounds
384-----------------------------------------
385
Rishi.Chail4359d282021-03-03 16:36:26 +0000386 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
387 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
388 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100389 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000390
391*System Limitations*
392
393None
394
395*Known Vulnerabilities*
396
397None
398
399*Workarounds*
400
401Documented under corresponding jira if applicable.
402
403Security Notes
404--------------
405
406*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000407
408* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000409 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000410 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000411 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000412
413*Known Security Issues*
414
Rishi.Chail4359d282021-03-03 16:36:26 +0000415 * Weak Crytography using md5
416 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000417
418*Known Vulnerabilities in Used Modules*
419
Rishi.Chail4359d282021-03-03 16:36:26 +0000420 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000421
Rishi.Chail4359d282021-03-03 16:36:26 +0000422CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000423
424Test Results
425------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000426 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000427
428References
429----------
430
431For more information on the ONAP Honolulu release, please see:
432
433#. `ONAP Home Page`_
434#. `ONAP Documentation`_
435#. `ONAP Release Downloads`_
436#. `ONAP Wiki Page`_
437
438
439.. _`ONAP Home Page`: https://www.onap.org
440.. _`ONAP Wiki Page`: https://wiki.onap.org
441.. _`ONAP Documentation`: https://docs.onap.org
442.. _`ONAP Release Downloads`: https://git.onap.org
443
444Quick Links:
445
446 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
447 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_