clean up some sphinx warnings
[dcaegen2.git] / docs / sections / version_11.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 ..      * * *    KOHN   * * *
6 ..      =====================
7
8
9 Version: 11.0.0
10 ===============
11
12
13 Abstract
14 --------
15
16 This document provides the release notes for Kohn release.
17
18 Summary
19 -------
20
21 The following DCAE components are available with default ONAP/DCAE 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
52 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services.
53
54 For Helm managed microservices,  dependencies are identified on each chart individually.
55 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.
56
57 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
58
59
60 Release Data
61 ------------
62
63 +--------------------------------------+--------------------------------------------------------+
64 | **DCAE Project**                     |                                                        |
65 |                                      |                                                        |
66 +--------------------------------------+--------------------------------------------------------+
67 | **Docker images**                    | Refer :any:`Deliverable <kohn_deliverable>`            |
68 |                                      |                                                        |
69 +--------------------------------------+--------------------------------------------------------+
70 | **Release designation**              | 11.0.0 Kohn                                            |
71 |                                      |                                                        |
72 +--------------------------------------+--------------------------------------------------------+
73 | **Release date**                     | 2022-12-08                                             |
74 |                                      |                                                        |
75 +--------------------------------------+--------------------------------------------------------+
76
77
78 New features
79 ------------
80
81 *DCAE Enhancements and Features*
82
83 DCAEGEN2-3148 5G SON use case enhancements for Kohn release
84     - CL message for ANR modified to align with A1-based flow/support
85
86 DCAEGEN2-3195 CCVPN Kohn Enhancements for Intent-based Cloud Leased Line and Transport Slicing
87     - DCAE SDK alignment for SliceAnalysis MS & enhancing AAI interface for supporting IBN CL
88
89 DCAEGEN2-3194 Maintenance and Enhancement of Intent-driven Closed-loop Autonomous Networks
90     - Slice Analysis Enhancement with AAI Interface/processing for CL notification
91
92 DCAEGEN2-3119 Helm Transformation - Post migration
93      - DCAE Common Template improvements
94      - Removed Cloudify and associated platform component charts
95      - Removed Consul/CBS API dependency from each DCAE MS, enabling independent config management via respective charts
96
97 DCAEGEN2-2975 VES 7.2.1 support for DCAE Microservices
98      - TCAgen2 enhanced to support VES 7.2.1
99
100 DCAEGEN2-3037 AAF certificate dependency removal
101     - DFC Enhanced to support additional property to disable certificates checks
102
103 DCAEGEN2-3030 DMAAP SDK standardization for DCAE Microservices
104     - SliceAnalysis MS, SON-Handler MS switched to use DMAAP SDK
105
106
107 *Non-Functional*
108
109    - DCAEGEN2-3089 - Sonarcoverage improvements for DCAE components - SliceAnalysis mS, SNMPTrap, TCA-gen2, SON-Handler, KPi-MS, Mapper, RESTConf  (meeting 80% or more coverage)
110    - DCAEGEN2-3209 - CII Badging improvements (Silver badge completion)
111    - DCAEGEN2-3196 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector, HV-VES, RESTConf, VES, Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
112    - DCAEGEN2-3225 - SBOM Enablement for DCAE components
113
114
115 .. _kohn_deliverable:
116
117 Deliverables
118 ------------
119
120 Software Deliverables
121
122 .. csv-table::
123    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
124    :widths: auto
125
126    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.4"
127    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.9.0"
128    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.11.0"
129    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.4"
130    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.7"
131    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.1"
132    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
133    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
134    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
135    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
136    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
137    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
138    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
139    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
140    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
141    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"
142    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.2.0"
143    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
144    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
145    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
146    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
147    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.5"
148    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.11"
149    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.5.0"
150    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.3"
151    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.9.0"
152    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.1"
153    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.11"
154    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.4 (jar)"
155    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.10 (jar)"
156
157 The following repositories (and containers) have been deprecated with this release.
158
159 .. csv-table::
160    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
161    :widths: auto
162
163    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
164
165 As DCAEMOD has been identified for EOL with London, following containers will be deprecated in next release and removed from OOM.
166
167 .. csv-table::
168    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
169    :widths: auto
170
171    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
172    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
173    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
174    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
175    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
176    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
177    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"
178
179 Known Limitations, Issues and Workarounds
180 -----------------------------------------
181
182
183    - DCAEGEN2-3184 DL-Feeder log error and configuration issue
184
185 *Known Vulnerabilities*
186
187 None
188
189 *Workarounds*
190
191 Documented under corresponding jira if applicable.
192
193 Security Notes
194 --------------
195
196 *Fixed Security Issues*
197
198     Documented on earlier section
199
200 *Known Security Issues*
201
202     None
203
204 *Known Vulnerabilities in Used Modules*
205
206     None
207
208 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/Kohn+DCAE>`_.
209
210 Test Results
211 ------------
212
213  - `DCAE R11 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Kohn+Release>`_
214  - `DCAE R11 Functional Test <https://wiki.onap.org/display/DW/DCAE+R11+Kohn+Testplan>`_
215
216
217 References
218 ----------
219
220 For more information on the ONAP Jakarta release, please see:
221
222 #. `ONAP Home Page`_
223 #. `ONAP Documentation`_
224 #. `ONAP Release Downloads`_
225 #. `ONAP Wiki Page`_
226
227
228 .. _`ONAP Home Page`: https://www.onap.org
229 .. _`ONAP Wiki Page`: https://wiki.onap.org
230 .. _`ONAP Documentation`: https://docs.onap.org
231 .. _`ONAP Release Downloads`: https://git.onap.org
232
233 Quick Links:
234
235         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
236         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_