blob: bcfee8fc0e957cde78f999587c2e5a4418aa717a [file] [log] [blame]
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Vijay VK5e1694c2019-10-09 17:11:04 +01002.. http://creativecommons.org/licenses/by/4.0
VENKATESH KUMARcfb11092020-04-02 12:27:00 -04003.. Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved.
Lusheng Ji72c4fba2017-10-10 18:12:22 +00004
5Release Notes
6=============
7
VENKATESH KUMARcfb11092020-04-02 12:27:00 -04008Version: 6.0.0
9--------------
10
11
12**New Features**
13
14DCAE R6 improves upon previous release with the following new features:
15
16- DCAE Platform Enhancement
17 - Introduction of Microservice and Onboarding Design (MOD) platform
18 - Policy Notification support for DCAE components
19 - Dynamic AAF certificate creation during component instantiation
20 - Helm chart optimization to control each platform component separate
21 - Dashboard Optimization
22 - Blueprint generator tool to simplify deployment artifact creation
23
24
25- Following new services are delivered with Frankfurt
26 - Event Processors
27 - PM Subscription Handler
28 - DataLake Handlers
29 - Analytics/RCA
30 - TCA-GEN2
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040031 - Acumos Adapter (PoC)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040032
33Following is complete list of DCAE components available part of default ONAP/DCAE installation.
34 - Platform components
35 - Cloudify Manager (helm chart)
36 - Bootstrap container (helm chart)
37 - Configuration Binding Service (helm chart)
38 - Deployment Handler (helm chart)
39 - Policy Handler (helm chart
40 - Service Change Handler (helm chart)
41 - Inventory API (helm chart)
42 - Dashboard (helm chart)
43 - Service components
44 - VES Collector
45 - Threshold Crossing Analytics (TCA/CDAP)
46 - HV-VES Collector
47 - PNF-Registration Handler
48 - Docker based Threshold Crossing Analytics (TCA-Gen2)
49 - Holmes Rule Management *
50 - Holmes Engine Management *
51 - Additional resources that DCAE utilizes deployed using ONAP common charts:
52 - Postgres Database
53 - Mongo Database
54 - Redis Cluster Database
55 - Consul Cluster
56
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040057Following are service components (mS) which can be deployed on-demand
58 - SNMPTrap Collector
59 - RESTConf Collector
60 - DataFile Collector
61 - PM-Mapper
62 - BBS-EventProcessor
63 - VES Mapper
64 - Heartbeat mS
65 - SON-Handler
66 - PM-Subscription Handler
67
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040068 Notes:
69 \* These components are delivered by the Holmes project.
70
71
72
73Under OOM (Kubernetes) deployment 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.
74
75
76- All DCAE components are designed to support platform maturity requirements.
77
78
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040079**Bug Fixes**
80
81**Known Issues**
82 * Blueprint generator issue (DCAEGEN2-2140)
83
84
85**Security Notes**
86
87*Fixed Security Issues*
88
89 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
90 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
91 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
92 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
93 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
94
95*Known Security Issues*
96
97 None
98
99
100*Known Vulnerabilities in Used Modules*
101
102 None
103
104DCAE 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>`_.
105
106Quick Links:
107 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
108
109 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
110
111Artifacts released:
112
113.. csv-table::
114 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
115 :widths: auto
116
117 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
118 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
119 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
120 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
121 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
122 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
123 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
124 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
125 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400126 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400127 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
128 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
129 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
130 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
131 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
132 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
133 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
134 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
135 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
136 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400137 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
138 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.5"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400139 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
140 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
141 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
142 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
143 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400144 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
145 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400146 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
147 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
148 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
149 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
150 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
151 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
152 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.0"
153 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.1"
154 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
155 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
156 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
157
158
159
Vijay VK09589ca2019-10-08 04:47:17 +0100160Version: 5.0.1
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400161--------------
162
Vijay VK09589ca2019-10-08 04:47:17 +0100163The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400164
165Following is summary of updates done for DCAEGEN2
166
167**Security**
168
169Following platform components were enabled for HTTPS
170 - ConfigBindingService (CBS)
171 - CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
172 - Cloudify Manager
173 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100174 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400175
176All components interfacing with platform components were modified to support TLS interface
177
178**Miscellaneous**
179 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
180 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200181 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400182 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200183 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100184
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400185
186
187With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
188 - Platform components
189 - Cloudify Manager (helm chart)
190 - Bootstrap container (helm chart)
191 - Configuration Binding Service (helm chart)
192 - Deployment Handler (helm chart)
193 - Policy Handler (helm chart
194 - Service Change Handler (helm chart)
195 - Inventory API (helm chart)
196 - Dashboard (helm charts)
197 - Service components
198 - VES Collector
199 - SNMP Collector
200 - Threshold Crossing Analytics
201 - HV-VES Collector
202 - PNF-Registration Handler
203 - Holmes Rule Management *
204 - Holmes Engine Management *
205 - Additional resources that DCAE utilizes:
206 - Postgres Database
207 - Redis Cluster Database
208 - Consul Cluster *
209
210 Notes:
211 \* These components are delivered by external ONAP project.
212
213DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
214
215 - Collectors
216 - RESTConf collector 
217 - DataFile collector
218 - Event Processors
219 - VES Mapper
220 - 3gpp PM-Mapper
221 - BBS Event processor
222 - Analytics/RCA
223 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200224 - Missing Heartbeat Ms
225
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400226- All DCAE components are designed to support platform maturity requirements.
227
228
229**Source Code**
230
231Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
232 - dcaegen2
233 - dcaegen2.analytics.tca
234 - dcaegen2.collectors.snmptrap
235 - dcaegen2.collectors.ves
236 - dcaegen2.collectors.hv-ves
237 - dcaegen2.collectors.datafile
238 - dcaegen2.collectors.restconf
239 - dcaegen2.deployments
240 - dcaegen2.platform.blueprints
241 - dcaegen2.platform.cli
242 - dcaegen2.platform.configbinding
243 - dcaegen2.platform.deployment-handler
244 - dcaegen2.platform.inventory-api
245 - dcaegen2.platform.plugins
246 - dcaegen2.platform.policy-handler
247 - dcaegen2.platform.servicechange-handler
248 - dcaegen2.services.heartbeat
249 - dcaegen2.services.mapper
250 - dcaegen2.services.pm-mapper
251 - dcaegen2.services.prh
252 - dcaegen2.services.son-handler
253 - dcaegen2.services
254 - dcaegen2.services.sdk
255 - dcaegen2.utils
256 - ccsdk.platform.plugins
257 - ccsdk.dashboard
258
259**Bug Fixes**
260 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
261 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
262
263
264**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200265 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
266
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400267**Security Notes**
268
269*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200270 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100271 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
272 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
273 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
274 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
Vijay VK09589ca2019-10-08 04:47:17 +0100275
276*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100277 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
278 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
Vijay VK09589ca2019-10-08 04:47:17 +0100279 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
280 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
281 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
282
283*Known Vulnerabilities in Used Modules*
284
285DCAE 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>`_.
286
287Quick Links:
288 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
289
290 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
291
292 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
293
294
295**Upgrade Notes**
296
297The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
298 - K8S Bootstrap container:
299 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
300 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
301 - Configuration Binding Service:
302 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
303 - Description: HTTPS support, Image optimization and non-root user
304 - Inventory API
305 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
306 - Description: HTTPS support, container optmization and non-root user
307 - DataFile Collector
308 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
309 - Description : Code optimization, bug fixes, dmaap plugin integration
310 - SON Handler MS
311 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
312 - Description : Image optimization, bug fixes, CBS integration
313 - VES Adapter/Mapper MS
314 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
315 - Description : Image optimization & CBS periodic polling
316 - PRH MS
317 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
318 - Description : Code optimization, bug fixes and SDK alignment
319 - HV-VES MS
320 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
321 - Description : Code optimization, bug fixes and SDK alignment
322
323Version: 5.0.0
324--------------
325
326El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
327
328Following is summary of updates done for DCAEGEN2
329
330**Security**
331
332Following platform components were enabled for HTTPS
333 - ConfigBindingService (CBS)
334 - CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
335 - Cloudify Manager
336 - InventoryAPI
337
338All components interfacing with platform components were modified to support TLS interface
339
340**Miscellaneous**
341 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
342 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200343 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100344 - CBS client libraries updated to remove consul service lookup
345
346
347
348**Bug Fixes**
349 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
350 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
351
352
353**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200354 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
355
Vijay VK09589ca2019-10-08 04:47:17 +0100356
357**Security Notes**
358
359*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400360
361*Known Security Issues*
362
363 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
364 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
365 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
366 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
367 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
368 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
369 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
370 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
371 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
372 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
373
374*Known Vulnerabilities in Used Modules*
375
376DCAE 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>`_.
377
378Quick Links:
379 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
380
381 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
382
383 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
384
385
386**Upgrade Notes**
387
388The following components are upgraded from Dublin/R4.
389 - Cloudify Manager:
390 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
391 - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5. The container was updated to support TLS.
392 - K8S Bootstrap container:
393 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
394 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
395 - Configuration Binding Service:
396 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
397 - Description: HTTPS support, Image optimization and non-root user
398 - Deployment Handler
399 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
400 - Description: Update to node10, uninstall workflow updates
401 - Service Change Handler
402 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
403 - Description: HTTPS inventoryAPI support, container optmization and non-root user
404 - Inventory API
405 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
406 - Description: HTTPS support, container optmization and non-root user
407 - DataFile Collector
408 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
409 - Description : Code optimization, bug fixes, dmaap plugin integration
410 - 3gpp PM-Mapper
411 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
412 - Description: Code optimization, bug fixes, dmaap plugin integration
413
414
415
Vijay VK6b0fa462019-05-20 16:06:11 +0100416Version: 4.0.0
417--------------
418
419:Release Date: 2019-06-06
420
421**New Features**
422
423DCAE R4 improves upon previous release with the following new features:
424
425- DCAE Platform Enhancement
426 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
427 - Support helm chart deployment in DCAE using new Helm cloudify plugin
428 - DCAE Healthcheck enhancement to cover static and dynamic deployments
429 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
430 - Dashboard Integration (UI for deployment/verification)
431 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
432 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200433 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100434
435- Following new services are delivered with Dublin
436 - Collectors
437 - RESTConf collector 
438 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100439 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100440 - 3gpp PM-Mapper
441 - BBS Event processor
442 - Analytics/RCA
443 - SON-Handler
444 - Heartbeat MS
445
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200446Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
Vijay VK6b0fa462019-05-20 16:06:11 +0100447 - Platform components
448 - Cloudify Manager (helm chart)
449 - Bootstrap container (helm chart)
450 - Configuration Binding Service (helm chart)
451 - Deployment Handler (helm chart)
452 - Policy Handler (helm chart
453 - Service Change Handler (helm chart)
454 - Inventory API (helm chart)
455 - Dashboard (Cloudify Blueprint)
456 - Service components
457 - VES Collector
458 - SNMP Collector
459 - Threshold Crossing Analytics
460 - HV-VES Collector
461 - PNF-Registration Handler
462 - Holmes Rule Management *
463 - Holmes Engine Management *
464 - Additional resources that DCAE utilizes:
465 - Postgres Database
466 - Redis Cluster Database
467 - Consul Cluster *
468
469 Notes:
470 \* These components are delivered by the Holmes project.
471
472
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200473Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Vijay VK6b0fa462019-05-20 16:06:11 +0100474
475- All DCAE components are designed to support platform maturity requirements.
476
477
478**Source Code**
479
480Source code of DCAE components are released under the following repositories on gerrit.onap.org:
481 - dcaegen2
482 - dcaegen2.analytics.tca
483 - dcaegen2.collectors.snmptrap
484 - dcaegen2.collectors.ves
485 - dcaegen2.collectors.hv-ves
486 - dcaegen2.collectors.datafile
487 - dcaegen2.collectors.restconf
488 - dcaegen2.deployments
489 - dcaegen2.platform.blueprints
490 - dcaegen2.platform.cli
491 - dcaegen2.platform.configbinding
492 - dcaegen2.platform.deployment-handler
493 - dcaegen2.platform.inventory-api
494 - dcaegen2.platform.plugins
495 - dcaegen2.platform.policy-handler
496 - dcaegen2.platform.servicechange-handler
497 - dcaegen2.services.heartbeat
498 - dcaegen2.services.mapper
499 - dcaegen2.services.pm-mapper
500 - dcaegen2.services.prh
501 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200502 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100503 - dcaegen2.services.sdk
504 - dcaegen2.utils
505 - ccsdk.platform.plugins
506 - ccsdk.dashboard
507
508**Bug Fixes**
509
510**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200511 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
512
Vijay VK6b0fa462019-05-20 16:06:11 +0100513
514**Security Notes**
515
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200516*Fixed Security Issues*
517
518*Known Security Issues*
519
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200520 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200521 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200522 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
Krzysztof Opasiakf38f8392019-05-27 18:11:02 +0200523 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
Krzysztof Opasiak01a58302019-05-27 18:11:28 +0200524 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
Krzysztof Opasiak7c269dc2019-05-30 23:57:24 +0200525 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
Krzysztof Opasiakf0b14642019-05-27 18:13:16 +0200526 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
Krzysztof Opasiak1f224ee2019-05-30 17:43:06 +0200527 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
Krzysztof Opasiak61cf8dc2019-05-30 17:43:51 +0200528 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
Krzysztof Opasiakbb8dea82019-05-30 17:44:35 +0200529 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200530
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200531*Known Vulnerabilities in Used Modules*
532
Vijay VK6b0fa462019-05-20 16:06:11 +0100533DCAE 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>`_.
534
535Quick Links:
536 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
537
538 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
539
540 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
541
542
543**New component Notes**
544The following components are introduced in R4
545
546 - Dashboard
547 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
548 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
549 - Blueprint generator
550 - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200551 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100552 - RESTConf collector 
553 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
554 - Description: Provides RESTConf interfaces to events from external domain controllers
555 - VES/Universal Mapper
556 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200557 - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
Vijay VK6b0fa462019-05-20 16:06:11 +0100558 - 3gpp PM-Mapper
559 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200560 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100561 - BBS Event processor
562 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200563 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100564 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100565 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200566 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100567 - Heartbeat MS
568 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
569 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200570
Vijay VK6b0fa462019-05-20 16:06:11 +0100571
572**Upgrade Notes**
573
574The following components are upgraded from R3
575 - Cloudify Manager:
576 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
577 - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200578 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100579 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200580 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
581 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100582 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
583 - Description: Code optimization and bug fixes
584 - Deployment Handler
585 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
586 - Include updates for health and service endpoint check and bug fixes
587 - Policy Handler
588 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
589 - Description: Policy Handler supports the new lifecycle API's from Policy framework
590 - Service Change Handler
591 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
592 - Description: No update from R3
593 - Inventory API
594 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
595 - Description: Refactoring and updates for health and service endpoint check
596 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +0100597 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200598 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100599 - Threshold Crossing Analytics
600 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
601 - Description: Config updates. Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
602 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100603 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100604 - Description : Code optimization, bug fixes, logging and performance improvement
605 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100606 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200607 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100608 - HV-VES Collector
609 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
610 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
611 - SNMP Trap Collector
612 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200613 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100614
615
616
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500617
618Version: 3.0.1
619--------------
620
621:Release Date: 2019-01-31
622
623DCAE R3 Maintenance release includes following fixes
624
625**Bug Fixes**
626
627- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200628 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500629 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200630 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500631 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200632 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500633 Multiple Fileready notification not handled
634
635- HighVolume VES Collector (protobuf/tcp)
636 - DCAEGEN2-976
637 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
638
639- VESCollector (http)
640 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200641 Issue with VES batch event publish
642
643- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500644 - DCAEGEN2-1007
645 Removing obsolete services configuration
646
647
648The following containers are updated in R3.0.1
649
650 - DataFile Collector
651 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
652 - HV-VES Collector
653 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
654 - VES Collector
655 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
656
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500657**Known Issues**
658
659- An issue related to VESCollector basic authentication was noted and tracked under DCAEGEN2-1130. This configuration is not enabled by default for R3.0.1; and fix will be handled in Dublin
660
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200661- Certificates under onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 has expired March'2019 and impacting CL deployment from CLAMP. Follow below workaround to update the certificate
Vijay VK6b0fa462019-05-20 16:06:11 +0100662 kubectl get deployments -n onap | grep deployment-handler
663 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
664 Search and change tag onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 to onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3
665
666
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500667
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500668
Vijay VK2648c6d2018-09-19 04:30:37 +0100669Version: 3.0.0
670--------------
671
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800672:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100673
674**New Features**
675
676DCAE R3 improves upon previous release with the following new features:
677
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200678- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100679 - Platform components
680 - Cloudify Manager
681 - Bootstrap container
682 - Configuration Binding Service
683 - Deployment Handler
684 - Policy Handler
685 - Service Change Handler
686 - Inventory API
687 - Service components
688 - VES Collector
689 - SNMP Collector
690 - Threshold Crossing Analytics
691 - Holmes Rule Management *
692 - Holmes Engine Management *
693 - Additional resources that DCAE utilizes:
694 - Postgres Database
695 - Redis Cluster Database
696 - Consul Cluster
697
698 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000699 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100700
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200701- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100702
703 - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
704 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
705
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200706- DCAE R3 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Vijay VK2648c6d2018-09-19 04:30:37 +0100707
708- All DCAE components are designed to support platform maturity requirements.
709
710
711**Source Code**
712
713Source code of DCAE components are released under the following repositories on gerrit.onap.org:
714 - dcaegen2
715 - dcaegen2.analytics
716 - dcaegen2.analytics.tca
717 - dcaegen2.collectors
718 - dcaegen2.collectors.snmptrap
719 - dcaegen2.collectors.ves
720 - dcaegen2.collectors.hv-ves
721 - dcaegen2.collectors.datafile
722 - dcaegen2.deployments
723 - dcaegen2.platform
724 - dcaegen2.platform.blueprints
725 - dcaegen2.platform.cli
726 - dcaegen2.platform.configbinding
727 - dcaegen2.platform.deployment-handler
728 - dcaegen2.platform.inventory-api
729 - dcaegen2.platform.plugins
730 - dcaegen2.platform.policy-handler
731 - dcaegen2.platform.servicechange-handler
732 - dcaegen2.services.heartbeat
733 - dcaegen2.services.mapper
734 - dcaegen2.services.prh
735 - dcaegen2.utils
736
737**Bug Fixes**
738
739**Known Issues**
740
741- DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine. Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image. DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
742
743**Security Notes**
744
745DCAE 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=28377647>`_.
746
747Quick Links:
748 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
749
750 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
751
Vijay VKab471f62018-11-26 17:49:43 +0000752 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100753
754
Vijay VKf6659fc2018-11-02 05:07:27 +0100755**New component Notes**
756The following components are introduced in R3
757
758 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000759 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100760 - Description : Bulk data file collector to fetch non-realtime PM data
761 - PNF Registrator handler
762 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200763 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100764 - HV-VES Collector
765 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
766 - Description : High Volume VES Collector for fetching real-time PM measurement data
767 - SNMP Trap Collector
768 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200769 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100770
Vijay VK2648c6d2018-09-19 04:30:37 +0100771
772**Upgrade Notes**
773
774The following components are upgraded from R2:
775 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100776 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100777 - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.7.23, which is based on Cloudify Manager 4.3.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200778 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100779 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100780 - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications. The bootstrap is for OOM (Kubernetes) based deployment.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200781 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100782 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
783 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
784 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100785 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100786 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100787 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100788 - Description: Policy Handler now supports the new configuration policy format and support for TLS
789 - Service Change Handler
790 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
791 - Description: Refactoring.
792 - Inventory API
793 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
794 - Description: Refactoring.
795 - VES Collector
796 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500797 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100798 - Threshold Crossing Analytics
799 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
800 - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
801
802
803
804
Lusheng Jib2a561b2018-03-27 23:24:33 -0400805Version: 2.0.0
806--------------
807
Gildas Lanilis82799c72018-05-30 13:22:48 -0700808:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400809
810**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400811
Lusheng Jib2a561b2018-03-27 23:24:33 -0400812DCAE R2 improves upon previous release with the following new features:
813
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200814- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400815 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400816 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400817 - Bootstrap container
818 - Configuration Binding Service
819 - Deployment Handler
820 - Policy Handler
821 - Service Change Handler
822 - Inventory API
823 - Service components
824 - VES Collector
825 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400826 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400827 - Holmes Rule Management *
828 - Holmes Engine Management *
829 - Additional resources that DCAE utilizes:
830 - Postgres Database
831 - Redis Cluster Database
832 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400833
Lusheng Ji768421b2018-06-01 16:36:54 -0400834 Notes:
835 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400836
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200837- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400838
Lusheng Ji768421b2018-06-01 16:36:54 -0400839 - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
Lusheng Jieaac78d2018-06-06 00:20:03 -0400840 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400841
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200842- DCAE R2 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
Lusheng Ji768421b2018-06-01 16:36:54 -0400843
844- All DCAE components are designed to support platform maturity requirements.
845
846
847**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400848
849Source code of DCAE components are released under the following repositories on gerrit.onap.org:
850 - dcaegen2
851 - dcaegen2.analytics
852 - dcaegen2.analytics.tca
853 - dcaegen2.collectors
854 - dcaegen2.collectors.snmptrap
855 - dcaegen2.collectors.ves
856 - dcaegen2.deployments
857 - dcaegen2.platform
858 - dcaegen2.platform.blueprints
859 - dcaegen2.platform.cli
860 - dcaegen2.platform.configbinding
861 - dcaegen2.platform.deployment-handler
862 - dcaegen2.platform.inventory-api
863 - dcaegen2.platform.plugins
864 - dcaegen2.platform.policy-handler
865 - dcaegen2.platform.servicechange-handler
866 - dcaegen2.services.heartbeat
867 - dcaegen2.services.mapper
868 - dcaegen2.services.prh
869 - dcaegen2.utils
870
871**Bug Fixes**
872
873**Known Issues**
874
Lusheng Ji768421b2018-06-01 16:36:54 -0400875- DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine. Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image. DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
876
Gildas Lanilis82799c72018-05-30 13:22:48 -0700877**Security Notes**
878
879DCAE 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=28377647>`_.
880
881Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400882 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
883
884 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
885
886 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
887
888
Lusheng Jib2a561b2018-03-27 23:24:33 -0400889
890**Upgrade Notes**
891
Lusheng Ji768421b2018-06-01 16:36:54 -0400892The following components are upgraded from R1:
893 - Cloudify Manager:
894 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
895 - Description: R2 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200896 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400897 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400898 - Description: R2 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications. The bootstrap is for OOM (Kubernetes) based deployment.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200899 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400900 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
901 - Description: Configuration Binding Sevice now supports the new configuration policy format.
902 - Deployment Handler
903 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
904 - Policy Handler
905 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
906 - Description: Policy Handler now supports the new configuration policy format.
907 - Service Change Handler
908 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
909 - Description: Refactoring.
910 - Inventory API
911 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
912 - Description: Refactoring.
913 - VES Collector
914 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
915 - Threshold Crossing Analytics
916 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
917 - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
918
Lusheng Jib2a561b2018-03-27 23:24:33 -0400919
920
Lusheng Ji8fafa432017-11-06 21:52:26 -0500921Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000922--------------
923
Lusheng Ji8fafa432017-11-06 21:52:26 -0500924:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000925
926
927**New Features**
928
Lusheng Ji8fafa432017-11-06 21:52:26 -0500929DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
930sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
931DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
932vDNS, vCPU, and vVoLTE.
933
934Specifically, DCAE R1 includes the following components:
935
936- Core platform
937 - Cloudify manager
938 - Consul cluster
939- Extended platform
940 - Platform component docker host
941 - Service component docker host
942 - CDAP cluster
943 - PostgreSQL database (*)
944- Platform docker container components
945 - Configuration binding service
946 - Deployment handler
947 - Service change handler
948 - Inventory
949 - Policy handler
950 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200951- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500952 - Docker container components
953 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000954 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500955 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000956 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500957
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200958(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
959VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500960other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200961(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500962in R1.
963
964Source codes of DCAE are released under the following repositories on gerrit.onap.org:
965
966- dcaegen2
967- dcaegen2/analytics
968- dcaegen2/analytics/tca
969- dcaegen2/collectors
970- dcaegen2/collectors/snmptrap
971- dcaegen2/collectors/ves
972- dcaegen2/deployments
973- dcaegen2/platform
974- dcaegen2/platform/blueprints
975- dcaegen2/platform/cdapbroker
976- dcaegen2/platform/cli
977- dcaegen2/platform/configbinding
978- dcaegen2/platform/deployment-handler
979- dcaegen2/platform/inventory-api
980- dcaegen2/platform/plugins
981- dcaegen2/platform/policy-handler
982- dcaegen2/platform/servicechange-handler
983- dcaegen2/utils
984
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000985
986**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500987
988This is the initial release.
989
990
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000991**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500992
993- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
994- Need to provide a dev configuration DCAE.
995
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000996
997**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000998
ankatare30c4cb42018-09-28 14:26:59 +0530999- The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches. This key is currently passed in as a Heat template parameter. Tracked by JIRA `DCAEGEN2-178 <https://jira.onap.org/browse/DCAEGEN2-178>`_.>`_.
Lusheng Jieaac78d2018-06-06 00:20:03 -04001000- The RESTful API calls are generally not secure. That is, they are either over http, or https without certificate verification. Once there is an ONAP wide solution for handling certificates, DCAE will switch to https.
1001
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001002
1003**Upgrade Notes**
1004
Lusheng Ji8fafa432017-11-06 21:52:26 -05001005This is the initial release.
1006
1007
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001008**Deprecation Notes**
1009
Lusheng Ji8fafa432017-11-06 21:52:26 -05001010There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1011DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1012following Gerrit repos are voided and already locked as read-only.
1013
1014- dcae
1015- dcae/apod
1016- dcae/apod/analytics
1017- dcae/apod/buildtools
1018- dcae/apod/cdap
1019- dcae/collectors
1020- dcae/collectors/ves
1021- dcae/controller
1022- dcae/controller/analytics
1023- dcae/dcae-inventory
1024- dcae/demo
1025- dcae/demo/startup
1026- dcae/demo/startup/aaf
1027- dcae/demo/startup/controller
1028- dcae/demo/startup/message-router
1029- dcae/dmaapbc
1030- dcae/operation
1031- dcae/operation/utils
1032- dcae/orch-dispatcher
1033- dcae/pgaas
1034- dcae/utils
1035- dcae/utils/buildtools
1036- ncomp
1037- ncomp/cdap
1038- ncomp/core
1039- ncomp/docker
1040- ncomp/maven
1041- ncomp/openstack
1042- ncomp/sirius
1043- ncomp/sirius/manager
1044- ncomp/utils
1045
1046
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001047**Other**
1048
Vijay0fbc6732017-11-08 13:55:01 +00001049SNMP trap collector is seed code delivery only.