Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 3fcf869dd53f82349eee503582705b2407240f4f / . / docs / release-notes.rst
blob: 6e5d917ab453cf3cbe9501d99adfdb50cd1a8456 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. 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 +0100[diff] [blame]3.. Copyright (C) 2021 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[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=================
11CPS Release Notes
12=================
13
14.. contents::
15 :depth: 2
16..
17
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]18.. ========================
19.. * * * ISTANBUL * * *
20.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]21
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]22Version: 2.0.1
23==============
24
25Release Data
26------------
27
28+--------------------------------------+--------------------------------------------------------+
29| **CPS Project** | |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Docker images** | onap/cps-and-ncmp:2.0.1 |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release designation** | 2.0.1 Istanbul |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38| **Release date** | 2021-14-10 |
39| | |
40+--------------------------------------+--------------------------------------------------------+
41
42Bug Fixes
43---------
44
45 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
46 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
47 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
48 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
49
50Known Limitations, Issues and Workarounds
51-----------------------------------------
52
53*System Limitations*
54
55Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
56
57*Known Vulnerabilities*
58
59 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
60
61*Workarounds*
62
63Add recursive method to save list node data to loop through all corresponding child nodes.
64
65Security Notes
66--------------
67
68*Fixed Security Issues*
69
70 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
71
72*Known Security Issues*
73
74None
75
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]76Version: 2.0.0
77==============
78
79Abstract
80--------
81
82This document provides the release notes for Istanbul release.
83
84Release Data
85------------
86
87+--------------------------------------+--------------------------------------------------------+
88| **CPS Project** | |
89| | |
90+--------------------------------------+--------------------------------------------------------+
91| **Docker images** | onap/cps-and-ncmp:2.0.0 |
92| | |
93+--------------------------------------+--------------------------------------------------------+
94| **Release designation** | 2.0.0 Istanbul |
95| | |
96+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]97| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]98| | |
99+--------------------------------------+--------------------------------------------------------+
100
101Features
102--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame^]103* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]104* Update, Create and Remove CM Handles.
105* Add support for retrieving and writing CM Handle data through NCMP datastores.
106* Automatic retrieval and caching of model information for CM Handles within NCMP.
107
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]108Deliverables
109------------
110
111Software Deliverables
112
113.. csv-table::
114 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
115 :widths: auto
116
117 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
118
119Bug Fixes
120---------
121
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]122 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]123 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
124 - `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 +0100[diff] [blame]125 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
126 - `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 +0100[diff] [blame]127 - `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 +0100[diff] [blame]128 - `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 +0100[diff] [blame]129 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
130 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]131 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
132 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
133 - `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 +0100[diff] [blame]134 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
135 - `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 +0100[diff] [blame]136 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]137 - `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 +0100[diff] [blame]138 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
139 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
140 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]141 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
142 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
143 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
144 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
145 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
146 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
147 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]148
149This document provides the release notes for Istanbul release.
150
151Summary
152-------
153
154Following CPS components are available with default ONAP/CPS installation.
155
156
157 * Platform components
158
159 - CPS (Helm charts)
160
161 * Service components
162
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame^]163 - CPS-NCMP
164 - CPS-Temporal
165 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]166
167 * Additional resources that CPS utilizes deployed using ONAP common charts
168
169 - Postgres Database
170
171
172Below service components (mS) are available to be deployed on-demand.
173 - CPS-TBDMT
174
175
176Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
177
178Known Limitations, Issues and Workarounds
179-----------------------------------------
180
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]181*System Limitations*
182
183Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
184
185*Known Vulnerabilities*
186
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]187 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
188 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
189 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]190
191*Workarounds*
192
193Add recursive method to save list node data to loop through all corresponding child nodes.
194
195Security Notes
196--------------
197
198*Fixed Security Issues*
199
200 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]201
202*Known Security Issues*
203
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]204 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
205
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]206Test Results
207------------
208 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]209
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]210.. ========================
211.. * * * HONOLULU * * *
212.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]213
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]214Version: 1.0.1
215==============
216
217Release Data
218------------
219
220+--------------------------------------+--------------------------------------------------------+
221| **CPS Project** | |
222| | |
223+--------------------------------------+--------------------------------------------------------+
224| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
225| | |
226+--------------------------------------+--------------------------------------------------------+
227| **Release designation** | 1.0.1 Honolulu |
228| | |
229+--------------------------------------+--------------------------------------------------------+
230| **Release date** | 2021-04-09 |
231| | |
232+--------------------------------------+--------------------------------------------------------+
233
234Bug Fixes
235---------
236
237 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
238 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
239 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
240 - `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
241 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
242 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
243 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
244
245Security Notes
246--------------
247
248*Fixed Security Issues*
249
250 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]251
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]252*Known Security Issues*
253
254 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
255
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]256Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]257==============
258
259
260Abstract
261--------
262
263This document provides the release notes for Honolulu release.
264
265Summary
266-------
267
268Following CPS components are available with default ONAP/CPS installation.
269
270
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]271 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]272
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]273 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]274
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]275 * Service components
276
277 - CPS Core
278
279 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]280
281 - Postgres Database
282
283
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]284Below service components (mS) are available to be deployed on-demand.
285 - CPS-TBDMT
286
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]287
288Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
289
290
291Release Data
292------------
293
294+--------------------------------------+--------------------------------------------------------+
295| **CPS Project** | |
296| | |
297+--------------------------------------+--------------------------------------------------------+
298| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
299| | |
300+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]301| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]302| | |
303+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]304| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]305| | |
306+--------------------------------------+--------------------------------------------------------+
307
308
309Features
310--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]311Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
312CPS has been driven by the needs of the E2E Networking Slicing use case.
313It currently supports basic (rw) persistence and simple queries.
314It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]315
316.. _honolulu_deliverable:
317
318Deliverables
319------------
320
321Software Deliverables
322
323.. csv-table::
324 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
325 :widths: auto
326
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]327 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]328
329
330Known Limitations, Issues and Workarounds
331-----------------------------------------
332
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]333 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
334 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
335 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]336 - `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 +0000[diff] [blame]337
338*System Limitations*
339
340None
341
342*Known Vulnerabilities*
343
344None
345
346*Workarounds*
347
348Documented under corresponding jira if applicable.
349
350Security Notes
351--------------
352
353*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]354
355* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]356 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]357 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]358 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]359
360*Known Security Issues*
361
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]362 * Weak Crytography using md5
363 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]364
365*Known Vulnerabilities in Used Modules*
366
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]367 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]368
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]369CPS 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 +0000[diff] [blame]370
371Test Results
372------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]373 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]374
375References
376----------
377
378For more information on the ONAP Honolulu release, please see:
379
380#. `ONAP Home Page`_
381#. `ONAP Documentation`_
382#. `ONAP Release Downloads`_
383#. `ONAP Wiki Page`_
384
385
386.. _`ONAP Home Page`: https://www.onap.org
387.. _`ONAP Wiki Page`: https://wiki.onap.org
388.. _`ONAP Documentation`: https://docs.onap.org
389.. _`ONAP Release Downloads`: https://git.onap.org
390
391Quick Links:
392
393 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
394 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_