Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / 663df2c1b8d9176094a62b00b7e80de096180621 / . / docs / sections / version_7.0.0.rst
blob: 24a97e901fce47bac02d31b453f16a717b037079 [file] [log] [blame]
Hansen, Tony (th1395)663df2c2023-05-23 21:27:17 +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.. ========================
5.. * * * GUILIN * * *
6.. ========================
7
8
9Version: 7.0.0
10==============
11
12
13Abstract
14--------
15
16This document provides the release notes for Guilin release.
17
18Summary
19-------
20
21Following DCAE components are available with default ONAP/DCAE installation.
22
23 - Platform components
24
25 - Cloudify Manager (helm chart)
26 - Bootstrap container (helm chart)
27 - Configuration Binding Service (helm chart)
28 - Deployment Handler (helm chart)
29 - Policy Handler (helm chart
30 - Service Change Handler (helm chart)
31 - Inventory API (helm chart)
32 - Dashboard (helm chart)
33
34 - Service components
35
36 - VES Collector
37 - HV-VES Collector
38 - PNF-Registration Handler
39 - Docker based Threshold Crossing Analytics (TCA-Gen2)
40 - Holmes Rule Management *
41 - Holmes Engine Management *
42
43 - Additional resources that DCAE utilizes deployed using ONAP common charts:
44
45 - Postgres Database
46 - Mongo Database
47 - Redis Cluster Database
48 - Consul Cluster
49
50Below service components (mS) are available to be deployed on-demand.
51
52 - SNMPTrap Collector
53 - RESTConf Collector
54 - DataFile Collector
55 - PM-Mapper
56 - BBS-EventProcessor
57 - VES Mapper
58 - Heartbeat mS
59 - SON-Handler
60 - PM-Subscription Handler
61 - DataLake Handler (Admin and Feeder)
62 - Slice Analysis
63 - DataLake Extraction Service
64
65 Notes:
66
67 \* These components are delivered by the Holmes project.
68
69
70
71Under OOM (Kubernetes) all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
72
73
74Release Data
75------------
76
77+--------------------------------------+--------------------------------------------------------+
78| **DCAE Project** | |
79| | |
80+--------------------------------------+--------------------------------------------------------+
81| **Docker images** | Refer :any:`Deliverable <guilin_deliverable>` |
82| | |
83+--------------------------------------+--------------------------------------------------------+
84| **Release designation** | 7.0.0 Guilin |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Release date** | 2020-11-19 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90
91
92New features
93------------
94
95- DCAE Enhancements
96
97 - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
98 - Bootstrap container optimization (DCAEGEN2-1791)
99 - MOD/Runtime - Enable configuration for dynamic topic support (DCAEGEN2-1996)
100 - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
101 - DCAE Dashboard UI Optimization and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
102 - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
103 - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
104 - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
105 - Java 11 upgrade complete for following modules - RESTConf, PM-Mapper, DFC, VES-Mapper, SON-handler, TCA-gen2, DL-Feeder, InventoryAPI, ServiceChangeHandler, MOD/RuntimeAPI, MOD/Bp-gen (DCAEGEN2-2223)
106 - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
107 - Best practice compliance
108 - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
109 - No more than one main process (DCAEGEN2-2327/REQ-365)
110 - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
111 - All containers must run as non-root (REQ-362)
112 - Code coverage >55% (DCAEGEN2-2333)
113 - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
114
115
116- Following new services are delivered this release
117
118 - Event Processors
119 - DataLake Extraction Service
120
121 - Analytics/RCA
122 - Slice Analysis MS
123
124.. _guilin_deliverable:
125
126Deliverables
127------------
128
129Software Deliverables
130
131.. csv-table::
132 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
133 :widths: auto
134
135 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
136 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
137 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
138 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
139 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
140 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
141 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
142 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
143 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
144 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
145 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
146 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
147 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
148 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
149 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
150 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
151 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
152 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
153 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
154 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
155 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8"
156 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
157 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
158 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"
159 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
160 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
161 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
162 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
163 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
164 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
165 "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
166 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
167 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
168 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
169 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
170 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
171 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
172 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
173 "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
174 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
175
176
177Known Limitations, Issues and Workarounds
178-----------------------------------------
179
180 * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
181 * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
182 * HV-VES - Pod recovery when config-fetch fails (DCAEGEN2-2516)
183
184
185*System Limitations*
186
187None
188
189*Known Vulnerabilities*
190
191None
192
193*Workarounds*
194
195Documented under corresponding jira if applicable.
196
197Security Notes
198--------------
199
200*Fixed Security Issues*
201 Listed above
202
203*Known Security Issues*
204
205 None
206
207
208*Known Vulnerabilities in Used Modules*
209
210 None
211
212DCAE 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/pages/viewpage.action?pageId=51282478>`_.
213
214Test Results
215------------
216
217 - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
218 - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
219
220
221References
222----------
223
224For more information on the ONAP Guilin release, please see:
225
226#. `ONAP Home Page`_
227#. `ONAP Documentation`_
228#. `ONAP Release Downloads`_
229#. `ONAP Wiki Page`_
230
231
232.. _`ONAP Home Page`: https://www.onap.org
233.. _`ONAP Wiki Page`: https://wiki.onap.org
234.. _`ONAP Documentation`: https://docs.onap.org
235.. _`ONAP Release Downloads`: https://git.onap.org
236
237Quick Links:
238
239 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
240 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_