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