Merge "CPS-240 - Create REST End-point on NF-Proxy for DataNode Update & cpsPath...
[cps.git] / 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: 0.0.3
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     - Service components
40
41         -
42
43     - Additional resources that CPS utilizes deployed using ONAP common charts:
44
45         - Postgres Database
46
47
48
49 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
50
51
52 Release Data
53 ------------
54
55 +--------------------------------------+--------------------------------------------------------+
56 | **CPS Project**                      |                                                        |
57 |                                      |                                                        |
58 +--------------------------------------+--------------------------------------------------------+
59 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
60 |                                      |                                                        |
61 +--------------------------------------+--------------------------------------------------------+
62 | **Release designation**              | 0.0.3 Honolulu                                         |
63 |                                      |                                                        |
64 +--------------------------------------+--------------------------------------------------------+
65 | **Release date**                     | 2021-03-01                                             |
66 |                                      |                                                        |
67 +--------------------------------------+--------------------------------------------------------+
68
69
70 Features
71 --------
72
73
74 .. _honolulu_deliverable:
75
76 Deliverables
77 ------------
78
79 Software Deliverables
80
81 .. csv-table::
82    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
83    :widths: auto
84
85    "tbc", "tbc", "tbc"
86
87
88 Known Limitations, Issues and Workarounds
89 -----------------------------------------
90
91     * TBC
92
93
94 *System Limitations*
95
96 None
97
98 *Known Vulnerabilities*
99
100 None
101
102 *Workarounds*
103
104 Documented under corresponding jira if applicable.
105
106 Security Notes
107 --------------
108
109 *Fixed Security Issues*
110     Listed above
111
112 *Known Security Issues*
113
114         None
115
116
117 *Known Vulnerabilities in Used Modules*
118
119         None
120
121 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. 
122
123 Test Results
124 ------------
125
126
127 References
128 ----------
129
130 For more information on the ONAP Honolulu release, please see:
131
132 #. `ONAP Home Page`_
133 #. `ONAP Documentation`_
134 #. `ONAP Release Downloads`_
135 #. `ONAP Wiki Page`_
136
137
138 .. _`ONAP Home Page`: https://www.onap.org
139 .. _`ONAP Wiki Page`: https://wiki.onap.org
140 .. _`ONAP Documentation`: https://docs.onap.org
141 .. _`ONAP Release Downloads`: https://git.onap.org
142
143 Quick Links:
144
145         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
146         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_