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