blob: 33b42815f0683f8196340714685e7ba4146fd03e [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
6Release Notes
7=============
8
VENKATESH KUMARcfb11092020-04-02 12:27:00 -04009Version: 6.0.0
10--------------
11
12
13**New Features**
14
15DCAE R6 improves upon previous release with the following new features:
16
17- DCAE Platform Enhancement
18 - Introduction of Microservice and Onboarding Design (MOD) platform
19 - Policy Notification support for DCAE components
20 - Dynamic AAF certificate creation during component instantiation
21 - Helm chart optimization to control each platform component separate
22 - Dashboard Optimization
23 - Blueprint generator tool to simplify deployment artifact creation
24
25
26- Following new services are delivered with Frankfurt
27 - Event Processors
28 - PM Subscription Handler
29 - DataLake Handlers
30 - Analytics/RCA
31 - TCA-GEN2
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040032 - Acumos Adapter (PoC)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040033
34Following is complete list of DCAE components available part of default ONAP/DCAE installation.
35 - Platform components
36 - Cloudify Manager (helm chart)
37 - Bootstrap container (helm chart)
38 - Configuration Binding Service (helm chart)
39 - Deployment Handler (helm chart)
40 - Policy Handler (helm chart
41 - Service Change Handler (helm chart)
42 - Inventory API (helm chart)
43 - Dashboard (helm chart)
44 - Service components
45 - VES Collector
46 - Threshold Crossing Analytics (TCA/CDAP)
47 - HV-VES Collector
48 - PNF-Registration Handler
49 - Docker based Threshold Crossing Analytics (TCA-Gen2)
50 - Holmes Rule Management *
51 - Holmes Engine Management *
52 - Additional resources that DCAE utilizes deployed using ONAP common charts:
53 - Postgres Database
54 - Mongo Database
55 - Redis Cluster Database
56 - Consul Cluster
57
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -040058Following are service components (mS) which can be deployed on-demand
59 - SNMPTrap Collector
60 - RESTConf Collector
61 - DataFile Collector
62 - PM-Mapper
63 - BBS-EventProcessor
64 - VES Mapper
65 - Heartbeat mS
66 - SON-Handler
67 - PM-Subscription Handler
68
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040069 Notes:
70 \* These components are delivered by the Holmes project.
71
72
73
74Under 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.
75
76
77- All DCAE components are designed to support platform maturity requirements.
78
79
VENKATESH KUMARcfb11092020-04-02 12:27:00 -040080**Bug Fixes**
81
82**Known Issues**
83 * Blueprint generator issue (DCAEGEN2-2140)
84
85
86**Security Notes**
87
88*Fixed Security Issues*
89
90 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
91 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
92 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
93 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
94 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
95
96*Known Security Issues*
97
98 None
99
100
101*Known Vulnerabilities in Used Modules*
102
103 None
104
105DCAE 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>`_.
106
107Quick Links:
108 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
109
110 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
111
112Artifacts released:
113
114.. csv-table::
115 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
116 :widths: auto
117
118 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
119 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
120 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
121 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
122 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
123 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
124 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
125 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
126 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
127 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.0"
128 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
129 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
130 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
131 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
132 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
133 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
134 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
135 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
136 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
137 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
138 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.1"
139 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.4"
140 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
141 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
142 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
143 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
144 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
145 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.0"
146 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.1"
147 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
148 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
149 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
150 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
151 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
152 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
153 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.0"
154 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.1"
155 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
156 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
157 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
158
159
160
Vijay VK09589ca2019-10-08 04:47:17 +0100161Version: 5.0.1
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400162--------------
163
Vijay VK09589ca2019-10-08 04:47:17 +0100164The 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 -0400165
166Following is summary of updates done for DCAEGEN2
167
168**Security**
169
170Following platform components were enabled for HTTPS
171 - ConfigBindingService (CBS)
172 - 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>`_
173 - Cloudify Manager
174 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100175 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400176
177All components interfacing with platform components were modified to support TLS interface
178
179**Miscellaneous**
180 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
181 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200182 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400183 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200184 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100185
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400186
187
188With 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.
189 - Platform components
190 - Cloudify Manager (helm chart)
191 - Bootstrap container (helm chart)
192 - Configuration Binding Service (helm chart)
193 - Deployment Handler (helm chart)
194 - Policy Handler (helm chart
195 - Service Change Handler (helm chart)
196 - Inventory API (helm chart)
197 - Dashboard (helm charts)
198 - Service components
199 - VES Collector
200 - SNMP Collector
201 - Threshold Crossing Analytics
202 - HV-VES Collector
203 - PNF-Registration Handler
204 - Holmes Rule Management *
205 - Holmes Engine Management *
206 - Additional resources that DCAE utilizes:
207 - Postgres Database
208 - Redis Cluster Database
209 - Consul Cluster *
210
211 Notes:
212 \* These components are delivered by external ONAP project.
213
214DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
215
216 - Collectors
217 - RESTConf collector 
218 - DataFile collector
219 - Event Processors
220 - VES Mapper
221 - 3gpp PM-Mapper
222 - BBS Event processor
223 - Analytics/RCA
224 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200225 - Missing Heartbeat Ms
226
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400227- All DCAE components are designed to support platform maturity requirements.
228
229
230**Source Code**
231
232Source 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.
233 - dcaegen2
234 - dcaegen2.analytics.tca
235 - dcaegen2.collectors.snmptrap
236 - dcaegen2.collectors.ves
237 - dcaegen2.collectors.hv-ves
238 - dcaegen2.collectors.datafile
239 - dcaegen2.collectors.restconf
240 - dcaegen2.deployments
241 - dcaegen2.platform.blueprints
242 - dcaegen2.platform.cli
243 - dcaegen2.platform.configbinding
244 - dcaegen2.platform.deployment-handler
245 - dcaegen2.platform.inventory-api
246 - dcaegen2.platform.plugins
247 - dcaegen2.platform.policy-handler
248 - dcaegen2.platform.servicechange-handler
249 - dcaegen2.services.heartbeat
250 - dcaegen2.services.mapper
251 - dcaegen2.services.pm-mapper
252 - dcaegen2.services.prh
253 - dcaegen2.services.son-handler
254 - dcaegen2.services
255 - dcaegen2.services.sdk
256 - dcaegen2.utils
257 - ccsdk.platform.plugins
258 - ccsdk.dashboard
259
260**Bug Fixes**
261 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
262 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
263
264
265**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200266 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
267
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400268**Security Notes**
269
270*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200271 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100272 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
273 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
274 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
275 * 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 +0100276
277*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100278 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
279 * 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 +0100280 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
281 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
282 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
283
284*Known Vulnerabilities in Used Modules*
285
286DCAE 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>`_.
287
288Quick Links:
289 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
290
291 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
292
293 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
294
295
296**Upgrade Notes**
297
298The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
299 - K8S Bootstrap container:
300 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
301 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
302 - Configuration Binding Service:
303 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
304 - Description: HTTPS support, Image optimization and non-root user
305 - Inventory API
306 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
307 - Description: HTTPS support, container optmization and non-root user
308 - DataFile Collector
309 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
310 - Description : Code optimization, bug fixes, dmaap plugin integration
311 - SON Handler MS
312 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
313 - Description : Image optimization, bug fixes, CBS integration
314 - VES Adapter/Mapper MS
315 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
316 - Description : Image optimization & CBS periodic polling
317 - PRH MS
318 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
319 - Description : Code optimization, bug fixes and SDK alignment
320 - HV-VES MS
321 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
322 - Description : Code optimization, bug fixes and SDK alignment
323
324Version: 5.0.0
325--------------
326
327El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
328
329Following is summary of updates done for DCAEGEN2
330
331**Security**
332
333Following platform components were enabled for HTTPS
334 - ConfigBindingService (CBS)
335 - 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>`_
336 - Cloudify Manager
337 - InventoryAPI
338
339All components interfacing with platform components were modified to support TLS interface
340
341**Miscellaneous**
342 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
343 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200344 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100345 - CBS client libraries updated to remove consul service lookup
346
347
348
349**Bug Fixes**
350 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
351 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
352
353
354**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200355 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
356
Vijay VK09589ca2019-10-08 04:47:17 +0100357
358**Security Notes**
359
360*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400361
362*Known Security Issues*
363
364 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
365 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
366 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
367 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
368 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
369 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
370 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
371 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
372 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
373 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
374
375*Known Vulnerabilities in Used Modules*
376
377DCAE 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>`_.
378
379Quick Links:
380 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
381
382 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
383
384 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
385
386
387**Upgrade Notes**
388
389The following components are upgraded from Dublin/R4.
390 - Cloudify Manager:
391 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
392 - 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.
393 - K8S Bootstrap container:
394 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
395 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
396 - Configuration Binding Service:
397 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
398 - Description: HTTPS support, Image optimization and non-root user
399 - Deployment Handler
400 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
401 - Description: Update to node10, uninstall workflow updates
402 - Service Change Handler
403 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
404 - Description: HTTPS inventoryAPI support, container optmization and non-root user
405 - Inventory API
406 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
407 - Description: HTTPS support, container optmization and non-root user
408 - DataFile Collector
409 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
410 - Description : Code optimization, bug fixes, dmaap plugin integration
411 - 3gpp PM-Mapper
412 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
413 - Description: Code optimization, bug fixes, dmaap plugin integration
414
415
416
Vijay VK6b0fa462019-05-20 16:06:11 +0100417Version: 4.0.0
418--------------
419
420:Release Date: 2019-06-06
421
422**New Features**
423
424DCAE R4 improves upon previous release with the following new features:
425
426- DCAE Platform Enhancement
427 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
428 - Support helm chart deployment in DCAE using new Helm cloudify plugin
429 - DCAE Healthcheck enhancement to cover static and dynamic deployments
430 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
431 - Dashboard Integration (UI for deployment/verification)
432 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
433 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200434 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100435
436- Following new services are delivered with Dublin
437 - Collectors
438 - RESTConf collector 
439 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100440 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100441 - 3gpp PM-Mapper
442 - BBS Event processor
443 - Analytics/RCA
444 - SON-Handler
445 - Heartbeat MS
446
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200447Most 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 +0100448 - Platform components
449 - Cloudify Manager (helm chart)
450 - Bootstrap container (helm chart)
451 - Configuration Binding Service (helm chart)
452 - Deployment Handler (helm chart)
453 - Policy Handler (helm chart
454 - Service Change Handler (helm chart)
455 - Inventory API (helm chart)
456 - Dashboard (Cloudify Blueprint)
457 - Service components
458 - VES Collector
459 - SNMP Collector
460 - Threshold Crossing Analytics
461 - HV-VES Collector
462 - PNF-Registration Handler
463 - Holmes Rule Management *
464 - Holmes Engine Management *
465 - Additional resources that DCAE utilizes:
466 - Postgres Database
467 - Redis Cluster Database
468 - Consul Cluster *
469
470 Notes:
471 \* These components are delivered by the Holmes project.
472
473
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200474Under 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 +0100475
476- All DCAE components are designed to support platform maturity requirements.
477
478
479**Source Code**
480
481Source code of DCAE components are released under the following repositories on gerrit.onap.org:
482 - dcaegen2
483 - dcaegen2.analytics.tca
484 - dcaegen2.collectors.snmptrap
485 - dcaegen2.collectors.ves
486 - dcaegen2.collectors.hv-ves
487 - dcaegen2.collectors.datafile
488 - dcaegen2.collectors.restconf
489 - dcaegen2.deployments
490 - dcaegen2.platform.blueprints
491 - dcaegen2.platform.cli
492 - dcaegen2.platform.configbinding
493 - dcaegen2.platform.deployment-handler
494 - dcaegen2.platform.inventory-api
495 - dcaegen2.platform.plugins
496 - dcaegen2.platform.policy-handler
497 - dcaegen2.platform.servicechange-handler
498 - dcaegen2.services.heartbeat
499 - dcaegen2.services.mapper
500 - dcaegen2.services.pm-mapper
501 - dcaegen2.services.prh
502 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200503 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100504 - dcaegen2.services.sdk
505 - dcaegen2.utils
506 - ccsdk.platform.plugins
507 - ccsdk.dashboard
508
509**Bug Fixes**
510
511**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200512 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
513
Vijay VK6b0fa462019-05-20 16:06:11 +0100514
515**Security Notes**
516
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200517*Fixed Security Issues*
518
519*Known Security Issues*
520
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200521 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200522 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200523 * 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 +0200524 * 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 +0200525 * 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 +0200526 * 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 +0200527 * 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 +0200528 * 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 +0200529 * 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 +0200530 * 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 +0200531
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200532*Known Vulnerabilities in Used Modules*
533
Vijay VK6b0fa462019-05-20 16:06:11 +0100534DCAE 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>`_.
535
536Quick Links:
537 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
538
539 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
540
541 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
542
543
544**New component Notes**
545The following components are introduced in R4
546
547 - Dashboard
548 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
549 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
550 - Blueprint generator
551 - 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 +0200552 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100553 - RESTConf collector 
554 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
555 - Description: Provides RESTConf interfaces to events from external domain controllers
556 - VES/Universal Mapper
557 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200558 - 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 +0100559 - 3gpp PM-Mapper
560 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200561 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100562 - BBS Event processor
563 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200564 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100565 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100566 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200567 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100568 - Heartbeat MS
569 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
570 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200571
Vijay VK6b0fa462019-05-20 16:06:11 +0100572
573**Upgrade Notes**
574
575The following components are upgraded from R3
576 - Cloudify Manager:
577 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
578 - 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 +0200579 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100580 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200581 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
582 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100583 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
584 - Description: Code optimization and bug fixes
585 - Deployment Handler
586 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
587 - Include updates for health and service endpoint check and bug fixes
588 - Policy Handler
589 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
590 - Description: Policy Handler supports the new lifecycle API's from Policy framework
591 - Service Change Handler
592 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
593 - Description: No update from R3
594 - Inventory API
595 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
596 - Description: Refactoring and updates for health and service endpoint check
597 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +0100598 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200599 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100600 - Threshold Crossing Analytics
601 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
602 - 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.
603 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100604 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100605 - Description : Code optimization, bug fixes, logging and performance improvement
606 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +0100607 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200608 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100609 - HV-VES Collector
610 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
611 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
612 - SNMP Trap Collector
613 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200614 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100615
616
617
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500618
619Version: 3.0.1
620--------------
621
622:Release Date: 2019-01-31
623
624DCAE R3 Maintenance release includes following fixes
625
626**Bug Fixes**
627
628- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200629 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500630 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200631 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500632 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200633 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500634 Multiple Fileready notification not handled
635
636- HighVolume VES Collector (protobuf/tcp)
637 - DCAEGEN2-976
638 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
639
640- VESCollector (http)
641 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200642 Issue with VES batch event publish
643
644- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500645 - DCAEGEN2-1007
646 Removing obsolete services configuration
647
648
649The following containers are updated in R3.0.1
650
651 - DataFile Collector
652 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
653 - HV-VES Collector
654 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
655 - VES Collector
656 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
657
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500658**Known Issues**
659
660- 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
661
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200662- 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 +0100663 kubectl get deployments -n onap | grep deployment-handler
664 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
665 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
666
667
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500668
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500669
Vijay VK2648c6d2018-09-19 04:30:37 +0100670Version: 3.0.0
671--------------
672
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800673:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100674
675**New Features**
676
677DCAE R3 improves upon previous release with the following new features:
678
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200679- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100680 - Platform components
681 - Cloudify Manager
682 - Bootstrap container
683 - Configuration Binding Service
684 - Deployment Handler
685 - Policy Handler
686 - Service Change Handler
687 - Inventory API
688 - Service components
689 - VES Collector
690 - SNMP Collector
691 - Threshold Crossing Analytics
692 - Holmes Rule Management *
693 - Holmes Engine Management *
694 - Additional resources that DCAE utilizes:
695 - Postgres Database
696 - Redis Cluster Database
697 - Consul Cluster
698
699 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000700 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100701
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200702- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100703
704 - 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".
705 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
706
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200707- 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 +0100708
709- All DCAE components are designed to support platform maturity requirements.
710
711
712**Source Code**
713
714Source code of DCAE components are released under the following repositories on gerrit.onap.org:
715 - dcaegen2
716 - dcaegen2.analytics
717 - dcaegen2.analytics.tca
718 - dcaegen2.collectors
719 - dcaegen2.collectors.snmptrap
720 - dcaegen2.collectors.ves
721 - dcaegen2.collectors.hv-ves
722 - dcaegen2.collectors.datafile
723 - dcaegen2.deployments
724 - dcaegen2.platform
725 - dcaegen2.platform.blueprints
726 - dcaegen2.platform.cli
727 - dcaegen2.platform.configbinding
728 - dcaegen2.platform.deployment-handler
729 - dcaegen2.platform.inventory-api
730 - dcaegen2.platform.plugins
731 - dcaegen2.platform.policy-handler
732 - dcaegen2.platform.servicechange-handler
733 - dcaegen2.services.heartbeat
734 - dcaegen2.services.mapper
735 - dcaegen2.services.prh
736 - dcaegen2.utils
737
738**Bug Fixes**
739
740**Known Issues**
741
742- 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.
743
744**Security Notes**
745
746DCAE 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>`_.
747
748Quick Links:
749 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
750
751 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
752
Vijay VKab471f62018-11-26 17:49:43 +0000753 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100754
755
Vijay VKf6659fc2018-11-02 05:07:27 +0100756**New component Notes**
757The following components are introduced in R3
758
759 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000760 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100761 - Description : Bulk data file collector to fetch non-realtime PM data
762 - PNF Registrator handler
763 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200764 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100765 - HV-VES Collector
766 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
767 - Description : High Volume VES Collector for fetching real-time PM measurement data
768 - SNMP Trap Collector
769 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200770 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100771
Vijay VK2648c6d2018-09-19 04:30:37 +0100772
773**Upgrade Notes**
774
775The following components are upgraded from R2:
776 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100777 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100778 - 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 +0200779 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100780 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100781 - 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 +0200782 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100783 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
784 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
785 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100786 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100787 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100788 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100789 - Description: Policy Handler now supports the new configuration policy format and support for TLS
790 - Service Change Handler
791 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
792 - Description: Refactoring.
793 - Inventory API
794 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
795 - Description: Refactoring.
796 - VES Collector
797 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500798 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100799 - Threshold Crossing Analytics
800 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
801 - 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.
802
803
804
805
Lusheng Jib2a561b2018-03-27 23:24:33 -0400806Version: 2.0.0
807--------------
808
Gildas Lanilis82799c72018-05-30 13:22:48 -0700809:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400810
811**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400812
Lusheng Jib2a561b2018-03-27 23:24:33 -0400813DCAE R2 improves upon previous release with the following new features:
814
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200815- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400816 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400817 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400818 - Bootstrap container
819 - Configuration Binding Service
820 - Deployment Handler
821 - Policy Handler
822 - Service Change Handler
823 - Inventory API
824 - Service components
825 - VES Collector
826 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400827 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400828 - Holmes Rule Management *
829 - Holmes Engine Management *
830 - Additional resources that DCAE utilizes:
831 - Postgres Database
832 - Redis Cluster Database
833 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400834
Lusheng Ji768421b2018-06-01 16:36:54 -0400835 Notes:
836 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400837
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200838- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400839
Lusheng Ji768421b2018-06-01 16:36:54 -0400840 - 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 -0400841 - 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 -0400842
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200843- 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 -0400844
845- All DCAE components are designed to support platform maturity requirements.
846
847
848**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400849
850Source code of DCAE components are released under the following repositories on gerrit.onap.org:
851 - dcaegen2
852 - dcaegen2.analytics
853 - dcaegen2.analytics.tca
854 - dcaegen2.collectors
855 - dcaegen2.collectors.snmptrap
856 - dcaegen2.collectors.ves
857 - dcaegen2.deployments
858 - dcaegen2.platform
859 - dcaegen2.platform.blueprints
860 - dcaegen2.platform.cli
861 - dcaegen2.platform.configbinding
862 - dcaegen2.platform.deployment-handler
863 - dcaegen2.platform.inventory-api
864 - dcaegen2.platform.plugins
865 - dcaegen2.platform.policy-handler
866 - dcaegen2.platform.servicechange-handler
867 - dcaegen2.services.heartbeat
868 - dcaegen2.services.mapper
869 - dcaegen2.services.prh
870 - dcaegen2.utils
871
872**Bug Fixes**
873
874**Known Issues**
875
Lusheng Ji768421b2018-06-01 16:36:54 -0400876- 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.
877
Gildas Lanilis82799c72018-05-30 13:22:48 -0700878**Security Notes**
879
880DCAE 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>`_.
881
882Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400883 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
884
885 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
886
887 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
888
889
Lusheng Jib2a561b2018-03-27 23:24:33 -0400890
891**Upgrade Notes**
892
Lusheng Ji768421b2018-06-01 16:36:54 -0400893The following components are upgraded from R1:
894 - Cloudify Manager:
895 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
896 - 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 +0200897 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400898 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400899 - 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 +0200900 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400901 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
902 - Description: Configuration Binding Sevice now supports the new configuration policy format.
903 - Deployment Handler
904 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
905 - Policy Handler
906 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
907 - Description: Policy Handler now supports the new configuration policy format.
908 - Service Change Handler
909 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
910 - Description: Refactoring.
911 - Inventory API
912 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
913 - Description: Refactoring.
914 - VES Collector
915 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
916 - Threshold Crossing Analytics
917 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
918 - 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.
919
Lusheng Jib2a561b2018-03-27 23:24:33 -0400920
921
Lusheng Ji8fafa432017-11-06 21:52:26 -0500922Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000923--------------
924
Lusheng Ji8fafa432017-11-06 21:52:26 -0500925:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000926
927
928**New Features**
929
Lusheng Ji8fafa432017-11-06 21:52:26 -0500930DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
931sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
932DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
933vDNS, vCPU, and vVoLTE.
934
935Specifically, DCAE R1 includes the following components:
936
937- Core platform
938 - Cloudify manager
939 - Consul cluster
940- Extended platform
941 - Platform component docker host
942 - Service component docker host
943 - CDAP cluster
944 - PostgreSQL database (*)
945- Platform docker container components
946 - Configuration binding service
947 - Deployment handler
948 - Service change handler
949 - Inventory
950 - Policy handler
951 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200952- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500953 - Docker container components
954 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000955 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500956 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000957 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500958
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200959(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
960VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500961other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200962(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500963in R1.
964
965Source codes of DCAE are released under the following repositories on gerrit.onap.org:
966
967- dcaegen2
968- dcaegen2/analytics
969- dcaegen2/analytics/tca
970- dcaegen2/collectors
971- dcaegen2/collectors/snmptrap
972- dcaegen2/collectors/ves
973- dcaegen2/deployments
974- dcaegen2/platform
975- dcaegen2/platform/blueprints
976- dcaegen2/platform/cdapbroker
977- dcaegen2/platform/cli
978- dcaegen2/platform/configbinding
979- dcaegen2/platform/deployment-handler
980- dcaegen2/platform/inventory-api
981- dcaegen2/platform/plugins
982- dcaegen2/platform/policy-handler
983- dcaegen2/platform/servicechange-handler
984- dcaegen2/utils
985
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000986
987**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500988
989This is the initial release.
990
991
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000992**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500993
994- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
995- Need to provide a dev configuration DCAE.
996
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000997
998**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000999
ankatare30c4cb42018-09-28 14:26:59 +05301000- 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 -04001001- 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.
1002
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001003
1004**Upgrade Notes**
1005
Lusheng Ji8fafa432017-11-06 21:52:26 -05001006This is the initial release.
1007
1008
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001009**Deprecation Notes**
1010
Lusheng Ji8fafa432017-11-06 21:52:26 -05001011There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1012DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1013following Gerrit repos are voided and already locked as read-only.
1014
1015- dcae
1016- dcae/apod
1017- dcae/apod/analytics
1018- dcae/apod/buildtools
1019- dcae/apod/cdap
1020- dcae/collectors
1021- dcae/collectors/ves
1022- dcae/controller
1023- dcae/controller/analytics
1024- dcae/dcae-inventory
1025- dcae/demo
1026- dcae/demo/startup
1027- dcae/demo/startup/aaf
1028- dcae/demo/startup/controller
1029- dcae/demo/startup/message-router
1030- dcae/dmaapbc
1031- dcae/operation
1032- dcae/operation/utils
1033- dcae/orch-dispatcher
1034- dcae/pgaas
1035- dcae/utils
1036- dcae/utils/buildtools
1037- ncomp
1038- ncomp/cdap
1039- ncomp/core
1040- ncomp/docker
1041- ncomp/maven
1042- ncomp/openstack
1043- ncomp/sirius
1044- ncomp/sirius/manager
1045- ncomp/utils
1046
1047
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001048**Other**
1049
Vijay0fbc6732017-11-08 13:55:01 +00001050SNMP trap collector is seed code delivery only.