Refactoring/ Adding Tests for Validation
[cps.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021-2022 Nordix Foundation
4
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6 .. _release_notes:
7
8 CPS Release Notes
9 #################
10
11 .. contents::
12     :depth: 2
13 ..
14
15 ..      ========================
16 ..      * * *   JAKARTA   * * *
17 ..      ========================
18
19 Version: 3.1.0
20 ==============
21 +--------------------------------------+--------------------------------------------------------+
22 | **CPS Project**                      |                                                        |
23 |                                      |                                                        |
24 +--------------------------------------+--------------------------------------------------------+
25 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
26 |                                      |                                                        |
27 +--------------------------------------+--------------------------------------------------------+
28 | **Release designation**              | 3.1.0 Jakarta                                          |
29 |                                      |                                                        |
30 +--------------------------------------+--------------------------------------------------------+
31 | **Release date**                     |                                                        |
32 |                                      |                                                        |
33 +--------------------------------------+--------------------------------------------------------+
34
35 Features
36 --------
37    - `CPS-322 <https://jira.onap.org/browse/CPS-322>`_  Implement additional validation for names and identifiers
38
39 Version: 3.0.0
40 ==============
41
42 Release Data
43 ------------
44
45 +--------------------------------------+--------------------------------------------------------+
46 | **CPS Project**                      |                                                        |
47 |                                      |                                                        |
48 +--------------------------------------+--------------------------------------------------------+
49 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
50 |                                      |                                                        |
51 +--------------------------------------+--------------------------------------------------------+
52 | **Release designation**              | 3.0.0 Jakarta                                          |
53 |                                      |                                                        |
54 +--------------------------------------+--------------------------------------------------------+
55 | **Release date**                     | 2022 March 15                                          |
56 |                                      |                                                        |
57 +--------------------------------------+--------------------------------------------------------+
58
59 Features
60 --------
61    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
62    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
63    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
64    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
65    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
66    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
67    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
68    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
69    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
70    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
71    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
72
73 Bug Fixes
74 ---------
75
76    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
77    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
78    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
79    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
80    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
81    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
82    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
83    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
84    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
85    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
86
87 Known Limitations, Issues and Workarounds
88 -----------------------------------------
89
90 *System Limitations*
91
92 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
93 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
94 of cm handle registration.
95
96 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
97 for more information.
98
99 *Known Vulnerabilities*
100
101 None
102
103 *Workarounds*
104
105 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
106 pass an empty string as the value if you do not want to include names for these values.
107
108 Security Notes
109 --------------
110
111 *Fixed Security Issues*
112
113 None
114
115 *Known Security Issues*
116
117 None
118
119 ..      ========================
120 ..      * * *   ISTANBUL   * * *
121 ..      ========================
122
123 Version: 2.0.4
124 ==============
125
126 Release Data
127 ------------
128
129 +--------------------------------------+--------------------------------------------------------+
130 | **CPS Project**                      |                                                        |
131 |                                      |                                                        |
132 +--------------------------------------+--------------------------------------------------------+
133 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
134 |                                      |                                                        |
135 +--------------------------------------+--------------------------------------------------------+
136 | **Release designation**              | 2.0.4 Istanbul                                         |
137 |                                      |                                                        |
138 +--------------------------------------+--------------------------------------------------------+
139 | **Release date**                     | 2022 Feb 09                                            |
140 |                                      |                                                        |
141 +--------------------------------------+--------------------------------------------------------+
142
143 Bug Fixes
144 ---------
145
146    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
147    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
148
149 Version: 2.0.3
150 ==============
151
152 Release Data
153 ------------
154
155 +--------------------------------------+--------------------------------------------------------+
156 | **CPS Project**                      |                                                        |
157 |                                      |                                                        |
158 +--------------------------------------+--------------------------------------------------------+
159 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
160 |                                      |                                                        |
161 +--------------------------------------+--------------------------------------------------------+
162 | **Release designation**              | 2.0.3 Istanbul                                         |
163 |                                      |                                                        |
164 +--------------------------------------+--------------------------------------------------------+
165 | **Release date**                     | 2022-07-01                                             |
166 |                                      |                                                        |
167 +--------------------------------------+--------------------------------------------------------+
168
169 Bug Fixes
170 ---------
171
172    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
173
174 Version: 2.0.2
175 ==============
176
177 Release Data
178 ------------
179
180 +--------------------------------------+--------------------------------------------------------+
181 | **CPS Project**                      |                                                        |
182 |                                      |                                                        |
183 +--------------------------------------+--------------------------------------------------------+
184 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
185 |                                      |                                                        |
186 +--------------------------------------+--------------------------------------------------------+
187 | **Release designation**              | 2.0.2 Istanbul                                         |
188 |                                      |                                                        |
189 +--------------------------------------+--------------------------------------------------------+
190 | **Release date**                     | 2021-16-12                                             |
191 |                                      |                                                        |
192 +--------------------------------------+--------------------------------------------------------+
193
194 Bug Fixes
195 ---------
196
197    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
198
199 Version: 2.0.1
200 ==============
201
202 Release Data
203 ------------
204
205 +--------------------------------------+--------------------------------------------------------+
206 | **CPS Project**                      |                                                        |
207 |                                      |                                                        |
208 +--------------------------------------+--------------------------------------------------------+
209 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
210 |                                      |                                                        |
211 +--------------------------------------+--------------------------------------------------------+
212 | **Release designation**              | 2.0.1 Istanbul                                         |
213 |                                      |                                                        |
214 +--------------------------------------+--------------------------------------------------------+
215 | **Release date**                     | 2021-14-10                                             |
216 |                                      |                                                        |
217 +--------------------------------------+--------------------------------------------------------+
218
219 Bug Fixes
220 ---------
221
222    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
223    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
224    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
225    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
226
227 Known Limitations, Issues and Workarounds
228 -----------------------------------------
229
230 *System Limitations*
231
232 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
233
234 *Known Vulnerabilities*
235
236    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
237
238 *Workarounds*
239
240 Add recursive method to save list node data to loop through all corresponding child nodes.
241
242 Security Notes
243 --------------
244
245 *Fixed Security Issues*
246
247    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
248
249 *Known Security Issues*
250
251 None
252
253 Version: 2.0.0
254 ==============
255
256 Abstract
257 --------
258
259 This document provides the release notes for Istanbul release.
260
261 Release Data
262 ------------
263
264 +--------------------------------------+--------------------------------------------------------+
265 | **CPS Project**                      |                                                        |
266 |                                      |                                                        |
267 +--------------------------------------+--------------------------------------------------------+
268 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
269 |                                      |                                                        |
270 +--------------------------------------+--------------------------------------------------------+
271 | **Release designation**              | 2.0.0 Istanbul                                         |
272 |                                      |                                                        |
273 +--------------------------------------+--------------------------------------------------------+
274 | **Release date**                     | 2021-14-09                                             |
275 |                                      |                                                        |
276 +--------------------------------------+--------------------------------------------------------+
277
278 Features
279 --------
280 * Register DMI-Plugins with NCMP for CM Handle registrations.
281 * Update, Create and Remove CM Handles.
282 * Add support for retrieving and writing CM Handle data through NCMP datastores.
283 * Automatic retrieval and caching of model information for CM Handles within NCMP.
284
285 Deliverables
286 ------------
287
288 Software Deliverables
289
290 .. csv-table::
291    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
292    :widths: auto
293
294    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
295
296 Bug Fixes
297 ---------
298
299    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
300    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
301    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
302    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
303    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
304    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
305    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
306    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
307    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
308    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
309    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
310    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
311    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
312    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
313    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
314    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
315    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
316    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
317    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
318    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
319    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
320    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
321    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
322    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
323    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
324    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
325
326 This document provides the release notes for Istanbul release.
327
328 Summary
329 -------
330
331 Following CPS components are available with default ONAP/CPS installation.
332
333
334     * Platform components
335
336         - CPS (Helm charts)
337
338     * Service components
339
340         - CPS-NCMP
341         - CPS-Temporal
342         - DMI-Plugin
343
344     * Additional resources that CPS utilizes deployed using ONAP common charts
345
346         - Postgres Database
347
348
349 Below service components (mS) are available to be deployed on-demand.
350     - CPS-TBDMT
351
352
353 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
354
355 Known Limitations, Issues and Workarounds
356 -----------------------------------------
357
358 *System Limitations*
359
360 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
361
362 *Known Vulnerabilities*
363
364    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
365    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
366    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
367
368 *Workarounds*
369
370 Add recursive method to save list node data to loop through all corresponding child nodes.
371
372 Security Notes
373 --------------
374
375 *Fixed Security Issues*
376
377    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
378
379 *Known Security Issues*
380
381    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
382
383 Test Results
384 ------------
385     * `Integration tests`
386
387 ..      ========================
388 ..      * * *   HONOLULU   * * *
389 ..      ========================
390
391 Version: 1.0.1
392 ==============
393
394 Release Data
395 ------------
396
397 +--------------------------------------+--------------------------------------------------------+
398 | **CPS Project**                      |                                                        |
399 |                                      |                                                        |
400 +--------------------------------------+--------------------------------------------------------+
401 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
402 |                                      |                                                        |
403 +--------------------------------------+--------------------------------------------------------+
404 | **Release designation**              | 1.0.1 Honolulu                                         |
405 |                                      |                                                        |
406 +--------------------------------------+--------------------------------------------------------+
407 | **Release date**                     | 2021-04-09                                             |
408 |                                      |                                                        |
409 +--------------------------------------+--------------------------------------------------------+
410
411 Bug Fixes
412 ---------
413
414    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
415    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
416    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
417    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
418    - `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
419    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
420    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
421    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
422
423 Security Notes
424 --------------
425
426 *Fixed Security Issues*
427
428    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
429
430 *Known Security Issues*
431
432    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
433
434 Version: 1.0.0
435 ==============
436
437
438 Abstract
439 --------
440
441 This document provides the release notes for Honolulu release.
442
443 Summary
444 -------
445
446 Following CPS components are available with default ONAP/CPS installation.
447
448
449     * Platform components
450
451         - CPS (Helm charts)
452
453     * Service components
454
455         - CPS Core
456
457     * Additional resources that CPS utilizes deployed using ONAP common charts
458
459         - Postgres Database
460
461
462 Below service components (mS) are available to be deployed on-demand.
463     - CPS-TBDMT
464
465
466 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
467
468
469 Release Data
470 ------------
471
472 +--------------------------------------+--------------------------------------------------------+
473 | **CPS Project**                      |                                                        |
474 |                                      |                                                        |
475 +--------------------------------------+--------------------------------------------------------+
476 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
477 |                                      |                                                        |
478 +--------------------------------------+--------------------------------------------------------+
479 | **Release designation**              | 1.0.0 Honolulu                                         |
480 |                                      |                                                        |
481 +--------------------------------------+--------------------------------------------------------+
482 | **Release date**                     | 2021-03-11                                             |
483 |                                      |                                                        |
484 +--------------------------------------+--------------------------------------------------------+
485
486
487 Features
488 --------
489 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
490 CPS has been driven by the needs of the E2E Networking Slicing use case.
491 It currently supports basic (rw) persistence and simple queries.
492 It also provides MVP support for network data access using simulated data.
493
494 .. _honolulu_deliverable:
495
496 Deliverables
497 ------------
498
499 Software Deliverables
500
501 .. csv-table::
502    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
503    :widths: auto
504
505    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
506
507
508 Known Limitations, Issues and Workarounds
509 -----------------------------------------
510
511    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
512    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
513    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
514    - `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.
515
516 *System Limitations*
517
518 None
519
520 *Known Vulnerabilities*
521
522 None
523
524 *Workarounds*
525
526 Documented under corresponding jira if applicable.
527
528 Security Notes
529 --------------
530
531 *Fixed Security Issues*
532
533 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
534     - Upgrade org.onap.oparent to 3.2.0
535     - Upgrade spring.boot to 2.3.8.RELEASE
536     - Upgrade yangtools to 5.0.7
537
538 *Known Security Issues*
539
540     * Weak Crytography using md5
541     * Risk seen in Zip file expansion
542
543 *Known Vulnerabilities in Used Modules*
544
545     None
546
547 CPS 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.
548
549 Test Results
550 ------------
551     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
552
553 References
554 ----------
555
556 For more information on the ONAP Honolulu release, please see:
557
558 #. `ONAP Home Page`_
559 #. `ONAP Documentation`_
560 #. `ONAP Release Downloads`_
561 #. `ONAP Wiki Page`_
562
563
564 .. _`ONAP Home Page`: https://www.onap.org
565 .. _`ONAP Wiki Page`: https://wiki.onap.org
566 .. _`ONAP Documentation`: https://docs.onap.org
567 .. _`ONAP Release Downloads`: https://git.onap.org
568
569 Quick Links:
570
571         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
572         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_