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
   4 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   5 .. _release_notes:
   6
   7
   8
   9 =================
  10 CPS Release Notes
  11 =================
  12
  13 .. contents::
  14     :depth: 2
  15 ..
  16
  17
  18
  19 ..      =========================
  20 ..      * * *   HONOULULU   * * *
  21 ..      =========================
  22
  23 Version: 1.0.1
  24 ==============
  25
  26 Release Data
  27 ------------
  28
  29 +--------------------------------------+--------------------------------------------------------+
  30 | **CPS Project**                      |                                                        |
  31 |                                      |                                                        |
  32 +--------------------------------------+--------------------------------------------------------+
  33 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
  34 |                                      |                                                        |
  35 +--------------------------------------+--------------------------------------------------------+
  36 | **Release designation**              | 1.0.1 Honolulu                                         |
  37 |                                      |                                                        |
  38 +--------------------------------------+--------------------------------------------------------+
  39 | **Release date**                     | 2021-04-09                                             |
  40 |                                      |                                                        |
  41 +--------------------------------------+--------------------------------------------------------+
  42
  43 Bug Fixes
  44 ---------
  45
  46    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
  47    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
  48    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
  49    - `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
  50    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
  51    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
  52    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
  53
  54 Security Notes
  55 --------------
  56
  57 *Fixed Security Issues*
  58
  59    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
  60
  61 Version: 1.0.0
  62 ==============
  63
  64
  65 Abstract
  66 --------
  67
  68 This document provides the release notes for Honolulu release.
  69
  70 Summary
  71 -------
  72
  73 Following CPS components are available with default ONAP/CPS installation.
  74
  75
  76     * Platform components
  77
  78         - CPS (Helm charts)
  79
  80     * Service components
  81
  82         - CPS Core
  83
  84     * Additional resources that CPS utilizes deployed using ONAP common charts
  85
  86         - Postgres Database
  87
  88
  89 Below service components (mS) are available to be deployed on-demand.
  90     - CPS-TBDMT
  91
  92
  93 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
  94
  95
  96 Release Data
  97 ------------
  98
  99 +--------------------------------------+--------------------------------------------------------+
 100 | **CPS Project**                      |                                                        |
 101 |                                      |                                                        |
 102 +--------------------------------------+--------------------------------------------------------+
 103 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 104 |                                      |                                                        |
 105 +--------------------------------------+--------------------------------------------------------+
 106 | **Release designation**              | 1.0.0 Honolulu                                         |
 107 |                                      |                                                        |
 108 +--------------------------------------+--------------------------------------------------------+
 109 | **Release date**                     | 2021-03-11                                             |
 110 |                                      |                                                        |
 111 +--------------------------------------+--------------------------------------------------------+
 112
 113
 114 Features
 115 --------
 116 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
 117 CPS has been driven by the needs of the E2E Networking Slicing use case.
 118 It currently supports basic (rw) persistence and simple queries.
 119 It also provides MVP support for network data access using simulated data.
 120
 121 .. _honolulu_deliverable:
 122
 123 Deliverables
 124 ------------
 125
 126 Software Deliverables
 127
 128 .. csv-table::
 129    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 130    :widths: auto
 131
 132    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 133
 134
 135 Known Limitations, Issues and Workarounds
 136 -----------------------------------------
 137
 138    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 139    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 140    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 141
 142
 143 *System Limitations*
 144
 145 None
 146
 147 *Known Vulnerabilities*
 148
 149 None
 150
 151 *Workarounds*
 152
 153 Documented under corresponding jira if applicable.
 154
 155 Security Notes
 156 --------------
 157
 158 *Fixed Security Issues*
 159
 160 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 161     - Upgrade org.onap.oparent to 3.2.0
 162     - Upgrade spring.boot to 2.3.8.RELEASE
 163     - Upgrade yangtools to 5.0.7
 164
 165 *Known Security Issues*
 166
 167     * Weak Crytography using md5
 168     * Risk seen in Zip file expansion
 169
 170 *Known Vulnerabilities in Used Modules*
 171
 172     None
 173
 174 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.
 175
 176 Test Results
 177 ------------
 178     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 179
 180 References
 181 ----------
 182
 183 For more information on the ONAP Honolulu release, please see:
 184
 185 #. `ONAP Home Page`_
 186 #. `ONAP Documentation`_
 187 #. `ONAP Release Downloads`_
 188 #. `ONAP Wiki Page`_
 189
 190
 191 .. _`ONAP Home Page`: https://www.onap.org
 192 .. _`ONAP Wiki Page`: https://wiki.onap.org
 193 .. _`ONAP Documentation`: https://docs.onap.org
 194 .. _`ONAP Release Downloads`: https://git.onap.org
 195
 196 Quick Links:
 197
 198         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 199         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_