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
  24 Version: 1.0.0
  25 ==============
  26
  27
  28 Abstract
  29 --------
  30
  31 This document provides the release notes for Honolulu release.
  32
  33 Summary
  34 -------
  35
  36 Following CPS components are available with default ONAP/CPS installation.
  37
  38
  39     * Platform components
  40
  41         - CPS (Helm charts)
  42
  43     * Service components
  44
  45         - CPS Core
  46
  47     * Additional resources that CPS utilizes deployed using ONAP common charts
  48
  49         - Postgres Database
  50
  51
  52 Below service components (mS) are available to be deployed on-demand.
  53     - CPS-TBDMT
  54
  55
  56 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
  57
  58
  59 Release Data
  60 ------------
  61
  62 +--------------------------------------+--------------------------------------------------------+
  63 | **CPS Project**                      |                                                        |
  64 |                                      |                                                        |
  65 +--------------------------------------+--------------------------------------------------------+
  66 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
  67 |                                      |                                                        |
  68 +--------------------------------------+--------------------------------------------------------+
  69 | **Release designation**              | 1.0.0 Honolulu                                         |
  70 |                                      |                                                        |
  71 +--------------------------------------+--------------------------------------------------------+
  72 | **Release date**                     | 2021-03-11                                             |
  73 |                                      |                                                        |
  74 +--------------------------------------+--------------------------------------------------------+
  75
  76
  77 Features
  78 --------
  79 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
  80 CPS has been driven by the needs of the E2E Networking Slicing use case.
  81 It currently supports basic (rw) persistence and simple queries.
  82 It also provides MVP support for network data access using simulated data.
  83
  84 .. _honolulu_deliverable:
  85
  86 Deliverables
  87 ------------
  88
  89 Software Deliverables
  90
  91 .. csv-table::
  92    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
  93    :widths: auto
  94
  95    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
  96
  97
  98 Known Limitations, Issues and Workarounds
  99 -----------------------------------------
 100
 101    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 102    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 103    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 104
 105
 106 *System Limitations*
 107
 108 None
 109
 110 *Known Vulnerabilities*
 111
 112 None
 113
 114 *Workarounds*
 115
 116 Documented under corresponding jira if applicable.
 117
 118 Security Notes
 119 --------------
 120
 121 *Fixed Security Issues*
 122
 123 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 124     - Upgrade org.onap.oparent to 3.2.0
 125     - Upgrade spring.boot to 2.3.8.RELEASE
 126     - Upgrade yangtools to 5.0.7
 127
 128 *Known Security Issues*
 129
 130     * Weak Crytography using md5
 131     * Risk seen in Zip file expansion
 132
 133 *Known Vulnerabilities in Used Modules*
 134
 135     None
 136
 137 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.
 138
 139 Test Results
 140 ------------
 141     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 142
 143 References
 144 ----------
 145
 146 For more information on the ONAP Honolulu release, please see:
 147
 148 #. `ONAP Home Page`_
 149 #. `ONAP Documentation`_
 150 #. `ONAP Release Downloads`_
 151 #. `ONAP Wiki Page`_
 152
 153
 154 .. _`ONAP Home Page`: https://www.onap.org
 155 .. _`ONAP Wiki Page`: https://wiki.onap.org
 156 .. _`ONAP Documentation`: https://docs.onap.org
 157 .. _`ONAP Release Downloads`: https://git.onap.org
 158
 159 Quick Links:
 160
 161         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 162         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_