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