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