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