clean up some sphinx warnings
[dcaegen2.git] / docs / sections / version_12.0.0.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 ..      =======================
5 ..      * * *    LONDON   * * *
6 ..      =======================
7
8
9 Version: 12.0.0
10 ===============
11
12
13 Abstract
14 --------
15
16 This document provides the release notes for London release.
17
18 Summary
19 -------
20
21 The following DCAE components are available with default ONAP/DCAE chart installation:
22
23     - Service components
24         - VES Collector
25         - HV-VES Collector
26         - PNF-Registration Handler
27         - Docker based Threshold Crossing Analytics (TCA-Gen2)
28         - VES OpenAPI Manager
29
30     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
31
32         - Postgresql Database
33         - Mongo Database
34
35
36 These service components (mS) are available to be deployed on-demand via helm:
37
38         - SNMPTrap Collector
39         - RESTConf Collector
40         - DataFile Collector
41         - PM-Mapper
42         - VES Mapper
43         - Heartbeat mS
44         - SON-Handler
45         - PM-Subscription Handler
46         - DataLake Handler (Admin & Feeder)
47         - Slice Analysis mS
48         - DataLake Extraction Service
49         - KPI-Ms
50
51 All supported DCAE Microservices are maintained as Helm charts under `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/dcaegen2-services/components>`_
52
53
54 All DCAE component are deployed as Kubernetes Pods/Deployments/Services through ONAP/OOM.
55
56 For each microservices,  dependencies are identified on corresponding helm chart individually.
57 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
58
59 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
60
61
62 Release Data
63 ------------
64
65 +--------------------------------------+--------------------------------------------------------+
66 | **DCAE Project**                     |                                                        |
67 |                                      |                                                        |
68 +--------------------------------------+--------------------------------------------------------+
69 | **Docker images**                    | Refer :any:`Deliverable <london_deliverable>`          |
70 |                                      |                                                        |
71 +--------------------------------------+--------------------------------------------------------+
72 | **Release designation**              | 12.0.0 London                                          |
73 |                                      |                                                        |
74 +--------------------------------------+--------------------------------------------------------+
75 | **Release date**                     | 2023-06-15                                             |
76 |                                      |                                                        |
77 +--------------------------------------+--------------------------------------------------------+
78
79
80 New features
81 ------------
82
83 *DCAE Enhancements and Features*
84
85
86 DCAEGEN2-3037 AAF certificate dependency removal
87     - PM-Mapper, RESTConf, VESOpenAPI enhanced to support additional property to disable certificates checks
88
89 DCAEGEN2-3312 Improve DCAE PRH to handle Early PNF Registrations
90         - Support PNF registration reprocessing via Kafka persistence
91
92 DCAEGEN2-3278 - DCAEMOD retirement
93         - OOM and documentation updates to formalize DCAEMOD deprecation
94
95 DCAEGEN2-3067  AI/ML MS for IBN based closed Loop in E2E Network Slicing (POC)
96      - Mainstreaming the ml-prediction-ms (New mS introduction)
97      - Support for multiple slices (sNSSAIs) in training and prediction modules
98      - Use CPS instead of Config DB
99      - Remove RAN Simulator dependency
100
101 *Non-Functional*
102
103    - DCAEGEN2-3256 - Sonarcoverage improvements for DCAE components - VESCollector, Heartbeat MS, TCA-gen2  (meeting 80% or more coverage)
104    - DCAEGEN2-3318 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector, RESTConf, VES OpenAPI Manager, KPI-MS, Mapper, PM-Mapper, PRH, DCAE-SDK, SON-handler,  Slice-Analysis MS)
105
106
107
108 .. _london_deliverable:
109
110 Deliverables
111 ------------
112
113 Software Deliverables
114
115 .. csv-table::
116    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
117    :widths: auto
118
119    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.4.0"
120    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.10.0"
121    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.11.0"
122    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.4.1"
123    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.7"
124    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.12.3"
125    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
126    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
127    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.3.1"
128    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
129    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
130    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
131    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.3"
132    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.2.1"
133    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.2.1"
134    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.6.1"
135    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.5.0"
136    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.10.1"
137    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.9.0"
138    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.2.1"
139    "dcaegen2/services/sdk", "", "DCAE SDK 1.9.3 (jar)"
140
141 The following repositories (and containers) is POC deliverable for IBN based closed Loop in E2E Network Slicing using ML/MS.
142
143 .. csv-table::
144    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
145    :widths: auto
146
147    "dcaegen2/services", "components/ml-prediction-ms", "onap/org.onap.dcaegen2.services.ml-prediction-ms:1.0.0"
148
149 The following repositories (and containers) have been deprecated with this release.
150
151 .. csv-table::
152    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
153    :widths: auto
154
155    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
156    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
157    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
158    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
159    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
160    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
161    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"
162    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.4 (jar)"
163
164 With AAF deprecation by OOM project, all certificates are managed through Service-Mesh. Following container was introduced in DCAE to work with AAF for interal certificate generation. This container is no longer required with London release.
165
166 .. csv-table::
167    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
168    :widths: auto
169
170    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
171
172
173 Known Limitations, Issues and Workarounds
174 -----------------------------------------
175
176    - DCAEGEN2-3184 DL-Feeder log error and configuration issue
177
178 *Known Vulnerabilities*
179
180 None
181
182 *Workarounds*
183
184 Documented under corresponding jira if applicable.
185
186 Security Notes
187 --------------
188
189 *Fixed Security Issues*
190
191     Documented on earlier section
192
193 *Known Security Issues*
194
195     None
196
197 *Known Vulnerabilities in Used Modules*
198
199     None
200
201 DCAE 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. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/display/SV/London+DCAE>`_.
202
203 Test Results
204 ------------
205
206  - `DCAE R12 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+London+Release>`_
207  - `DCAE R12 Functional Test <https://wiki.onap.org/display/DW/DCAE+R12+London+Testplan>`_
208
209
210 References
211 ----------
212
213 For more information on the ONAP London release, please see:
214
215 #. `ONAP Home Page`_
216 #. `ONAP Documentation`_
217 #. `ONAP Release Downloads`_
218 #. `ONAP Wiki Page`_
219
220
221 .. _`ONAP Home Page`: https://www.onap.org
222 .. _`ONAP Wiki Page`: https://wiki.onap.org
223 .. _`ONAP Documentation`: https://docs.onap.org
224 .. _`ONAP Release Downloads`: https://git.onap.org
225
226 Quick Links:
227
228         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
229         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_