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 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8
   9
  10 =================
  11 CPS Release Notes
  12 =================
  13
  14 .. warning:: draft
  15
  16 .. contents::
  17     :depth: 2
  18 ..
  19
  20 ..      ========================
  21 ..      * * *   ISTANBUL   * * *
  22 ..      ========================
  23
  24 Version: 2.0.0
  25 ==============
  26
  27 Abstract
  28 --------
  29
  30 This document provides the release notes for Istanbul release.
  31
  32 Release Data
  33 ------------
  34
  35 +--------------------------------------+--------------------------------------------------------+
  36 | **CPS Project**                      |                                                        |
  37 |                                      |                                                        |
  38 +--------------------------------------+--------------------------------------------------------+
  39 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
  40 |                                      |                                                        |
  41 +--------------------------------------+--------------------------------------------------------+
  42 | **Release designation**              | 2.0.0 Istanbul                                         |
  43 |                                      |                                                        |
  44 +--------------------------------------+--------------------------------------------------------+
  45 | **Release date**                     | 2021-14-10                                             |
  46 |                                      |                                                        |
  47 +--------------------------------------+--------------------------------------------------------+
  48
  49 Features
  50 --------
  51 * Register DMI Plugins with NCMP for CM Handle registrations.
  52 * Update, Create and Remove CM Handles.
  53 * Add support for retrieving and writing CM Handle data through NCMP datastores.
  54 * Automatic retrieval and caching of model information for CM Handles within NCMP.
  55
  56 .. _istanbul_deliverable:
  57
  58 Deliverables
  59 ------------
  60
  61 Software Deliverables
  62
  63 .. csv-table::
  64    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
  65    :widths: auto
  66
  67    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
  68
  69 Bug Fixes
  70 ---------
  71
  72    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
  73    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
  74    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
  75    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing, error details are not provided
  76    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
  77    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
  78    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
  79    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
  80    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
  81    - `CPS-504 <https://jira.onap.org/browse/CPS-504>`_ Checkstyle rules are not enforced for cps-ncmp-dmi-plugin
  82    - `CPS-515 <https://jira.onap.org/browse/CPS-515>`_ Maven build is not failing when test containers are not able to run
  83    - `CPS-520 <https://jira.onap.org/browse/CPS-520>`_ Fix docker profile in cps-temporal and cps-ncmp-dmi-plugin
  84    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
  85    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
  86    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
  87    - `CPS-586 <https://jira.onap.org/browse/CPS-586>`_ App username and password environment variables are missing from temporal docker compose
  88
  89 This document provides the release notes for Istanbul release.
  90
  91 Summary
  92 -------
  93
  94 Following CPS components are available with default ONAP/CPS installation.
  95
  96
  97     * Platform components
  98
  99         - CPS (Helm charts)
 100
 101     * Service components
 102
 103         - CPS Core and NCMP
 104         - CPS Temporal
 105         - DMI Plugin
 106
 107     * Additional resources that CPS utilizes deployed using ONAP common charts
 108
 109         - Postgres Database
 110
 111
 112 Below service components (mS) are available to be deployed on-demand.
 113     - CPS-TBDMT
 114
 115
 116 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 117
 118 Known Limitations, Issues and Workarounds
 119 -----------------------------------------
 120
 121    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
 122
 123 *System Limitations*
 124
 125 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 126
 127 *Known Vulnerabilities*
 128
 129 None
 130
 131 *Workarounds*
 132
 133 Add recursive method to save list node data to loop through all corresponding child nodes.
 134
 135 Security Notes
 136 --------------
 137
 138 *Fixed Security Issues*
 139
 140    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 141    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 142
 143 *Known Security Issues*
 144
 145 Test Results
 146 ------------
 147     * `Integration tests`
 148
 149 ..      ========================
 150 ..      * * *   HONOLULU   * * *
 151 ..      ========================
 152
 153 Version: 1.0.1
 154 ==============
 155
 156 Release Data
 157 ------------
 158
 159 +--------------------------------------+--------------------------------------------------------+
 160 | **CPS Project**                      |                                                        |
 161 |                                      |                                                        |
 162 +--------------------------------------+--------------------------------------------------------+
 163 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
 164 |                                      |                                                        |
 165 +--------------------------------------+--------------------------------------------------------+
 166 | **Release designation**              | 1.0.1 Honolulu                                         |
 167 |                                      |                                                        |
 168 +--------------------------------------+--------------------------------------------------------+
 169 | **Release date**                     | 2021-04-09                                             |
 170 |                                      |                                                        |
 171 +--------------------------------------+--------------------------------------------------------+
 172
 173 Bug Fixes
 174 ---------
 175
 176    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
 177    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
 178    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
 179    - `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
 180    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
 181    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
 182    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
 183
 184 Security Notes
 185 --------------
 186
 187 *Fixed Security Issues*
 188
 189    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 190
 191 *Known Security Issues*
 192
 193    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
 194
 195 Version: 1.0.0
 196 ==============
 197
 198
 199 Abstract
 200 --------
 201
 202 This document provides the release notes for Honolulu release.
 203
 204 Summary
 205 -------
 206
 207 Following CPS components are available with default ONAP/CPS installation.
 208
 209
 210     * Platform components
 211
 212         - CPS (Helm charts)
 213
 214     * Service components
 215
 216         - CPS Core
 217
 218     * Additional resources that CPS utilizes deployed using ONAP common charts
 219
 220         - Postgres Database
 221
 222
 223 Below service components (mS) are available to be deployed on-demand.
 224     - CPS-TBDMT
 225
 226
 227 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 228
 229
 230 Release Data
 231 ------------
 232
 233 +--------------------------------------+--------------------------------------------------------+
 234 | **CPS Project**                      |                                                        |
 235 |                                      |                                                        |
 236 +--------------------------------------+--------------------------------------------------------+
 237 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 238 |                                      |                                                        |
 239 +--------------------------------------+--------------------------------------------------------+
 240 | **Release designation**              | 1.0.0 Honolulu                                         |
 241 |                                      |                                                        |
 242 +--------------------------------------+--------------------------------------------------------+
 243 | **Release date**                     | 2021-03-11                                             |
 244 |                                      |                                                        |
 245 +--------------------------------------+--------------------------------------------------------+
 246
 247
 248 Features
 249 --------
 250 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
 251 CPS has been driven by the needs of the E2E Networking Slicing use case.
 252 It currently supports basic (rw) persistence and simple queries.
 253 It also provides MVP support for network data access using simulated data.
 254
 255 .. _honolulu_deliverable:
 256
 257 Deliverables
 258 ------------
 259
 260 Software Deliverables
 261
 262 .. csv-table::
 263    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 264    :widths: auto
 265
 266    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 267
 268
 269 Known Limitations, Issues and Workarounds
 270 -----------------------------------------
 271
 272    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 273    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 274    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 275    - `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.
 276
 277 *System Limitations*
 278
 279 None
 280
 281 *Known Vulnerabilities*
 282
 283 None
 284
 285 *Workarounds*
 286
 287 Documented under corresponding jira if applicable.
 288
 289 Security Notes
 290 --------------
 291
 292 *Fixed Security Issues*
 293
 294 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 295     - Upgrade org.onap.oparent to 3.2.0
 296     - Upgrade spring.boot to 2.3.8.RELEASE
 297     - Upgrade yangtools to 5.0.7
 298
 299 *Known Security Issues*
 300
 301     * Weak Crytography using md5
 302     * Risk seen in Zip file expansion
 303
 304 *Known Vulnerabilities in Used Modules*
 305
 306     None
 307
 308 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.
 309
 310 Test Results
 311 ------------
 312     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 313
 314 References
 315 ----------
 316
 317 For more information on the ONAP Honolulu release, please see:
 318
 319 #. `ONAP Home Page`_
 320 #. `ONAP Documentation`_
 321 #. `ONAP Release Downloads`_
 322 #. `ONAP Wiki Page`_
 323
 324
 325 .. _`ONAP Home Page`: https://www.onap.org
 326 .. _`ONAP Wiki Page`: https://wiki.onap.org
 327 .. _`ONAP Documentation`: https://docs.onap.org
 328 .. _`ONAP Release Downloads`: https://git.onap.org
 329
 330 Quick Links:
 331
 332         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 333         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_