blob: 0f5245e32f0f833ff5f4d6060cdb67950b31cb8e [file] [log] [blame]
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3Release Notes
4=============
5
Vijay VK6b0fa462019-05-20 16:06:11 +01006Version: 4.0.0
7--------------
8
9:Release Date: 2019-06-06
10
11**New Features**
12
13DCAE R4 improves upon previous release with the following new features:
14
15- DCAE Platform Enhancement
16 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
17 - Support helm chart deployment in DCAE using new Helm cloudify plugin
18 - DCAE Healthcheck enhancement to cover static and dynamic deployments
19 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
20 - Dashboard Integration (UI for deployment/verification)
21 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
22 - Blueprint generator tool to simplify deployment artifact creation
23 - Cloudify Manager resiliency
24
25- Following new services are delivered with Dublin
26 - Collectors
27 - RESTConf collector 
28 - Event Processors
29 - VES/Universal Mapper
30 - 3gpp PM-Mapper
31 - BBS Event processor
32 - Analytics/RCA
33 - SON-Handler
34 - Heartbeat MS
35
36Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
37 - Platform components
38 - Cloudify Manager (helm chart)
39 - Bootstrap container (helm chart)
40 - Configuration Binding Service (helm chart)
41 - Deployment Handler (helm chart)
42 - Policy Handler (helm chart
43 - Service Change Handler (helm chart)
44 - Inventory API (helm chart)
45 - Dashboard (Cloudify Blueprint)
46 - Service components
47 - VES Collector
48 - SNMP Collector
49 - Threshold Crossing Analytics
50 - HV-VES Collector
51 - PNF-Registration Handler
52 - Holmes Rule Management *
53 - Holmes Engine Management *
54 - Additional resources that DCAE utilizes:
55 - Postgres Database
56 - Redis Cluster Database
57 - Consul Cluster *
58
59 Notes:
60 \* These components are delivered by the Holmes project.
61
62
63Under 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.
64
65- All DCAE components are designed to support platform maturity requirements.
66
67
68**Source Code**
69
70Source code of DCAE components are released under the following repositories on gerrit.onap.org:
71 - dcaegen2
72 - dcaegen2.analytics.tca
73 - dcaegen2.collectors.snmptrap
74 - dcaegen2.collectors.ves
75 - dcaegen2.collectors.hv-ves
76 - dcaegen2.collectors.datafile
77 - dcaegen2.collectors.restconf
78 - dcaegen2.deployments
79 - dcaegen2.platform.blueprints
80 - dcaegen2.platform.cli
81 - dcaegen2.platform.configbinding
82 - dcaegen2.platform.deployment-handler
83 - dcaegen2.platform.inventory-api
84 - dcaegen2.platform.plugins
85 - dcaegen2.platform.policy-handler
86 - dcaegen2.platform.servicechange-handler
87 - dcaegen2.services.heartbeat
88 - dcaegen2.services.mapper
89 - dcaegen2.services.pm-mapper
90 - dcaegen2.services.prh
91 - dcaegen2.services.son-handler
92 - dcaegen2.services
93 - dcaegen2.services.sdk
94 - dcaegen2.utils
95 - ccsdk.platform.plugins
96 - ccsdk.dashboard
97
98**Bug Fixes**
99
100**Known Issues**
101
102**Security Notes**
103
104DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
105
106Quick Links:
107 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
108
109 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
110
111 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
112
113
114**New component Notes**
115The following components are introduced in R4
116
117 - Dashboard
118 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
119 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
120 - Blueprint generator
121 - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
122 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
123 - RESTConf collector 
124 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
125 - Description: Provides RESTConf interfaces to events from external domain controllers
126 - VES/Universal Mapper
127 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
128 - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
129 - 3gpp PM-Mapper
130 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
131 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
132 - BBS Event processor
133 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
134 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
135 - SON-Handler
136 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.1
137 - Description: Supports PC-ANR optimization analysis and generating CL events output
138 - Heartbeat MS
139 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
140 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
141
142
143**Upgrade Notes**
144
145The following components are upgraded from R3
146 - Cloudify Manager:
147 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
148 - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
149 - K8S Bootstrap container:
150 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
151 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
152 - Configuration Binding Service:
153 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
154 - Description: Code optimization and bug fixes
155 - Deployment Handler
156 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
157 - Include updates for health and service endpoint check and bug fixes
158 - Policy Handler
159 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
160 - Description: Policy Handler supports the new lifecycle API's from Policy framework
161 - Service Change Handler
162 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
163 - Description: No update from R3
164 - Inventory API
165 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
166 - Description: Refactoring and updates for health and service endpoint check
167 - VES Collector
168 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
169 - Description : Authentication enhancement, refactoring and bug-fixes
170 - Threshold Crossing Analytics
171 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
172 - 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.
173 - DataFile Collector
174 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.2
175 - Description : Code optimization, bug fixes, logging and performance improvement
176 - PNF Registrator handler
177 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
178 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
179 - HV-VES Collector
180 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
181 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
182 - SNMP Trap Collector
183 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
184 - Description : Code coverage improvements
185
186
187
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500188
189Version: 3.0.1
190--------------
191
192:Release Date: 2019-01-31
193
194DCAE R3 Maintenance release includes following fixes
195
196**Bug Fixes**
197
198- DataFileCollector
199 - DCAEGEN2-940
200 Larger files of size 100Kb publish to DR
201 - DCAEGEN2-941
202 DFC error after running over 12 hours
203 - DCAEGEN2-1001
204 Multiple Fileready notification not handled
205
206- HighVolume VES Collector (protobuf/tcp)
207 - DCAEGEN2-976
208 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
209
210- VESCollector (http)
211 - DCAEGEN2-1035
212 Issue with VES batch event publish
213
214- Heat deployment
215 - DCAEGEN2-1007
216 Removing obsolete services configuration
217
218
219The following containers are updated in R3.0.1
220
221 - DataFile Collector
222 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
223 - HV-VES Collector
224 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
225 - VES Collector
226 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
227
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500228**Known Issues**
229
230- 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
231
Vijay VK6b0fa462019-05-20 16:06:11 +0100232- 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
233 kubectl get deployments -n onap | grep deployment-handler
234 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
235 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
236
237
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500238
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500239
Vijay VK2648c6d2018-09-19 04:30:37 +0100240Version: 3.0.0
241--------------
242
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800243:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100244
245**New Features**
246
247DCAE R3 improves upon previous release with the following new features:
248
249- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
250 - Platform components
251 - Cloudify Manager
252 - Bootstrap container
253 - Configuration Binding Service
254 - Deployment Handler
255 - Policy Handler
256 - Service Change Handler
257 - Inventory API
258 - Service components
259 - VES Collector
260 - SNMP Collector
261 - Threshold Crossing Analytics
262 - Holmes Rule Management *
263 - Holmes Engine Management *
264 - Additional resources that DCAE utilizes:
265 - Postgres Database
266 - Redis Cluster Database
267 - Consul Cluster
268
269 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000270 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100271
272- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
273
274 - 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".
275 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
276
277- 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.
278
279- All DCAE components are designed to support platform maturity requirements.
280
281
282**Source Code**
283
284Source code of DCAE components are released under the following repositories on gerrit.onap.org:
285 - dcaegen2
286 - dcaegen2.analytics
287 - dcaegen2.analytics.tca
288 - dcaegen2.collectors
289 - dcaegen2.collectors.snmptrap
290 - dcaegen2.collectors.ves
291 - dcaegen2.collectors.hv-ves
292 - dcaegen2.collectors.datafile
293 - dcaegen2.deployments
294 - dcaegen2.platform
295 - dcaegen2.platform.blueprints
296 - dcaegen2.platform.cli
297 - dcaegen2.platform.configbinding
298 - dcaegen2.platform.deployment-handler
299 - dcaegen2.platform.inventory-api
300 - dcaegen2.platform.plugins
301 - dcaegen2.platform.policy-handler
302 - dcaegen2.platform.servicechange-handler
303 - dcaegen2.services.heartbeat
304 - dcaegen2.services.mapper
305 - dcaegen2.services.prh
306 - dcaegen2.utils
307
308**Bug Fixes**
309
310**Known Issues**
311
312- 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.
313
314**Security Notes**
315
316DCAE 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>`_.
317
318Quick Links:
319 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
320
321 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
322
Vijay VKab471f62018-11-26 17:49:43 +0000323 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100324
325
Vijay VKf6659fc2018-11-02 05:07:27 +0100326**New component Notes**
327The following components are introduced in R3
328
329 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000330 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100331 - Description : Bulk data file collector to fetch non-realtime PM data
332 - PNF Registrator handler
333 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
334 - Description : Recieves VES registration event and updates AAI and SO
335 - HV-VES Collector
336 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
337 - Description : High Volume VES Collector for fetching real-time PM measurement data
338 - SNMP Trap Collector
339 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
340 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
341
Vijay VK2648c6d2018-09-19 04:30:37 +0100342
343**Upgrade Notes**
344
345The following components are upgraded from R2:
346 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100347 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100348 - 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.
Vijay VK2648c6d2018-09-19 04:30:37 +0100349 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100350 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100351 - 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.
352 - Configuration Binding Service:
353 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
354 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
355 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100356 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100357 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100358 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100359 - Description: Policy Handler now supports the new configuration policy format and support for TLS
360 - Service Change Handler
361 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
362 - Description: Refactoring.
363 - Inventory API
364 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
365 - Description: Refactoring.
366 - VES Collector
367 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500368 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100369 - Threshold Crossing Analytics
370 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
371 - 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.
372
373
374
375
Lusheng Jib2a561b2018-03-27 23:24:33 -0400376Version: 2.0.0
377--------------
378
Gildas Lanilis82799c72018-05-30 13:22:48 -0700379:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400380
381**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400382
Lusheng Jib2a561b2018-03-27 23:24:33 -0400383DCAE R2 improves upon previous release with the following new features:
384
Lusheng Ji768421b2018-06-01 16:36:54 -0400385- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400386 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400387 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400388 - Bootstrap container
389 - Configuration Binding Service
390 - Deployment Handler
391 - Policy Handler
392 - Service Change Handler
393 - Inventory API
394 - Service components
395 - VES Collector
396 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400397 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400398 - Holmes Rule Management *
399 - Holmes Engine Management *
400 - Additional resources that DCAE utilizes:
401 - Postgres Database
402 - Redis Cluster Database
403 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400404
Lusheng Ji768421b2018-06-01 16:36:54 -0400405 Notes:
406 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400407
Lusheng Jieaac78d2018-06-06 00:20:03 -0400408- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400409
Lusheng Ji768421b2018-06-01 16:36:54 -0400410 - 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 -0400411 - 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 -0400412
Lusheng Ji768421b2018-06-01 16:36:54 -0400413- 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.
414
415- All DCAE components are designed to support platform maturity requirements.
416
417
418**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400419
420Source code of DCAE components are released under the following repositories on gerrit.onap.org:
421 - dcaegen2
422 - dcaegen2.analytics
423 - dcaegen2.analytics.tca
424 - dcaegen2.collectors
425 - dcaegen2.collectors.snmptrap
426 - dcaegen2.collectors.ves
427 - dcaegen2.deployments
428 - dcaegen2.platform
429 - dcaegen2.platform.blueprints
430 - dcaegen2.platform.cli
431 - dcaegen2.platform.configbinding
432 - dcaegen2.platform.deployment-handler
433 - dcaegen2.platform.inventory-api
434 - dcaegen2.platform.plugins
435 - dcaegen2.platform.policy-handler
436 - dcaegen2.platform.servicechange-handler
437 - dcaegen2.services.heartbeat
438 - dcaegen2.services.mapper
439 - dcaegen2.services.prh
440 - dcaegen2.utils
441
442**Bug Fixes**
443
444**Known Issues**
445
Lusheng Ji768421b2018-06-01 16:36:54 -0400446- 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.
447
Gildas Lanilis82799c72018-05-30 13:22:48 -0700448**Security Notes**
449
450DCAE 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>`_.
451
452Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400453 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
454
455 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
456
457 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
458
459
Lusheng Jib2a561b2018-03-27 23:24:33 -0400460
461**Upgrade Notes**
462
Lusheng Ji768421b2018-06-01 16:36:54 -0400463The following components are upgraded from R1:
464 - Cloudify Manager:
465 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
466 - 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.
467 - Bootstrap container:
468 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400469 - 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.
Lusheng Ji768421b2018-06-01 16:36:54 -0400470 - Configuration Binding Service:
471 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
472 - Description: Configuration Binding Sevice now supports the new configuration policy format.
473 - Deployment Handler
474 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
475 - Policy Handler
476 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
477 - Description: Policy Handler now supports the new configuration policy format.
478 - Service Change Handler
479 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
480 - Description: Refactoring.
481 - Inventory API
482 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
483 - Description: Refactoring.
484 - VES Collector
485 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
486 - Threshold Crossing Analytics
487 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
488 - 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.
489
Lusheng Jib2a561b2018-03-27 23:24:33 -0400490
491
Lusheng Ji8fafa432017-11-06 21:52:26 -0500492Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000493--------------
494
Lusheng Ji8fafa432017-11-06 21:52:26 -0500495:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000496
497
498**New Features**
499
Lusheng Ji8fafa432017-11-06 21:52:26 -0500500DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
501sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
502DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
503vDNS, vCPU, and vVoLTE.
504
505Specifically, DCAE R1 includes the following components:
506
507- Core platform
508 - Cloudify manager
509 - Consul cluster
510- Extended platform
511 - Platform component docker host
512 - Service component docker host
513 - CDAP cluster
514 - PostgreSQL database (*)
515- Platform docker container components
516 - Configuration binding service
517 - Deployment handler
518 - Service change handler
519 - Inventory
520 - Policy handler
521 - CDAP broker
522- Service components
523 - Docker container components
524 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000525 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500526 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000527 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500528
529(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
530VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
531other deployment configurations not used in the R1 demos.)
532(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
533in R1.
534
535Source codes of DCAE are released under the following repositories on gerrit.onap.org:
536
537- dcaegen2
538- dcaegen2/analytics
539- dcaegen2/analytics/tca
540- dcaegen2/collectors
541- dcaegen2/collectors/snmptrap
542- dcaegen2/collectors/ves
543- dcaegen2/deployments
544- dcaegen2/platform
545- dcaegen2/platform/blueprints
546- dcaegen2/platform/cdapbroker
547- dcaegen2/platform/cli
548- dcaegen2/platform/configbinding
549- dcaegen2/platform/deployment-handler
550- dcaegen2/platform/inventory-api
551- dcaegen2/platform/plugins
552- dcaegen2/platform/policy-handler
553- dcaegen2/platform/servicechange-handler
554- dcaegen2/utils
555
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000556
557**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500558
559This is the initial release.
560
561
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000562**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500563
564- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
565- Need to provide a dev configuration DCAE.
566
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000567
568**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000569
ankatare30c4cb42018-09-28 14:26:59 +0530570- 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 -0400571- 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.
572
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000573
574**Upgrade Notes**
575
Lusheng Ji8fafa432017-11-06 21:52:26 -0500576This is the initial release.
577
578
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000579**Deprecation Notes**
580
Lusheng Ji8fafa432017-11-06 21:52:26 -0500581There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
582DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
583following Gerrit repos are voided and already locked as read-only.
584
585- dcae
586- dcae/apod
587- dcae/apod/analytics
588- dcae/apod/buildtools
589- dcae/apod/cdap
590- dcae/collectors
591- dcae/collectors/ves
592- dcae/controller
593- dcae/controller/analytics
594- dcae/dcae-inventory
595- dcae/demo
596- dcae/demo/startup
597- dcae/demo/startup/aaf
598- dcae/demo/startup/controller
599- dcae/demo/startup/message-router
600- dcae/dmaapbc
601- dcae/operation
602- dcae/operation/utils
603- dcae/orch-dispatcher
604- dcae/pgaas
605- dcae/utils
606- dcae/utils/buildtools
607- ncomp
608- ncomp/cdap
609- ncomp/core
610- ncomp/docker
611- ncomp/maven
612- ncomp/openstack
613- ncomp/sirius
614- ncomp/sirius/manager
615- ncomp/utils
616
617
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000618**Other**
619
Vijay0fbc6732017-11-08 13:55:01 +0000620SNMP trap collector is seed code delivery only.