Update release docs
[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-2023 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 ..      * * *   MONTREAL   * * *
17 ..      ========================
18
19 Version: 3.3.1
20 ==============
21
22 Release Data
23 ------------
24
25 +--------------------------------------+--------------------------------------------------------+
26 | **CPS Project**                      |                                                        |
27 |                                      |                                                        |
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images**                    | onap/cps-and-ncmp:3.3.1                                |
30 |                                      |                                                        |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation**              | 3.3.1 Montreal                                         |
33 |                                      |                                                        |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date**                     | Not yet released                                       |
36 |                                      |                                                        |
37 +--------------------------------------+--------------------------------------------------------+
38
39 Bug Fixes
40 ---------
41 3.3.1
42     - None
43
44 Features
45 --------
46     - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
47     - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
48     - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
49     - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
50     - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
51
52 Version: 3.3.0
53 ==============
54
55 Release Data
56 ------------
57
58 +--------------------------------------+--------------------------------------------------------+
59 | **CPS Project**                      |                                                        |
60 |                                      |                                                        |
61 +--------------------------------------+--------------------------------------------------------+
62 | **Docker images**                    | onap/cps-and-ncmp:3.3.0                                |
63 |                                      |                                                        |
64 +--------------------------------------+--------------------------------------------------------+
65 | **Release designation**              | 3.3.0 Montreal                                         |
66 |                                      |                                                        |
67 +--------------------------------------+--------------------------------------------------------+
68 | **Release date**                     | 2023 April 20                                          |
69 |                                      |                                                        |
70 +--------------------------------------+--------------------------------------------------------+
71
72 Bug Fixes
73 ---------
74 3.3.0
75     - None
76
77 Features
78 --------
79     - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
80     - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
81
82 ..      ======================
83 ..      * * *   LONDON   * * *
84 ..      ======================
85
86 Version: 3.2.6
87 ==============
88
89 Release Data
90 ------------
91
92 +--------------------------------------+--------------------------------------------------------+
93 | **CPS Project**                      |                                                        |
94 |                                      |                                                        |
95 +--------------------------------------+--------------------------------------------------------+
96 | **Docker images**                    | onap/cps-and-ncmp:3.2.6                                |
97 |                                      |                                                        |
98 +--------------------------------------+--------------------------------------------------------+
99 | **Release designation**              | 3.2.6 London                                           |
100 |                                      |                                                        |
101 +--------------------------------------+--------------------------------------------------------+
102 | **Release date**                     | 2023 March 22                                          |
103 |                                      |                                                        |
104 +--------------------------------------+--------------------------------------------------------+
105
106 Bug Fixes
107 ---------
108 3.2.6
109     - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
110     - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
111
112 Features
113 --------
114     - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
115
116 Version: 3.2.5
117 ==============
118
119 Release Data
120 ------------
121
122 +--------------------------------------+--------------------------------------------------------+
123 | **CPS Project**                      |                                                        |
124 |                                      |                                                        |
125 +--------------------------------------+--------------------------------------------------------+
126 | **Docker images**                    | onap/cps-and-ncmp:3.2.5                                |
127 |                                      |                                                        |
128 +--------------------------------------+--------------------------------------------------------+
129 | **Release designation**              | 3.2.5 London                                           |
130 |                                      |                                                        |
131 +--------------------------------------+--------------------------------------------------------+
132 | **Release date**                     | 2023 March 10                                          |
133 |                                      |                                                        |
134 +--------------------------------------+--------------------------------------------------------+
135
136 Bug Fixes
137 ---------
138 3.2.5
139     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
140
141 Features
142 --------
143     - None
144
145 Version: 3.2.4
146 ==============
147
148 Release Data
149 ------------
150
151 +--------------------------------------+--------------------------------------------------------+
152 | **CPS Project**                      |                                                        |
153 |                                      |                                                        |
154 +--------------------------------------+--------------------------------------------------------+
155 | **Docker images**                    | onap/cps-and-ncmp:3.2.4                                |
156 |                                      |                                                        |
157 +--------------------------------------+--------------------------------------------------------+
158 | **Release designation**              | 3.2.4 London                                           |
159 |                                      |                                                        |
160 +--------------------------------------+--------------------------------------------------------+
161 | **Release date**                     | 2023 March 09                                          |
162 |                                      |                                                        |
163 +--------------------------------------+--------------------------------------------------------+
164
165 Bug Fixes
166 ---------
167 3.2.4
168     - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
169     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
170
171 Features
172 --------
173     - None
174
175 Version: 3.2.3
176 ==============
177
178 Release Data
179 ------------
180
181 +--------------------------------------+--------------------------------------------------------+
182 | **CPS Project**                      |                                                        |
183 |                                      |                                                        |
184 +--------------------------------------+--------------------------------------------------------+
185 | **Docker images**                    | onap/cps-and-ncmp:3.2.3                                |
186 |                                      |                                                        |
187 +--------------------------------------+--------------------------------------------------------+
188 | **Release designation**              | 3.2.3 London                                           |
189 |                                      |                                                        |
190 +--------------------------------------+--------------------------------------------------------+
191 | **Release date**                     | 2023 March 07                                          |
192 |                                      |                                                        |
193 +--------------------------------------+--------------------------------------------------------+
194
195 Bug Fixes
196 ---------
197 3.2.3
198    - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
199
200 Features
201 --------
202     - `CPS-1401 <https://jira.onap.org/browse/CPS-1401>`_ Added V2 of Get Data Node API,support to retrieve all data nodes under an anchor
203     - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
204
205 Version: 3.2.2
206 ==============
207
208 Release Data
209 ------------
210
211 +--------------------------------------+--------------------------------------------------------+
212 | **CPS Project**                      |                                                        |
213 |                                      |                                                        |
214 +--------------------------------------+--------------------------------------------------------+
215 | **Docker images**                    | onap/cps-and-ncmp:3.2.2                                |
216 |                                      |                                                        |
217 +--------------------------------------+--------------------------------------------------------+
218 | **Release designation**              | 3.2.2 London                                           |
219 |                                      |                                                        |
220 +--------------------------------------+--------------------------------------------------------+
221 | **Release date**                     | 2023 February 08                                       |
222 |                                      |                                                        |
223 +--------------------------------------+--------------------------------------------------------+
224
225 Bug Fixes
226 ---------
227 3.2.2
228    - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_  Delete Performance Improvements.
229
230 Features
231 --------
232    - None
233
234 Version: 3.2.1
235 ==============
236
237 Release Data
238 ------------
239
240 +--------------------------------------+--------------------------------------------------------+
241 | **CPS Project**                      |                                                        |
242 |                                      |                                                        |
243 +--------------------------------------+--------------------------------------------------------+
244 | **Docker images**                    | onap/cps-and-ncmp:3.2.1                                |
245 |                                      |                                                        |
246 +--------------------------------------+--------------------------------------------------------+
247 | **Release designation**              | 3.2.1 London                                           |
248 |                                      |                                                        |
249 +--------------------------------------+--------------------------------------------------------+
250 | **Release date**                     | 2023 January 27                                        |
251 |                                      |                                                        |
252 +--------------------------------------+--------------------------------------------------------+
253
254 Features
255 --------
256 3.2.1
257    - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_  Added support for multiple data tree instances under 1 anchor.
258    - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_  Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
259    - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_  Upgrade Opendaylight
260    - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_  Get all dataspaces.
261    - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_  Get single dataspace.
262    - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_  Added API to get all schema sets for a given dataspace.
263    - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_  DMI audit support for NCMP: Filter on any properties of CM Handles
264    - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_  Added support for application/xml Content-Type (write only).
265    - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_  Query large outputs using limit/depth/pagination
266    - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_  Optimized query for large number of hits with descendants.
267    - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_  Fetch CM handles by collection of xpaths (CPS Core)
268    - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_  Updating CmHandleStates using batch operation
269    - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_  Use native query to delete data nodes
270
271 Bug Fixes
272 ---------
273 3.2.1
274    - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_  Optimized retrieval of data nodes with many descendants.
275    - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_  Hazelcast TTL for IMap is not working
276    - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_  Getting wrong error code for create node api
277    - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_  Creation of DataNodeBuilder with module name prefix is very slow
278    - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_  Top level container (prefix) is not always the first module
279    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  Add Basic Auth to CPS/NCMP OpenAPI Definitions.
280    - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_  Handle YangChoiceNode in right format.
281    - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_  Fix Delete uses case with '/' in path.
282    - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_  Fix to allow posting data with '/' key fields.
283    - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_  CPS PATCH operation does not merge existing data
284    - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_  Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
285    - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_  CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
286    - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_  CpsDataPersistenceService#getDataNodes does not handle root xpath
287    - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_  CPS Path Processing Performance Test duration is too low
288
289 3.2.0
290    - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_  CPS(/NCMP) does not have version control.
291
292 Known Limitations, Issues and Workarounds
293 -----------------------------------------
294
295 *System Limitations*
296
297 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
298 This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
299
300 CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
301 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
302
303 ..      ====================
304 ..      * * *   KOHN   * * *
305 ..      ====================
306
307 Version: 3.1.4
308 ==============
309
310 Release Data
311 ------------
312
313 +--------------------------------------+--------------------------------------------------------+
314 | **CPS Project**                      |                                                        |
315 |                                      |                                                        |
316 +--------------------------------------+--------------------------------------------------------+
317 | **Docker images**                    | onap/cps-and-ncmp:3.1.4                                |
318 |                                      |                                                        |
319 +--------------------------------------+--------------------------------------------------------+
320 | **Release designation**              | 3.1.4 Kohn                                             |
321 |                                      |                                                        |
322 +--------------------------------------+--------------------------------------------------------+
323 | **Release date**                     | 2022 October 5                                         |
324 |                                      |                                                        |
325 +--------------------------------------+--------------------------------------------------------+
326
327 Bug Fixes
328 ---------
329    - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_  Revision field should not be required (NotNull) on cps-ri YangResourceEntity
330    - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_  Kafka communication fault caused cmHandle registration error
331
332 Version: 3.1.3
333 ==============
334
335 Release Data
336 ------------
337
338 +--------------------------------------+--------------------------------------------------------+
339 | **CPS Project**                      |                                                        |
340 |                                      |                                                        |
341 +--------------------------------------+--------------------------------------------------------+
342 | **Docker images**                    | onap/cps-and-ncmp:3.1.3                                |
343 |                                      |                                                        |
344 +--------------------------------------+--------------------------------------------------------+
345 | **Release designation**              | 3.1.3 Kohn                                             |
346 |                                      |                                                        |
347 +--------------------------------------+--------------------------------------------------------+
348 | **Release date**                     | 2022 September 29                                      |
349 |                                      |                                                        |
350 +--------------------------------------+--------------------------------------------------------+
351
352 Bug Fixes
353 ---------
354    - None
355
356 Version: 3.1.2
357 ==============
358
359 Release Data
360 ------------
361
362 +--------------------------------------+--------------------------------------------------------+
363 | **CPS Project**                      |                                                        |
364 |                                      |                                                        |
365 +--------------------------------------+--------------------------------------------------------+
366 | **Docker images**                    | onap/cps-and-ncmp:3.1.2                                |
367 |                                      |                                                        |
368 +--------------------------------------+--------------------------------------------------------+
369 | **Release designation**              | 3.1.2 Kohn                                             |
370 |                                      |                                                        |
371 +--------------------------------------+--------------------------------------------------------+
372 | **Release date**                     | 2022 September 28                                      |
373 |                                      |                                                        |
374 +--------------------------------------+--------------------------------------------------------+
375
376 Bug Fixes
377 ---------
378    - None
379
380 Version: 3.1.1
381 ==============
382
383 Release Data
384 ------------
385
386 +--------------------------------------+--------------------------------------------------------+
387 | **CPS Project**                      |                                                        |
388 |                                      |                                                        |
389 +--------------------------------------+--------------------------------------------------------+
390 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
391 |                                      |                                                        |
392 +--------------------------------------+--------------------------------------------------------+
393 | **Release designation**              | 3.1.1 Kohn                                             |
394 |                                      |                                                        |
395 +--------------------------------------+--------------------------------------------------------+
396 | **Release date**                     | 2022 September 28                                      |
397 |                                      |                                                        |
398 +--------------------------------------+--------------------------------------------------------+
399
400 Bug Fixes
401 ---------
402    - None
403
404 Security Notes
405 --------------
406
407 *Fixed Security Issues*
408
409    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
410
411 Version: 3.1.0
412 ==============
413
414 Release Data
415 ------------
416
417 +--------------------------------------+--------------------------------------------------------+
418 | **CPS Project**                      |                                                        |
419 |                                      |                                                        |
420 +--------------------------------------+--------------------------------------------------------+
421 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
422 |                                      |                                                        |
423 +--------------------------------------+--------------------------------------------------------+
424 | **Release designation**              | 3.1.0 Kohn                                             |
425 |                                      |                                                        |
426 +--------------------------------------+--------------------------------------------------------+
427 | **Release date**                     | 2022 September 14                                      |
428 |                                      |                                                        |
429 +--------------------------------------+--------------------------------------------------------+
430
431 Features
432 --------
433    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
434    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
435    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
436    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
437    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
438    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
439    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
440    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
441    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
442    - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_  CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
443    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
444    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
445    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
446    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
447    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
448    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
449    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
450    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
451    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
452    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
453    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
454    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
455    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
456    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
457
458
459 Bug Fixes
460 ---------
461    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
462    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
463    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
464    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
465    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMi Handles registered
466    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
467    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
468    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
469    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
470    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
471    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
472    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
473    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
474    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
475
476 Known Limitations, Issues and Workarounds
477 -----------------------------------------
478
479 *System Limitations*
480
481 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
482 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
483
484 *Known Vulnerabilities*
485
486 None
487
488 *Workarounds*
489
490 None
491
492 Security Notes
493 --------------
494
495 *Fixed Security Issues*
496
497    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
498
499 *Known Security Issues*
500
501 None
502
503 ..      ========================
504 ..      * * *   JAKARTA   * * *
505 ..      ========================
506
507 Version: 3.0.1
508 ==============
509
510 Release Data
511 ------------
512
513 +--------------------------------------+--------------------------------------------------------+
514 | **CPS Project**                      |                                                        |
515 |                                      |                                                        |
516 +--------------------------------------+--------------------------------------------------------+
517 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
518 |                                      |                                                        |
519 +--------------------------------------+--------------------------------------------------------+
520 | **Release designation**              | 3.0.1 Jakarta                                          |
521 |                                      |                                                        |
522 +--------------------------------------+--------------------------------------------------------+
523 | **Release date**                     | 2022 April 28                                          |
524 |                                      |                                                        |
525 +--------------------------------------+--------------------------------------------------------+
526
527 Bug Fixes
528 ---------
529    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
530
531 Version: 3.0.0
532 ==============
533
534 Release Data
535 ------------
536
537 +--------------------------------------+--------------------------------------------------------+
538 | **CPS Project**                      |                                                        |
539 |                                      |                                                        |
540 +--------------------------------------+--------------------------------------------------------+
541 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
542 |                                      |                                                        |
543 +--------------------------------------+--------------------------------------------------------+
544 | **Release designation**              | 3.0.0 Jakarta                                          |
545 |                                      |                                                        |
546 +--------------------------------------+--------------------------------------------------------+
547 | **Release date**                     | 2022 March 15                                          |
548 |                                      |                                                        |
549 +--------------------------------------+--------------------------------------------------------+
550
551 Features
552 --------
553    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
554    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
555    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
556    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
557    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
558    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
559    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
560    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
561    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
562    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
563    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
564
565 Bug Fixes
566 ---------
567
568    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
569    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
570    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
571    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
572    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
573    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
574    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
575    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
576    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
577    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
578
579 Known Limitations, Issues and Workarounds
580 -----------------------------------------
581
582 *System Limitations*
583
584 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
585 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
586 of cm handle registration.
587
588 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
589 for more information.
590
591 *Known Vulnerabilities*
592
593 None
594
595 *Workarounds*
596
597 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
598 pass an empty string as the value if you do not want to include names for these values.
599
600 Security Notes
601 --------------
602
603 *Fixed Security Issues*
604
605 None
606
607 *Known Security Issues*
608
609 None
610
611 ..      ========================
612 ..      * * *   ISTANBUL   * * *
613 ..      ========================
614
615 Version: 2.0.4
616 ==============
617
618 Release Data
619 ------------
620
621 +--------------------------------------+--------------------------------------------------------+
622 | **CPS Project**                      |                                                        |
623 |                                      |                                                        |
624 +--------------------------------------+--------------------------------------------------------+
625 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
626 |                                      |                                                        |
627 +--------------------------------------+--------------------------------------------------------+
628 | **Release designation**              | 2.0.4 Istanbul                                         |
629 |                                      |                                                        |
630 +--------------------------------------+--------------------------------------------------------+
631 | **Release date**                     | 2022 Feb 09                                            |
632 |                                      |                                                        |
633 +--------------------------------------+--------------------------------------------------------+
634
635 Bug Fixes
636 ---------
637
638    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
639    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
640
641 Version: 2.0.3
642 ==============
643
644 Release Data
645 ------------
646
647 +--------------------------------------+--------------------------------------------------------+
648 | **CPS Project**                      |                                                        |
649 |                                      |                                                        |
650 +--------------------------------------+--------------------------------------------------------+
651 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
652 |                                      |                                                        |
653 +--------------------------------------+--------------------------------------------------------+
654 | **Release designation**              | 2.0.3 Istanbul                                         |
655 |                                      |                                                        |
656 +--------------------------------------+--------------------------------------------------------+
657 | **Release date**                     | 2022-07-01                                             |
658 |                                      |                                                        |
659 +--------------------------------------+--------------------------------------------------------+
660
661 Bug Fixes
662 ---------
663
664    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
665
666 Version: 2.0.2
667 ==============
668
669 Release Data
670 ------------
671
672 +--------------------------------------+--------------------------------------------------------+
673 | **CPS Project**                      |                                                        |
674 |                                      |                                                        |
675 +--------------------------------------+--------------------------------------------------------+
676 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
677 |                                      |                                                        |
678 +--------------------------------------+--------------------------------------------------------+
679 | **Release designation**              | 2.0.2 Istanbul                                         |
680 |                                      |                                                        |
681 +--------------------------------------+--------------------------------------------------------+
682 | **Release date**                     | 2021-16-12                                             |
683 |                                      |                                                        |
684 +--------------------------------------+--------------------------------------------------------+
685
686 Bug Fixes
687 ---------
688
689    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
690
691 Version: 2.0.1
692 ==============
693
694 Release Data
695 ------------
696
697 +--------------------------------------+--------------------------------------------------------+
698 | **CPS Project**                      |                                                        |
699 |                                      |                                                        |
700 +--------------------------------------+--------------------------------------------------------+
701 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
702 |                                      |                                                        |
703 +--------------------------------------+--------------------------------------------------------+
704 | **Release designation**              | 2.0.1 Istanbul                                         |
705 |                                      |                                                        |
706 +--------------------------------------+--------------------------------------------------------+
707 | **Release date**                     | 2021-14-10                                             |
708 |                                      |                                                        |
709 +--------------------------------------+--------------------------------------------------------+
710
711 Bug Fixes
712 ---------
713
714    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
715    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
716    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
717    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
718
719 Known Limitations, Issues and Workarounds
720 -----------------------------------------
721
722 *System Limitations*
723
724 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
725
726 *Known Vulnerabilities*
727
728    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
729
730 *Workarounds*
731
732 Add recursive method to save list node data to loop through all corresponding child nodes.
733
734 Security Notes
735 --------------
736
737 *Fixed Security Issues*
738
739    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
740
741 *Known Security Issues*
742
743 None
744
745 Version: 2.0.0
746 ==============
747
748 Abstract
749 --------
750
751 This document provides the release notes for Istanbul release.
752
753 Release Data
754 ------------
755
756 +--------------------------------------+--------------------------------------------------------+
757 | **CPS Project**                      |                                                        |
758 |                                      |                                                        |
759 +--------------------------------------+--------------------------------------------------------+
760 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
761 |                                      |                                                        |
762 +--------------------------------------+--------------------------------------------------------+
763 | **Release designation**              | 2.0.0 Istanbul                                         |
764 |                                      |                                                        |
765 +--------------------------------------+--------------------------------------------------------+
766 | **Release date**                     | 2021-14-09                                             |
767 |                                      |                                                        |
768 +--------------------------------------+--------------------------------------------------------+
769
770 Features
771 --------
772 * Register DMI-Plugins with NCMP for CM Handle registrations.
773 * Update, Create and Remove CM Handles.
774 * Add support for retrieving and writing CM Handle data through NCMP datastores.
775 * Automatic retrieval and caching of model information for CM Handles within NCMP.
776
777 Deliverables
778 ------------
779
780 Software Deliverables
781
782 .. csv-table::
783    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
784    :widths: auto
785
786    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
787
788 Bug Fixes
789 ---------
790
791    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
792    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
793    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
794    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
795    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
796    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
797    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
798    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
799    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
800    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
801    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
802    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
803    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
804    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
805    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
806    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
807    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
808    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
809    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
810    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
811    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
812    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
813    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
814    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
815    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
816    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
817
818 This document provides the release notes for Istanbul release.
819
820 Summary
821 -------
822
823 Following CPS components are available with default ONAP/CPS installation.
824
825
826     * Platform components
827
828         - CPS (Helm charts)
829
830     * Service components
831
832         - CPS-NCMP
833         - CPS-Temporal
834         - DMI-Plugin
835
836     * Additional resources that CPS utilizes deployed using ONAP common charts
837
838         - Postgres Database
839
840
841 Below service components (mS) are available to be deployed on-demand.
842     - CPS-TBDMT
843
844
845 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
846
847 Known Limitations, Issues and Workarounds
848 -----------------------------------------
849
850 *System Limitations*
851
852 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
853
854 *Known Vulnerabilities*
855
856    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
857    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
858    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
859
860 *Workarounds*
861
862 Add recursive method to save list node data to loop through all corresponding child nodes.
863
864 Security Notes
865 --------------
866
867 *Fixed Security Issues*
868
869    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
870
871 *Known Security Issues*
872
873    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
874
875 Test Results
876 ------------
877     * `Integration tests`
878
879 ..      ========================
880 ..      * * *   HONOLULU   * * *
881 ..      ========================
882
883 Version: 1.0.1
884 ==============
885
886 Release Data
887 ------------
888
889 +--------------------------------------+--------------------------------------------------------+
890 | **CPS Project**                      |                                                        |
891 |                                      |                                                        |
892 +--------------------------------------+--------------------------------------------------------+
893 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
894 |                                      |                                                        |
895 +--------------------------------------+--------------------------------------------------------+
896 | **Release designation**              | 1.0.1 Honolulu                                         |
897 |                                      |                                                        |
898 +--------------------------------------+--------------------------------------------------------+
899 | **Release date**                     | 2021-04-09                                             |
900 |                                      |                                                        |
901 +--------------------------------------+--------------------------------------------------------+
902
903 Bug Fixes
904 ---------
905
906    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
907    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
908    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
909    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
910    - `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
911    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
912    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
913    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
914
915 Security Notes
916 --------------
917
918 *Fixed Security Issues*
919
920    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
921
922 *Known Security Issues*
923
924    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
925
926 Version: 1.0.0
927 ==============
928
929
930 Abstract
931 --------
932
933 This document provides the release notes for Honolulu release.
934
935 Summary
936 -------
937
938 Following CPS components are available with default ONAP/CPS installation.
939
940
941     * Platform components
942
943         - CPS (Helm charts)
944
945     * Service components
946
947         - CPS Core
948
949     * Additional resources that CPS utilizes deployed using ONAP common charts
950
951         - Postgres Database
952
953
954 Below service components (mS) are available to be deployed on-demand.
955     - CPS-TBDMT
956
957
958 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
959
960
961 Release Data
962 ------------
963
964 +--------------------------------------+--------------------------------------------------------+
965 | **CPS Project**                      |                                                        |
966 |                                      |                                                        |
967 +--------------------------------------+--------------------------------------------------------+
968 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
969 |                                      |                                                        |
970 +--------------------------------------+--------------------------------------------------------+
971 | **Release designation**              | 1.0.0 Honolulu                                         |
972 |                                      |                                                        |
973 +--------------------------------------+--------------------------------------------------------+
974 | **Release date**                     | 2021-03-11                                             |
975 |                                      |                                                        |
976 +--------------------------------------+--------------------------------------------------------+
977
978
979 Features
980 --------
981 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
982 CPS has been driven by the needs of the E2E Networking Slicing use case.
983 It currently supports basic (rw) persistence and simple queries.
984 It also provides MVP support for network data access using simulated data.
985
986 .. _honolulu_deliverable:
987
988 Deliverables
989 ------------
990
991 Software Deliverables
992
993 .. csv-table::
994    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
995    :widths: auto
996
997    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
998
999
1000 Known Limitations, Issues and Workarounds
1001 -----------------------------------------
1002
1003    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1004    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1005    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1006    - `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.
1007
1008 *System Limitations*
1009
1010 None
1011
1012 *Known Vulnerabilities*
1013
1014 None
1015
1016 *Workarounds*
1017
1018 Documented under corresponding jira if applicable.
1019
1020 Security Notes
1021 --------------
1022
1023 *Fixed Security Issues*
1024
1025 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1026     - Upgrade org.onap.oparent to 3.2.0
1027     - Upgrade spring.boot to 2.3.8.RELEASE
1028     - Upgrade yangtools to 5.0.7
1029
1030 *Known Security Issues*
1031
1032     * Weak Crytography using md5
1033     * Risk seen in Zip file expansion
1034
1035 *Known Vulnerabilities in Used Modules*
1036
1037     None
1038
1039 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.
1040
1041 Test Results
1042 ------------
1043     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1044
1045 References
1046 ----------
1047
1048 For more information on the ONAP Honolulu release, please see:
1049
1050 #. `ONAP Home Page`_
1051 #. `ONAP Documentation`_
1052 #. `ONAP Release Downloads`_
1053 #. `ONAP Wiki Page`_
1054
1055
1056 .. _`ONAP Home Page`: https://www.onap.org
1057 .. _`ONAP Wiki Page`: https://wiki.onap.org
1058 .. _`ONAP Documentation`: https://docs.onap.org
1059 .. _`ONAP Release Downloads`: https://git.onap.org
1060
1061 Quick Links:
1062
1063         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1064         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_