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