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