blob: 849cd7b790daefa078d728df909e370ec9b145cf [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.
Aric Gardner9fc74a62020-04-09 10:51:40 -07004.. _release_notes:
Lusheng Ji72c4fba2017-10-10 18:12:22 +00005
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -04006DCAE Release Notes
7==================
Lusheng Ji72c4fba2017-10-10 18:12:22 +00008
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -04009Abstract
10--------
11This document provides the release notes for the Frankfurt release (6.0.0)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040012
13
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -040014Summary
15-------
16
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040017**New Features**
18
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -040019DCAE improves upon previous release with the following new features:
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040020
21- DCAE Platform Enhancement
22 - Introduction of Microservice and Onboarding Design (MOD) platform
23 - Policy Notification support for DCAE components
24 - Dynamic AAF certificate creation during component instantiation
25 - Helm chart optimization to control each platform component separate
26 - Dashboard Optimization
27 - Blueprint generator tool to simplify deployment artifact creation
28
29
30- Following new services are delivered with Frankfurt
31 - Event Processors
32 - PM Subscription Handler
33 - DataLake Handlers
34 - Analytics/RCA
35 - TCA-GEN2
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040036 - Acumos Adapter (PoC)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040037
38Following is complete list of DCAE components available part of default ONAP/DCAE installation.
39 - Platform components
40 - Cloudify Manager (helm chart)
41 - Bootstrap container (helm chart)
42 - Configuration Binding Service (helm chart)
43 - Deployment Handler (helm chart)
44 - Policy Handler (helm chart
45 - Service Change Handler (helm chart)
46 - Inventory API (helm chart)
47 - Dashboard (helm chart)
48 - Service components
49 - VES Collector
50 - Threshold Crossing Analytics (TCA/CDAP)
51 - HV-VES Collector
52 - PNF-Registration Handler
53 - Docker based Threshold Crossing Analytics (TCA-Gen2)
54 - Holmes Rule Management *
55 - Holmes Engine Management *
56 - Additional resources that DCAE utilizes deployed using ONAP common charts:
57 - Postgres Database
58 - Mongo Database
59 - Redis Cluster Database
60 - Consul Cluster
61
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040062Following are service components (mS) which can be deployed on-demand
63 - SNMPTrap Collector
64 - RESTConf Collector
65 - DataFile Collector
66 - PM-Mapper
67 - BBS-EventProcessor
68 - VES Mapper
69 - Heartbeat mS
70 - SON-Handler
71 - PM-Subscription Handler
72
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040073 Notes:
74 \* These components are delivered by the Holmes project.
75
76
77
78Under 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.
79
80
81- All DCAE components are designed to support platform maturity requirements.
82
83
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040084**Bug Fixes**
85
86**Known Issues**
87 * Blueprint generator issue (DCAEGEN2-2140)
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -040088 * TCAgen2 Policy configuration support (DCAEGEN2-2198)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040089
90
91**Security Notes**
92
93*Fixed Security Issues*
94
95 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
96 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
97 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
98 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
99 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400100
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400101
102*Known Security Issues*
103
104 None
105
106
107*Known Vulnerabilities in Used Modules*
108
109 None
110
111DCAE 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>`_.
112
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400113
114Artifacts released:
115
116.. csv-table::
117 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
118 :widths: auto
119
120 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
121 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
122 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
123 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
124 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
125 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
126 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
127 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
128 "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 -0400129 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400130 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
131 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
132 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
133 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
134 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
135 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
136 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
137 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
138 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
139 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400140 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
141 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.5"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400142 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
143 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
144 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
145 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
146 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400147 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
148 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400149 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
150 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
151 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
152 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
153 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
154 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
155 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.0"
156 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.1"
157 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
158 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
159 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
160
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400161**Test Results**
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400162
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400163 - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
164 - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
165
166
167**References**
168 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
169 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400170
Vijay VK09589ca2019-10-08 04:47:17 +0100171Version: 5.0.1
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400172--------------
173
Vijay VK09589ca2019-10-08 04:47:17 +0100174The 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 -0400175
176Following is summary of updates done for DCAEGEN2
177
178**Security**
179
180Following platform components were enabled for HTTPS
181 - ConfigBindingService (CBS)
182 - 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>`_
183 - Cloudify Manager
184 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100185 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400186
187All components interfacing with platform components were modified to support TLS interface
188
189**Miscellaneous**
190 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
191 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200192 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400193 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200194 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100195
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400196
197
198With 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.
199 - Platform components
200 - Cloudify Manager (helm chart)
201 - Bootstrap container (helm chart)
202 - Configuration Binding Service (helm chart)
203 - Deployment Handler (helm chart)
204 - Policy Handler (helm chart
205 - Service Change Handler (helm chart)
206 - Inventory API (helm chart)
207 - Dashboard (helm charts)
208 - Service components
209 - VES Collector
210 - SNMP Collector
211 - Threshold Crossing Analytics
212 - HV-VES Collector
213 - PNF-Registration Handler
214 - Holmes Rule Management *
215 - Holmes Engine Management *
216 - Additional resources that DCAE utilizes:
217 - Postgres Database
218 - Redis Cluster Database
219 - Consul Cluster *
220
221 Notes:
222 \* These components are delivered by external ONAP project.
223
224DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
225
226 - Collectors
227 - RESTConf collector 
228 - DataFile collector
229 - Event Processors
230 - VES Mapper
231 - 3gpp PM-Mapper
232 - BBS Event processor
233 - Analytics/RCA
234 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200235 - Missing Heartbeat Ms
236
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400237- All DCAE components are designed to support platform maturity requirements.
238
239
240**Source Code**
241
242Source 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.
243 - dcaegen2
244 - dcaegen2.analytics.tca
245 - dcaegen2.collectors.snmptrap
246 - dcaegen2.collectors.ves
247 - dcaegen2.collectors.hv-ves
248 - dcaegen2.collectors.datafile
249 - dcaegen2.collectors.restconf
250 - dcaegen2.deployments
251 - dcaegen2.platform.blueprints
252 - dcaegen2.platform.cli
253 - dcaegen2.platform.configbinding
254 - dcaegen2.platform.deployment-handler
255 - dcaegen2.platform.inventory-api
256 - dcaegen2.platform.plugins
257 - dcaegen2.platform.policy-handler
258 - dcaegen2.platform.servicechange-handler
259 - dcaegen2.services.heartbeat
260 - dcaegen2.services.mapper
261 - dcaegen2.services.pm-mapper
262 - dcaegen2.services.prh
263 - dcaegen2.services.son-handler
264 - dcaegen2.services
265 - dcaegen2.services.sdk
266 - dcaegen2.utils
267 - ccsdk.platform.plugins
268 - ccsdk.dashboard
269
270**Bug Fixes**
271 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
272 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
273
274
275**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200276 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
277
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400278**Security Notes**
279
280*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200281 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100282 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
283 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
284 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
285 * 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 +0100286
287*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100288 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
289 * 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 +0100290 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
291 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
292 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
293
294*Known Vulnerabilities in Used Modules*
295
296DCAE 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>`_.
297
298Quick Links:
299 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
300
301 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
302
303 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
304
305
306**Upgrade Notes**
307
308The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
309 - K8S Bootstrap container:
310 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
311 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
312 - Configuration Binding Service:
313 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
314 - Description: HTTPS support, Image optimization and non-root user
315 - Inventory API
316 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
317 - Description: HTTPS support, container optmization and non-root user
318 - DataFile Collector
319 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
320 - Description : Code optimization, bug fixes, dmaap plugin integration
321 - SON Handler MS
322 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
323 - Description : Image optimization, bug fixes, CBS integration
324 - VES Adapter/Mapper MS
325 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
326 - Description : Image optimization & CBS periodic polling
327 - PRH MS
328 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
329 - Description : Code optimization, bug fixes and SDK alignment
330 - HV-VES MS
331 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
332 - Description : Code optimization, bug fixes and SDK alignment
333
334Version: 5.0.0
335--------------
336
337El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
338
339Following is summary of updates done for DCAEGEN2
340
341**Security**
342
343Following platform components were enabled for HTTPS
344 - ConfigBindingService (CBS)
345 - 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>`_
346 - Cloudify Manager
347 - InventoryAPI
348
349All components interfacing with platform components were modified to support TLS interface
350
351**Miscellaneous**
352 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
353 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200354 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100355 - CBS client libraries updated to remove consul service lookup
356
357
358
359**Bug Fixes**
360 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
361 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
362
363
364**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200365 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
366
Vijay VK09589ca2019-10-08 04:47:17 +0100367
368**Security Notes**
369
370*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400371
372*Known Security Issues*
373
374 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
375 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
376 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
377 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
378 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
379 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
380 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
381 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
382 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
383 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
384
385*Known Vulnerabilities in Used Modules*
386
387DCAE 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>`_.
388
389Quick Links:
390 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
391
392 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
393
394 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
395
396
397**Upgrade Notes**
398
399The following components are upgraded from Dublin/R4.
400 - Cloudify Manager:
401 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
402 - 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.
403 - K8S Bootstrap container:
404 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
405 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
406 - Configuration Binding Service:
407 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
408 - Description: HTTPS support, Image optimization and non-root user
409 - Deployment Handler
410 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
411 - Description: Update to node10, uninstall workflow updates
412 - Service Change Handler
413 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
414 - Description: HTTPS inventoryAPI support, container optmization and non-root user
415 - Inventory API
416 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
417 - Description: HTTPS support, container optmization and non-root user
418 - DataFile Collector
419 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
420 - Description : Code optimization, bug fixes, dmaap plugin integration
421 - 3gpp PM-Mapper
422 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
423 - Description: Code optimization, bug fixes, dmaap plugin integration
424
425
426
Vijay VK6b0fa462019-05-20 16:06:11 +0100427Version: 4.0.0
428--------------
429
430:Release Date: 2019-06-06
431
432**New Features**
433
434DCAE R4 improves upon previous release with the following new features:
435
436- DCAE Platform Enhancement
437 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
438 - Support helm chart deployment in DCAE using new Helm cloudify plugin
439 - DCAE Healthcheck enhancement to cover static and dynamic deployments
440 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
441 - Dashboard Integration (UI for deployment/verification)
442 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
443 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200444 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100445
446- Following new services are delivered with Dublin
447 - Collectors
448 - RESTConf collector 
449 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100450 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100451 - 3gpp PM-Mapper
452 - BBS Event processor
453 - Analytics/RCA
454 - SON-Handler
455 - Heartbeat MS
456
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200457Most 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 +0100458 - Platform components
459 - Cloudify Manager (helm chart)
460 - Bootstrap container (helm chart)
461 - Configuration Binding Service (helm chart)
462 - Deployment Handler (helm chart)
463 - Policy Handler (helm chart
464 - Service Change Handler (helm chart)
465 - Inventory API (helm chart)
466 - Dashboard (Cloudify Blueprint)
467 - Service components
468 - VES Collector
469 - SNMP Collector
470 - Threshold Crossing Analytics
471 - HV-VES Collector
472 - PNF-Registration Handler
473 - Holmes Rule Management *
474 - Holmes Engine Management *
475 - Additional resources that DCAE utilizes:
476 - Postgres Database
477 - Redis Cluster Database
478 - Consul Cluster *
479
480 Notes:
481 \* These components are delivered by the Holmes project.
482
483
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200484Under 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 +0100485
486- All DCAE components are designed to support platform maturity requirements.
487
488
489**Source Code**
490
491Source code of DCAE components are released under the following repositories on gerrit.onap.org:
492 - dcaegen2
493 - dcaegen2.analytics.tca
494 - dcaegen2.collectors.snmptrap
495 - dcaegen2.collectors.ves
496 - dcaegen2.collectors.hv-ves
497 - dcaegen2.collectors.datafile
498 - dcaegen2.collectors.restconf
499 - dcaegen2.deployments
500 - dcaegen2.platform.blueprints
501 - dcaegen2.platform.cli
502 - dcaegen2.platform.configbinding
503 - dcaegen2.platform.deployment-handler
504 - dcaegen2.platform.inventory-api
505 - dcaegen2.platform.plugins
506 - dcaegen2.platform.policy-handler
507 - dcaegen2.platform.servicechange-handler
508 - dcaegen2.services.heartbeat
509 - dcaegen2.services.mapper
510 - dcaegen2.services.pm-mapper
511 - dcaegen2.services.prh
512 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200513 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100514 - dcaegen2.services.sdk
515 - dcaegen2.utils
516 - ccsdk.platform.plugins
517 - ccsdk.dashboard
518
519**Bug Fixes**
520
521**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200522 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
523
Vijay VK6b0fa462019-05-20 16:06:11 +0100524
525**Security Notes**
526
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200527*Fixed Security Issues*
528
529*Known Security Issues*
530
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200531 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200532 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200533 * 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 +0200534 * 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 +0200535 * 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 +0200536 * 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 +0200537 * 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 +0200538 * 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 +0200539 * 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 +0200540 * 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 +0200541
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200542*Known Vulnerabilities in Used Modules*
543
Vijay VK6b0fa462019-05-20 16:06:11 +0100544DCAE 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>`_.
545
546Quick Links:
547 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
548
549 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
550
551 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
552
553
554**New component Notes**
555The following components are introduced in R4
556
557 - Dashboard
558 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
559 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
560 - Blueprint generator
561 - 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 +0200562 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100563 - RESTConf collector 
564 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
565 - Description: Provides RESTConf interfaces to events from external domain controllers
566 - VES/Universal Mapper
567 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200568 - 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 +0100569 - 3gpp PM-Mapper
570 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200571 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100572 - BBS Event processor
573 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200574 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100575 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100576 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200577 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100578 - Heartbeat MS
579 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
580 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200581
Vijay VK6b0fa462019-05-20 16:06:11 +0100582
583**Upgrade Notes**
584
585The following components are upgraded from R3
586 - Cloudify Manager:
587 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
588 - 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 +0200589 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100590 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200591 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
592 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100593 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
594 - Description: Code optimization and bug fixes
595 - Deployment Handler
596 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
597 - Include updates for health and service endpoint check and bug fixes
598 - Policy Handler
599 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
600 - Description: Policy Handler supports the new lifecycle API's from Policy framework
601 - Service Change Handler
602 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
603 - Description: No update from R3
604 - Inventory API
605 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
606 - Description: Refactoring and updates for health and service endpoint check
607 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +0100608 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200609 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100610 - Threshold Crossing Analytics
611 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
612 - 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.
613 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100614 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100615 - Description : Code optimization, bug fixes, logging and performance improvement
616 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100617 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200618 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100619 - HV-VES Collector
620 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
621 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
622 - SNMP Trap Collector
623 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200624 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100625
626
627
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500628
629Version: 3.0.1
630--------------
631
632:Release Date: 2019-01-31
633
634DCAE R3 Maintenance release includes following fixes
635
636**Bug Fixes**
637
638- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200639 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500640 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200641 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500642 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200643 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500644 Multiple Fileready notification not handled
645
646- HighVolume VES Collector (protobuf/tcp)
647 - DCAEGEN2-976
648 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
649
650- VESCollector (http)
651 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200652 Issue with VES batch event publish
653
654- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500655 - DCAEGEN2-1007
656 Removing obsolete services configuration
657
658
659The following containers are updated in R3.0.1
660
661 - DataFile Collector
662 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
663 - HV-VES Collector
664 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
665 - VES Collector
666 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
667
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500668**Known Issues**
669
670- 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
671
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200672- 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 +0100673 kubectl get deployments -n onap | grep deployment-handler
674 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
675 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
676
677
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500678
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500679
Vijay VK2648c6d2018-09-19 04:30:37 +0100680Version: 3.0.0
681--------------
682
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800683:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100684
685**New Features**
686
687DCAE R3 improves upon previous release with the following new features:
688
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200689- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100690 - Platform components
691 - Cloudify Manager
692 - Bootstrap container
693 - Configuration Binding Service
694 - Deployment Handler
695 - Policy Handler
696 - Service Change Handler
697 - Inventory API
698 - Service components
699 - VES Collector
700 - SNMP Collector
701 - Threshold Crossing Analytics
702 - Holmes Rule Management *
703 - Holmes Engine Management *
704 - Additional resources that DCAE utilizes:
705 - Postgres Database
706 - Redis Cluster Database
707 - Consul Cluster
708
709 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000710 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100711
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200712- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100713
714 - 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".
715 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
716
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200717- 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 +0100718
719- All DCAE components are designed to support platform maturity requirements.
720
721
722**Source Code**
723
724Source code of DCAE components are released under the following repositories on gerrit.onap.org:
725 - dcaegen2
726 - dcaegen2.analytics
727 - dcaegen2.analytics.tca
728 - dcaegen2.collectors
729 - dcaegen2.collectors.snmptrap
730 - dcaegen2.collectors.ves
731 - dcaegen2.collectors.hv-ves
732 - dcaegen2.collectors.datafile
733 - dcaegen2.deployments
734 - dcaegen2.platform
735 - dcaegen2.platform.blueprints
736 - dcaegen2.platform.cli
737 - dcaegen2.platform.configbinding
738 - dcaegen2.platform.deployment-handler
739 - dcaegen2.platform.inventory-api
740 - dcaegen2.platform.plugins
741 - dcaegen2.platform.policy-handler
742 - dcaegen2.platform.servicechange-handler
743 - dcaegen2.services.heartbeat
744 - dcaegen2.services.mapper
745 - dcaegen2.services.prh
746 - dcaegen2.utils
747
748**Bug Fixes**
749
750**Known Issues**
751
752- 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.
753
754**Security Notes**
755
756DCAE 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>`_.
757
758Quick Links:
759 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
760
761 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
762
Vijay VKab471f62018-11-26 17:49:43 +0000763 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100764
765
Vijay VKf6659fc2018-11-02 05:07:27 +0100766**New component Notes**
767The following components are introduced in R3
768
769 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000770 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100771 - Description : Bulk data file collector to fetch non-realtime PM data
772 - PNF Registrator handler
773 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200774 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100775 - HV-VES Collector
776 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
777 - Description : High Volume VES Collector for fetching real-time PM measurement data
778 - SNMP Trap Collector
779 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200780 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100781
Vijay VK2648c6d2018-09-19 04:30:37 +0100782
783**Upgrade Notes**
784
785The following components are upgraded from R2:
786 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100787 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100788 - 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 +0200789 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100790 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100791 - 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 +0200792 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100793 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
794 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
795 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100796 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100797 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100798 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100799 - Description: Policy Handler now supports the new configuration policy format and support for TLS
800 - Service Change Handler
801 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
802 - Description: Refactoring.
803 - Inventory API
804 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
805 - Description: Refactoring.
806 - VES Collector
807 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500808 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100809 - Threshold Crossing Analytics
810 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
811 - 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.
812
813
814
815
Lusheng Jib2a561b2018-03-27 23:24:33 -0400816Version: 2.0.0
817--------------
818
Gildas Lanilis82799c72018-05-30 13:22:48 -0700819:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400820
821**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400822
Lusheng Jib2a561b2018-03-27 23:24:33 -0400823DCAE R2 improves upon previous release with the following new features:
824
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200825- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400826 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400827 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400828 - Bootstrap container
829 - Configuration Binding Service
830 - Deployment Handler
831 - Policy Handler
832 - Service Change Handler
833 - Inventory API
834 - Service components
835 - VES Collector
836 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400837 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400838 - Holmes Rule Management *
839 - Holmes Engine Management *
840 - Additional resources that DCAE utilizes:
841 - Postgres Database
842 - Redis Cluster Database
843 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400844
Lusheng Ji768421b2018-06-01 16:36:54 -0400845 Notes:
846 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400847
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200848- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400849
Lusheng Ji768421b2018-06-01 16:36:54 -0400850 - 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 -0400851 - 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 -0400852
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200853- 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 -0400854
855- All DCAE components are designed to support platform maturity requirements.
856
857
858**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400859
860Source code of DCAE components are released under the following repositories on gerrit.onap.org:
861 - dcaegen2
862 - dcaegen2.analytics
863 - dcaegen2.analytics.tca
864 - dcaegen2.collectors
865 - dcaegen2.collectors.snmptrap
866 - dcaegen2.collectors.ves
867 - dcaegen2.deployments
868 - dcaegen2.platform
869 - dcaegen2.platform.blueprints
870 - dcaegen2.platform.cli
871 - dcaegen2.platform.configbinding
872 - dcaegen2.platform.deployment-handler
873 - dcaegen2.platform.inventory-api
874 - dcaegen2.platform.plugins
875 - dcaegen2.platform.policy-handler
876 - dcaegen2.platform.servicechange-handler
877 - dcaegen2.services.heartbeat
878 - dcaegen2.services.mapper
879 - dcaegen2.services.prh
880 - dcaegen2.utils
881
882**Bug Fixes**
883
884**Known Issues**
885
Lusheng Ji768421b2018-06-01 16:36:54 -0400886- 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.
887
Gildas Lanilis82799c72018-05-30 13:22:48 -0700888**Security Notes**
889
890DCAE 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>`_.
891
892Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400893 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
894
895 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
896
897 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
898
899
Lusheng Jib2a561b2018-03-27 23:24:33 -0400900
901**Upgrade Notes**
902
Lusheng Ji768421b2018-06-01 16:36:54 -0400903The following components are upgraded from R1:
904 - Cloudify Manager:
905 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
906 - 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 +0200907 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400908 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400909 - 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 +0200910 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400911 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
912 - Description: Configuration Binding Sevice now supports the new configuration policy format.
913 - Deployment Handler
914 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
915 - Policy Handler
916 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
917 - Description: Policy Handler now supports the new configuration policy format.
918 - Service Change Handler
919 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
920 - Description: Refactoring.
921 - Inventory API
922 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
923 - Description: Refactoring.
924 - VES Collector
925 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
926 - Threshold Crossing Analytics
927 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
928 - 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.
929
Lusheng Jib2a561b2018-03-27 23:24:33 -0400930
931
Lusheng Ji8fafa432017-11-06 21:52:26 -0500932Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000933--------------
934
Lusheng Ji8fafa432017-11-06 21:52:26 -0500935:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000936
937
938**New Features**
939
Lusheng Ji8fafa432017-11-06 21:52:26 -0500940DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
941sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
942DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
943vDNS, vCPU, and vVoLTE.
944
945Specifically, DCAE R1 includes the following components:
946
947- Core platform
948 - Cloudify manager
949 - Consul cluster
950- Extended platform
951 - Platform component docker host
952 - Service component docker host
953 - CDAP cluster
954 - PostgreSQL database (*)
955- Platform docker container components
956 - Configuration binding service
957 - Deployment handler
958 - Service change handler
959 - Inventory
960 - Policy handler
961 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200962- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500963 - Docker container components
964 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000965 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500966 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000967 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500968
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200969(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
970VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500971other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200972(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500973in R1.
974
975Source codes of DCAE are released under the following repositories on gerrit.onap.org:
976
977- dcaegen2
978- dcaegen2/analytics
979- dcaegen2/analytics/tca
980- dcaegen2/collectors
981- dcaegen2/collectors/snmptrap
982- dcaegen2/collectors/ves
983- dcaegen2/deployments
984- dcaegen2/platform
985- dcaegen2/platform/blueprints
986- dcaegen2/platform/cdapbroker
987- dcaegen2/platform/cli
988- dcaegen2/platform/configbinding
989- dcaegen2/platform/deployment-handler
990- dcaegen2/platform/inventory-api
991- dcaegen2/platform/plugins
992- dcaegen2/platform/policy-handler
993- dcaegen2/platform/servicechange-handler
994- dcaegen2/utils
995
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000996
997**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500998
999This is the initial release.
1000
1001
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001002**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001003
1004- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1005- Need to provide a dev configuration DCAE.
1006
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001007
1008**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001009
ankatare30c4cb42018-09-28 14:26:59 +05301010- 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 -04001011- 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.
1012
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001013
1014**Upgrade Notes**
1015
Lusheng Ji8fafa432017-11-06 21:52:26 -05001016This is the initial release.
1017
1018
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001019**Deprecation Notes**
1020
Lusheng Ji8fafa432017-11-06 21:52:26 -05001021There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1022DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1023following Gerrit repos are voided and already locked as read-only.
1024
1025- dcae
1026- dcae/apod
1027- dcae/apod/analytics
1028- dcae/apod/buildtools
1029- dcae/apod/cdap
1030- dcae/collectors
1031- dcae/collectors/ves
1032- dcae/controller
1033- dcae/controller/analytics
1034- dcae/dcae-inventory
1035- dcae/demo
1036- dcae/demo/startup
1037- dcae/demo/startup/aaf
1038- dcae/demo/startup/controller
1039- dcae/demo/startup/message-router
1040- dcae/dmaapbc
1041- dcae/operation
1042- dcae/operation/utils
1043- dcae/orch-dispatcher
1044- dcae/pgaas
1045- dcae/utils
1046- dcae/utils/buildtools
1047- ncomp
1048- ncomp/cdap
1049- ncomp/core
1050- ncomp/docker
1051- ncomp/maven
1052- ncomp/openstack
1053- ncomp/sirius
1054- ncomp/sirius/manager
1055- ncomp/utils
1056
1057
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001058**Other**
1059
Vijay0fbc6732017-11-08 13:55:01 +00001060SNMP trap collector is seed code delivery only.