Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / f0527c58c17963d940535d0ce0eb934c2b4c635c / . / docs / release-notes.rst
blob: f213c7e4de217a1f6ce270a3236d778086f3adbc [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
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame^]19.. ========================
20.. * * * HONOLULU * * *
21.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]22
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]23Version: 1.0.1
24==============
25
26Release 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
43Bug 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
54Security Notes
55--------------
56
57*Fixed Security Issues*
58
59 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]60
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]61*Known Security Issues*
62
63 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
64
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]65Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]66==============
67
68
69Abstract
70--------
71
72This document provides the release notes for Honolulu release.
73
74Summary
75-------
76
77Following CPS components are available with default ONAP/CPS installation.
78
79
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]80 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]81
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]82 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]83
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]84 * Service components
85
86 - CPS Core
87
88 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]89
90 - Postgres Database
91
92
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]93Below service components (mS) are available to be deployed on-demand.
94 - CPS-TBDMT
95
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]96
97Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
98
99
100Release Data
101------------
102
103+--------------------------------------+--------------------------------------------------------+
104| **CPS Project** | |
105| | |
106+--------------------------------------+--------------------------------------------------------+
107| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
108| | |
109+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]110| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]111| | |
112+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]113| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]114| | |
115+--------------------------------------+--------------------------------------------------------+
116
117
118Features
119--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]120Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
121CPS has been driven by the needs of the E2E Networking Slicing use case.
122It currently supports basic (rw) persistence and simple queries.
123It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]124
125.. _honolulu_deliverable:
126
127Deliverables
128------------
129
130Software Deliverables
131
132.. csv-table::
133 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
134 :widths: auto
135
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]136 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]137
138
139Known Limitations, Issues and Workarounds
140-----------------------------------------
141
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]142 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
143 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
144 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]145 - `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.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]146
147*System Limitations*
148
149None
150
151*Known Vulnerabilities*
152
153None
154
155*Workarounds*
156
157Documented under corresponding jira if applicable.
158
159Security Notes
160--------------
161
162*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]163
164* `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]165 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]166 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]167 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]168
169*Known Security Issues*
170
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]171 * Weak Crytography using md5
172 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]173
174*Known Vulnerabilities in Used Modules*
175
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]176 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]177
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]178CPS 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]179
180Test Results
181------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]182 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]183
184References
185----------
186
187For more information on the ONAP Honolulu release, please see:
188
189#. `ONAP Home Page`_
190#. `ONAP Documentation`_
191#. `ONAP Release Downloads`_
192#. `ONAP Wiki Page`_
193
194
195.. _`ONAP Home Page`: https://www.onap.org
196.. _`ONAP Wiki Page`: https://wiki.onap.org
197.. _`ONAP Documentation`: https://docs.onap.org
198.. _`ONAP Release Downloads`: https://git.onap.org
199
200Quick Links:
201
202 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
203 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_