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