docs/release-notes.rst

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