Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 689521eb9d1b07e62bc7fe6278ddb6c905e8aa38 / . / docs / release-notes.rst
blob: 971a60e4b4361b50c231d0136f3a8d2887579252 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]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=================
10CPS Release Notes
11=================
12
13.. contents::
14 :depth: 2
15..
16
17
18
19.. =========================
20.. * * * HONOULULU * * *
21.. =========================
22
23
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]24Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]25==============
26
27
28Abstract
29--------
30
31This document provides the release notes for Honolulu release.
32
33Summary
34-------
35
36Following CPS components are available with default ONAP/CPS installation.
37
38
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]39 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]40
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]41 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]42
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]43 * Service components
44
45 - CPS Core
46
47 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]48
49 - Postgres Database
50
51
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]52Below service components (mS) are available to be deployed on-demand.
53 - CPS-TBDMT
54
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]55
56Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
57
58
59Release Data
60------------
61
62+--------------------------------------+--------------------------------------------------------+
63| **CPS Project** | |
64| | |
65+--------------------------------------+--------------------------------------------------------+
66| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
67| | |
68+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]69| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]70| | |
71+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]72| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]73| | |
74+--------------------------------------+--------------------------------------------------------+
75
76
77Features
78--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]79Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
80CPS has been driven by the needs of the E2E Networking Slicing use case.
81It currently supports basic (rw) persistence and simple queries.
82It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]83
84.. _honolulu_deliverable:
85
86Deliverables
87------------
88
89Software Deliverables
90
91.. csv-table::
92 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
93 :widths: auto
94
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]95 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]96
97
98Known Limitations, Issues and Workarounds
99-----------------------------------------
100
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]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.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]104
105
106*System Limitations*
107
108None
109
110*Known Vulnerabilities*
111
112None
113
114*Workarounds*
115
116Documented under corresponding jira if applicable.
117
118Security Notes
119--------------
120
121*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]122
123* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]124 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]125 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]126 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]127
128*Known Security Issues*
129
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]130 * Weak Crytography using md5
131 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]132
133*Known Vulnerabilities in Used Modules*
134
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]135 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]136
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]137CPS 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.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]138
139Test Results
140------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]141 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]142
143References
144----------
145
146For 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
159Quick 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>`_