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