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