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