blob: 2157b93224f420a3ec24c15de2f915c0ca95aa27 [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
31- Acumos Adapter (PoC)
32
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
57 Notes:
58 \* These components are delivered by the Holmes project.
59
60
61
62Under 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.
63
64
65- All DCAE components are designed to support platform maturity requirements.
66
67
68**Source Code**
69
70Source code of DCAE components are released under the following repositories on gerrit.onap.org:
71 - dcaegen2
72 - dcaegen2.analytics.tca
73 - dcaegen2.collectors.snmptrap
74 - dcaegen2.collectors.ves
75 - dcaegen2.collectors.hv-ves
76 - dcaegen2.collectors.datafile
77 - dcaegen2.collectors.restconf
78 - dcaegen2.deployments
79 - dcaegen2.platform.blueprints
80 - dcaegen2.platform.cli
81 - dcaegen2.platform.configbinding
82 - dcaegen2.platform.deployment-handler
83 - dcaegen2.platform.inventory-api
84 - dcaegen2.platform.plugins
85 - dcaegen2.platform.policy-handler
86 - dcaegen2.platform.servicechange-handler
87 - dcaegen2.services.heartbeat
88 - dcaegen2.services.mapper
89 - dcaegen2.services.pm-mapper
90 - dcaegen2.services.prh
91 - dcaegen2.services.son-handler
92 - dcaegen2.services
93 - dcaegen2.services.sdk
94 - dcaegen2.utils
95 - ccsdk.platform.plugins
96 - ccsdk.dashboard
97
98**Bug Fixes**
99
100**Known Issues**
101 * Blueprint generator issue (DCAEGEN2-2140)
102
103
104**Security Notes**
105
106*Fixed Security Issues*
107
108 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
109 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
110 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
111 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
112 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
113
114*Known Security Issues*
115
116 None
117
118
119*Known Vulnerabilities in Used Modules*
120
121 None
122
123DCAE 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>`_.
124
125Quick Links:
126 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
127
128 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
129
130Artifacts released:
131
132.. csv-table::
133 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
134 :widths: auto
135
136 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
137 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
138 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
139 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
140 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
141 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
142 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
143 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
144 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
145 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.0"
146 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
147 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
148 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
149 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
150 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
151 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
152 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
153 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
154 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
155 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
156 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.1"
157 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.4"
158 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
159 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
160 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
161 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
162 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
163 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.0"
164 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.1"
165 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
166 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
167 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
168 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
169 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
170 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
171 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.0"
172 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.1"
173 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
174 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
175 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
176
177
178
Vijay VK09589ca2019-10-08 04:47:17 +0100179Version: 5.0.1
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400180--------------
181
Vijay VK09589ca2019-10-08 04:47:17 +0100182The 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 -0400183
184Following is summary of updates done for DCAEGEN2
185
186**Security**
187
188Following platform components were enabled for HTTPS
189 - ConfigBindingService (CBS)
190 - 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>`_
191 - Cloudify Manager
192 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100193 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400194
195All components interfacing with platform components were modified to support TLS interface
196
197**Miscellaneous**
198 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
199 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200200 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400201 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200202 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100203
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400204
205
206With 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.
207 - Platform components
208 - Cloudify Manager (helm chart)
209 - Bootstrap container (helm chart)
210 - Configuration Binding Service (helm chart)
211 - Deployment Handler (helm chart)
212 - Policy Handler (helm chart
213 - Service Change Handler (helm chart)
214 - Inventory API (helm chart)
215 - Dashboard (helm charts)
216 - Service components
217 - VES Collector
218 - SNMP Collector
219 - Threshold Crossing Analytics
220 - HV-VES Collector
221 - PNF-Registration Handler
222 - Holmes Rule Management *
223 - Holmes Engine Management *
224 - Additional resources that DCAE utilizes:
225 - Postgres Database
226 - Redis Cluster Database
227 - Consul Cluster *
228
229 Notes:
230 \* These components are delivered by external ONAP project.
231
232DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
233
234 - Collectors
235 - RESTConf collector 
236 - DataFile collector
237 - Event Processors
238 - VES Mapper
239 - 3gpp PM-Mapper
240 - BBS Event processor
241 - Analytics/RCA
242 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200243 - Missing Heartbeat Ms
244
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400245- All DCAE components are designed to support platform maturity requirements.
246
247
248**Source Code**
249
250Source 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.
251 - dcaegen2
252 - dcaegen2.analytics.tca
253 - dcaegen2.collectors.snmptrap
254 - dcaegen2.collectors.ves
255 - dcaegen2.collectors.hv-ves
256 - dcaegen2.collectors.datafile
257 - dcaegen2.collectors.restconf
258 - dcaegen2.deployments
259 - dcaegen2.platform.blueprints
260 - dcaegen2.platform.cli
261 - dcaegen2.platform.configbinding
262 - dcaegen2.platform.deployment-handler
263 - dcaegen2.platform.inventory-api
264 - dcaegen2.platform.plugins
265 - dcaegen2.platform.policy-handler
266 - dcaegen2.platform.servicechange-handler
267 - dcaegen2.services.heartbeat
268 - dcaegen2.services.mapper
269 - dcaegen2.services.pm-mapper
270 - dcaegen2.services.prh
271 - dcaegen2.services.son-handler
272 - dcaegen2.services
273 - dcaegen2.services.sdk
274 - dcaegen2.utils
275 - ccsdk.platform.plugins
276 - ccsdk.dashboard
277
278**Bug Fixes**
279 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
280 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
281
282
283**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200284 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
285
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400286**Security Notes**
287
288*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200289 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100290 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
291 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
292 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
293 * 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 +0100294
295*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100296 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
297 * 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 +0100298 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
299 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
300 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
301
302*Known Vulnerabilities in Used Modules*
303
304DCAE 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>`_.
305
306Quick Links:
307 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
308
309 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
310
311 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
312
313
314**Upgrade Notes**
315
316The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
317 - K8S Bootstrap container:
318 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
319 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
320 - Configuration Binding Service:
321 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
322 - Description: HTTPS support, Image optimization and non-root user
323 - Inventory API
324 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
325 - Description: HTTPS support, container optmization and non-root user
326 - DataFile Collector
327 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
328 - Description : Code optimization, bug fixes, dmaap plugin integration
329 - SON Handler MS
330 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
331 - Description : Image optimization, bug fixes, CBS integration
332 - VES Adapter/Mapper MS
333 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
334 - Description : Image optimization & CBS periodic polling
335 - PRH MS
336 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
337 - Description : Code optimization, bug fixes and SDK alignment
338 - HV-VES MS
339 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
340 - Description : Code optimization, bug fixes and SDK alignment
341
342Version: 5.0.0
343--------------
344
345El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
346
347Following is summary of updates done for DCAEGEN2
348
349**Security**
350
351Following platform components were enabled for HTTPS
352 - ConfigBindingService (CBS)
353 - 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>`_
354 - Cloudify Manager
355 - InventoryAPI
356
357All components interfacing with platform components were modified to support TLS interface
358
359**Miscellaneous**
360 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
361 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200362 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100363 - CBS client libraries updated to remove consul service lookup
364
365
366
367**Bug Fixes**
368 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
369 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
370
371
372**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200373 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
374
Vijay VK09589ca2019-10-08 04:47:17 +0100375
376**Security Notes**
377
378*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400379
380*Known Security Issues*
381
382 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
383 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
384 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
385 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
386 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
387 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
388 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
389 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
390 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
391 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
392
393*Known Vulnerabilities in Used Modules*
394
395DCAE 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>`_.
396
397Quick Links:
398 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
399
400 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
401
402 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
403
404
405**Upgrade Notes**
406
407The following components are upgraded from Dublin/R4.
408 - Cloudify Manager:
409 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
410 - 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.
411 - K8S Bootstrap container:
412 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
413 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
414 - Configuration Binding Service:
415 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
416 - Description: HTTPS support, Image optimization and non-root user
417 - Deployment Handler
418 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
419 - Description: Update to node10, uninstall workflow updates
420 - Service Change Handler
421 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
422 - Description: HTTPS inventoryAPI support, container optmization and non-root user
423 - Inventory API
424 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
425 - Description: HTTPS support, container optmization and non-root user
426 - DataFile Collector
427 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
428 - Description : Code optimization, bug fixes, dmaap plugin integration
429 - 3gpp PM-Mapper
430 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
431 - Description: Code optimization, bug fixes, dmaap plugin integration
432
433
434
Vijay VK6b0fa462019-05-20 16:06:11 +0100435Version: 4.0.0
436--------------
437
438:Release Date: 2019-06-06
439
440**New Features**
441
442DCAE R4 improves upon previous release with the following new features:
443
444- DCAE Platform Enhancement
445 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
446 - Support helm chart deployment in DCAE using new Helm cloudify plugin
447 - DCAE Healthcheck enhancement to cover static and dynamic deployments
448 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
449 - Dashboard Integration (UI for deployment/verification)
450 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
451 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200452 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100453
454- Following new services are delivered with Dublin
455 - Collectors
456 - RESTConf collector 
457 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100458 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100459 - 3gpp PM-Mapper
460 - BBS Event processor
461 - Analytics/RCA
462 - SON-Handler
463 - Heartbeat MS
464
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200465Most 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 +0100466 - Platform components
467 - Cloudify Manager (helm chart)
468 - Bootstrap container (helm chart)
469 - Configuration Binding Service (helm chart)
470 - Deployment Handler (helm chart)
471 - Policy Handler (helm chart
472 - Service Change Handler (helm chart)
473 - Inventory API (helm chart)
474 - Dashboard (Cloudify Blueprint)
475 - Service components
476 - VES Collector
477 - SNMP Collector
478 - Threshold Crossing Analytics
479 - HV-VES Collector
480 - PNF-Registration Handler
481 - Holmes Rule Management *
482 - Holmes Engine Management *
483 - Additional resources that DCAE utilizes:
484 - Postgres Database
485 - Redis Cluster Database
486 - Consul Cluster *
487
488 Notes:
489 \* These components are delivered by the Holmes project.
490
491
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200492Under 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 +0100493
494- All DCAE components are designed to support platform maturity requirements.
495
496
497**Source Code**
498
499Source code of DCAE components are released under the following repositories on gerrit.onap.org:
500 - dcaegen2
501 - dcaegen2.analytics.tca
502 - dcaegen2.collectors.snmptrap
503 - dcaegen2.collectors.ves
504 - dcaegen2.collectors.hv-ves
505 - dcaegen2.collectors.datafile
506 - dcaegen2.collectors.restconf
507 - dcaegen2.deployments
508 - dcaegen2.platform.blueprints
509 - dcaegen2.platform.cli
510 - dcaegen2.platform.configbinding
511 - dcaegen2.platform.deployment-handler
512 - dcaegen2.platform.inventory-api
513 - dcaegen2.platform.plugins
514 - dcaegen2.platform.policy-handler
515 - dcaegen2.platform.servicechange-handler
516 - dcaegen2.services.heartbeat
517 - dcaegen2.services.mapper
518 - dcaegen2.services.pm-mapper
519 - dcaegen2.services.prh
520 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200521 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100522 - dcaegen2.services.sdk
523 - dcaegen2.utils
524 - ccsdk.platform.plugins
525 - ccsdk.dashboard
526
527**Bug Fixes**
528
529**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200530 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
531
Vijay VK6b0fa462019-05-20 16:06:11 +0100532
533**Security Notes**
534
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200535*Fixed Security Issues*
536
537*Known Security Issues*
538
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200539 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200540 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200541 * 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 +0200542 * 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 +0200543 * 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 +0200544 * 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 +0200545 * 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 +0200546 * 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 +0200547 * 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 +0200548 * 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 +0200549
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200550*Known Vulnerabilities in Used Modules*
551
Vijay VK6b0fa462019-05-20 16:06:11 +0100552DCAE 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>`_.
553
554Quick Links:
555 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
556
557 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
558
559 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
560
561
562**New component Notes**
563The following components are introduced in R4
564
565 - Dashboard
566 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
567 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
568 - Blueprint generator
569 - 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 +0200570 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100571 - RESTConf collector 
572 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
573 - Description: Provides RESTConf interfaces to events from external domain controllers
574 - VES/Universal Mapper
575 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200576 - 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 +0100577 - 3gpp PM-Mapper
578 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200579 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100580 - BBS Event processor
581 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200582 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100583 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100584 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200585 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100586 - Heartbeat MS
587 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
588 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200589
Vijay VK6b0fa462019-05-20 16:06:11 +0100590
591**Upgrade Notes**
592
593The following components are upgraded from R3
594 - Cloudify Manager:
595 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
596 - 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 +0200597 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100598 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200599 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
600 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100601 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
602 - Description: Code optimization and bug fixes
603 - Deployment Handler
604 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
605 - Include updates for health and service endpoint check and bug fixes
606 - Policy Handler
607 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
608 - Description: Policy Handler supports the new lifecycle API's from Policy framework
609 - Service Change Handler
610 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
611 - Description: No update from R3
612 - Inventory API
613 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
614 - Description: Refactoring and updates for health and service endpoint check
615 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +0100616 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200617 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100618 - Threshold Crossing Analytics
619 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
620 - 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.
621 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100622 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100623 - Description : Code optimization, bug fixes, logging and performance improvement
624 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100625 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200626 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100627 - HV-VES Collector
628 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
629 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
630 - SNMP Trap Collector
631 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200632 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100633
634
635
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500636
637Version: 3.0.1
638--------------
639
640:Release Date: 2019-01-31
641
642DCAE R3 Maintenance release includes following fixes
643
644**Bug Fixes**
645
646- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200647 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500648 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200649 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500650 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200651 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500652 Multiple Fileready notification not handled
653
654- HighVolume VES Collector (protobuf/tcp)
655 - DCAEGEN2-976
656 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
657
658- VESCollector (http)
659 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200660 Issue with VES batch event publish
661
662- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500663 - DCAEGEN2-1007
664 Removing obsolete services configuration
665
666
667The following containers are updated in R3.0.1
668
669 - DataFile Collector
670 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
671 - HV-VES Collector
672 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
673 - VES Collector
674 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
675
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500676**Known Issues**
677
678- 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
679
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200680- 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 +0100681 kubectl get deployments -n onap | grep deployment-handler
682 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
683 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
684
685
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500686
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500687
Vijay VK2648c6d2018-09-19 04:30:37 +0100688Version: 3.0.0
689--------------
690
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800691:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100692
693**New Features**
694
695DCAE R3 improves upon previous release with the following new features:
696
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200697- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100698 - Platform components
699 - Cloudify Manager
700 - Bootstrap container
701 - Configuration Binding Service
702 - Deployment Handler
703 - Policy Handler
704 - Service Change Handler
705 - Inventory API
706 - Service components
707 - VES Collector
708 - SNMP Collector
709 - Threshold Crossing Analytics
710 - Holmes Rule Management *
711 - Holmes Engine Management *
712 - Additional resources that DCAE utilizes:
713 - Postgres Database
714 - Redis Cluster Database
715 - Consul Cluster
716
717 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000718 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100719
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200720- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100721
722 - 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".
723 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
724
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200725- 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 +0100726
727- All DCAE components are designed to support platform maturity requirements.
728
729
730**Source Code**
731
732Source code of DCAE components are released under the following repositories on gerrit.onap.org:
733 - dcaegen2
734 - dcaegen2.analytics
735 - dcaegen2.analytics.tca
736 - dcaegen2.collectors
737 - dcaegen2.collectors.snmptrap
738 - dcaegen2.collectors.ves
739 - dcaegen2.collectors.hv-ves
740 - dcaegen2.collectors.datafile
741 - dcaegen2.deployments
742 - dcaegen2.platform
743 - dcaegen2.platform.blueprints
744 - dcaegen2.platform.cli
745 - dcaegen2.platform.configbinding
746 - dcaegen2.platform.deployment-handler
747 - dcaegen2.platform.inventory-api
748 - dcaegen2.platform.plugins
749 - dcaegen2.platform.policy-handler
750 - dcaegen2.platform.servicechange-handler
751 - dcaegen2.services.heartbeat
752 - dcaegen2.services.mapper
753 - dcaegen2.services.prh
754 - dcaegen2.utils
755
756**Bug Fixes**
757
758**Known Issues**
759
760- 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.
761
762**Security Notes**
763
764DCAE 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>`_.
765
766Quick Links:
767 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
768
769 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
770
Vijay VKab471f62018-11-26 17:49:43 +0000771 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100772
773
Vijay VKf6659fc2018-11-02 05:07:27 +0100774**New component Notes**
775The following components are introduced in R3
776
777 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000778 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100779 - Description : Bulk data file collector to fetch non-realtime PM data
780 - PNF Registrator handler
781 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200782 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100783 - HV-VES Collector
784 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
785 - Description : High Volume VES Collector for fetching real-time PM measurement data
786 - SNMP Trap Collector
787 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200788 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100789
Vijay VK2648c6d2018-09-19 04:30:37 +0100790
791**Upgrade Notes**
792
793The following components are upgraded from R2:
794 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100795 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100796 - 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 +0200797 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100798 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100799 - 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 +0200800 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100801 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
802 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
803 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100804 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100805 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100806 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100807 - Description: Policy Handler now supports the new configuration policy format and support for TLS
808 - Service Change Handler
809 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
810 - Description: Refactoring.
811 - Inventory API
812 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
813 - Description: Refactoring.
814 - VES Collector
815 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500816 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100817 - Threshold Crossing Analytics
818 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
819 - 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.
820
821
822
823
Lusheng Jib2a561b2018-03-27 23:24:33 -0400824Version: 2.0.0
825--------------
826
Gildas Lanilis82799c72018-05-30 13:22:48 -0700827:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400828
829**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400830
Lusheng Jib2a561b2018-03-27 23:24:33 -0400831DCAE R2 improves upon previous release with the following new features:
832
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200833- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400834 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400835 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400836 - Bootstrap container
837 - Configuration Binding Service
838 - Deployment Handler
839 - Policy Handler
840 - Service Change Handler
841 - Inventory API
842 - Service components
843 - VES Collector
844 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400845 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400846 - Holmes Rule Management *
847 - Holmes Engine Management *
848 - Additional resources that DCAE utilizes:
849 - Postgres Database
850 - Redis Cluster Database
851 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400852
Lusheng Ji768421b2018-06-01 16:36:54 -0400853 Notes:
854 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400855
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200856- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400857
Lusheng Ji768421b2018-06-01 16:36:54 -0400858 - 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 -0400859 - 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 -0400860
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200861- 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 -0400862
863- All DCAE components are designed to support platform maturity requirements.
864
865
866**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400867
868Source code of DCAE components are released under the following repositories on gerrit.onap.org:
869 - dcaegen2
870 - dcaegen2.analytics
871 - dcaegen2.analytics.tca
872 - dcaegen2.collectors
873 - dcaegen2.collectors.snmptrap
874 - dcaegen2.collectors.ves
875 - dcaegen2.deployments
876 - dcaegen2.platform
877 - dcaegen2.platform.blueprints
878 - dcaegen2.platform.cli
879 - dcaegen2.platform.configbinding
880 - dcaegen2.platform.deployment-handler
881 - dcaegen2.platform.inventory-api
882 - dcaegen2.platform.plugins
883 - dcaegen2.platform.policy-handler
884 - dcaegen2.platform.servicechange-handler
885 - dcaegen2.services.heartbeat
886 - dcaegen2.services.mapper
887 - dcaegen2.services.prh
888 - dcaegen2.utils
889
890**Bug Fixes**
891
892**Known Issues**
893
Lusheng Ji768421b2018-06-01 16:36:54 -0400894- 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.
895
Gildas Lanilis82799c72018-05-30 13:22:48 -0700896**Security Notes**
897
898DCAE 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>`_.
899
900Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400901 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
902
903 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
904
905 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
906
907
Lusheng Jib2a561b2018-03-27 23:24:33 -0400908
909**Upgrade Notes**
910
Lusheng Ji768421b2018-06-01 16:36:54 -0400911The following components are upgraded from R1:
912 - Cloudify Manager:
913 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
914 - 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 +0200915 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400916 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400917 - 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 +0200918 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400919 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
920 - Description: Configuration Binding Sevice now supports the new configuration policy format.
921 - Deployment Handler
922 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
923 - Policy Handler
924 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
925 - Description: Policy Handler now supports the new configuration policy format.
926 - Service Change Handler
927 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
928 - Description: Refactoring.
929 - Inventory API
930 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
931 - Description: Refactoring.
932 - VES Collector
933 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
934 - Threshold Crossing Analytics
935 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
936 - 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.
937
Lusheng Jib2a561b2018-03-27 23:24:33 -0400938
939
Lusheng Ji8fafa432017-11-06 21:52:26 -0500940Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000941--------------
942
Lusheng Ji8fafa432017-11-06 21:52:26 -0500943:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000944
945
946**New Features**
947
Lusheng Ji8fafa432017-11-06 21:52:26 -0500948DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
949sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
950DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
951vDNS, vCPU, and vVoLTE.
952
953Specifically, DCAE R1 includes the following components:
954
955- Core platform
956 - Cloudify manager
957 - Consul cluster
958- Extended platform
959 - Platform component docker host
960 - Service component docker host
961 - CDAP cluster
962 - PostgreSQL database (*)
963- Platform docker container components
964 - Configuration binding service
965 - Deployment handler
966 - Service change handler
967 - Inventory
968 - Policy handler
969 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200970- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500971 - Docker container components
972 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000973 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500974 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000975 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500976
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200977(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
978VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500979other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200980(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500981in R1.
982
983Source codes of DCAE are released under the following repositories on gerrit.onap.org:
984
985- dcaegen2
986- dcaegen2/analytics
987- dcaegen2/analytics/tca
988- dcaegen2/collectors
989- dcaegen2/collectors/snmptrap
990- dcaegen2/collectors/ves
991- dcaegen2/deployments
992- dcaegen2/platform
993- dcaegen2/platform/blueprints
994- dcaegen2/platform/cdapbroker
995- dcaegen2/platform/cli
996- dcaegen2/platform/configbinding
997- dcaegen2/platform/deployment-handler
998- dcaegen2/platform/inventory-api
999- dcaegen2/platform/plugins
1000- dcaegen2/platform/policy-handler
1001- dcaegen2/platform/servicechange-handler
1002- dcaegen2/utils
1003
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001004
1005**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001006
1007This is the initial release.
1008
1009
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001010**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001011
1012- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1013- Need to provide a dev configuration DCAE.
1014
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001015
1016**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001017
ankatare30c4cb42018-09-28 14:26:59 +05301018- 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 -04001019- 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.
1020
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001021
1022**Upgrade Notes**
1023
Lusheng Ji8fafa432017-11-06 21:52:26 -05001024This is the initial release.
1025
1026
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001027**Deprecation Notes**
1028
Lusheng Ji8fafa432017-11-06 21:52:26 -05001029There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1030DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1031following Gerrit repos are voided and already locked as read-only.
1032
1033- dcae
1034- dcae/apod
1035- dcae/apod/analytics
1036- dcae/apod/buildtools
1037- dcae/apod/cdap
1038- dcae/collectors
1039- dcae/collectors/ves
1040- dcae/controller
1041- dcae/controller/analytics
1042- dcae/dcae-inventory
1043- dcae/demo
1044- dcae/demo/startup
1045- dcae/demo/startup/aaf
1046- dcae/demo/startup/controller
1047- dcae/demo/startup/message-router
1048- dcae/dmaapbc
1049- dcae/operation
1050- dcae/operation/utils
1051- dcae/orch-dispatcher
1052- dcae/pgaas
1053- dcae/utils
1054- dcae/utils/buildtools
1055- ncomp
1056- ncomp/cdap
1057- ncomp/core
1058- ncomp/docker
1059- ncomp/maven
1060- ncomp/openstack
1061- ncomp/sirius
1062- ncomp/sirius/manager
1063- ncomp/utils
1064
1065
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001066**Other**
1067
Vijay0fbc6732017-11-08 13:55:01 +00001068SNMP trap collector is seed code delivery only.