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