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