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