blob: d689ca2e8c52cfaeade905bd6d5c6ef75b7914d7 [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
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020023 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +010024
25- Following new services are delivered with Dublin
26 - Collectors
27 - RESTConf collector 
28 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +010029 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +010030 - 3gpp PM-Mapper
31 - BBS Event processor
32 - Analytics/RCA
33 - SON-Handler
34 - Heartbeat MS
35
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020036Most 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 +010037 - 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
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020063Under 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 +010064
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
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +020092 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +010093 - 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
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200104*Fixed Security Issues*
105
106*Known Security Issues*
107
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200108 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
109
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200110*Known Vulnerabilities in Used Modules*
111
Vijay VK6b0fa462019-05-20 16:06:11 +0100112DCAE 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>`_.
113
114Quick Links:
115 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
116
117 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
118
119 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
120
121
122**New component Notes**
123The following components are introduced in R4
124
125 - Dashboard
126 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
127 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
128 - Blueprint generator
129 - 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 +0200130 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100131 - RESTConf collector 
132 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
133 - Description: Provides RESTConf interfaces to events from external domain controllers
134 - VES/Universal Mapper
135 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200136 - 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 +0100137 - 3gpp PM-Mapper
138 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200139 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100140 - BBS Event processor
141 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200142 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100143 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100144 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200145 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100146 - Heartbeat MS
147 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
148 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200149
Vijay VK6b0fa462019-05-20 16:06:11 +0100150
151**Upgrade Notes**
152
153The following components are upgraded from R3
154 - Cloudify Manager:
155 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
156 - 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 +0200157 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100158 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200159 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
160 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100161 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
162 - Description: Code optimization and bug fixes
163 - Deployment Handler
164 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
165 - Include updates for health and service endpoint check and bug fixes
166 - Policy Handler
167 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
168 - Description: Policy Handler supports the new lifecycle API's from Policy framework
169 - Service Change Handler
170 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
171 - Description: No update from R3
172 - Inventory API
173 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
174 - Description: Refactoring and updates for health and service endpoint check
175 - VES Collector
176 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200177 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100178 - Threshold Crossing Analytics
179 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
180 - 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.
181 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100182 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100183 - Description : Code optimization, bug fixes, logging and performance improvement
184 - PNF Registrator handler
185 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200186 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100187 - HV-VES Collector
188 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
189 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
190 - SNMP Trap Collector
191 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200192 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100193
194
195
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500196
197Version: 3.0.1
198--------------
199
200:Release Date: 2019-01-31
201
202DCAE R3 Maintenance release includes following fixes
203
204**Bug Fixes**
205
206- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200207 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500208 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200209 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500210 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200211 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500212 Multiple Fileready notification not handled
213
214- HighVolume VES Collector (protobuf/tcp)
215 - DCAEGEN2-976
216 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
217
218- VESCollector (http)
219 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200220 Issue with VES batch event publish
221
222- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500223 - DCAEGEN2-1007
224 Removing obsolete services configuration
225
226
227The following containers are updated in R3.0.1
228
229 - DataFile Collector
230 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
231 - HV-VES Collector
232 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
233 - VES Collector
234 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
235
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500236**Known Issues**
237
238- 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
239
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200240- 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 +0100241 kubectl get deployments -n onap | grep deployment-handler
242 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
243 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
244
245
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500246
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500247
Vijay VK2648c6d2018-09-19 04:30:37 +0100248Version: 3.0.0
249--------------
250
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800251:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100252
253**New Features**
254
255DCAE R3 improves upon previous release with the following new features:
256
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200257- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100258 - Platform components
259 - Cloudify Manager
260 - Bootstrap container
261 - Configuration Binding Service
262 - Deployment Handler
263 - Policy Handler
264 - Service Change Handler
265 - Inventory API
266 - Service components
267 - VES Collector
268 - SNMP Collector
269 - Threshold Crossing Analytics
270 - Holmes Rule Management *
271 - Holmes Engine Management *
272 - Additional resources that DCAE utilizes:
273 - Postgres Database
274 - Redis Cluster Database
275 - Consul Cluster
276
277 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000278 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100279
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200280- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100281
282 - 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".
283 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
284
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200285- 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 +0100286
287- All DCAE components are designed to support platform maturity requirements.
288
289
290**Source Code**
291
292Source code of DCAE components are released under the following repositories on gerrit.onap.org:
293 - dcaegen2
294 - dcaegen2.analytics
295 - dcaegen2.analytics.tca
296 - dcaegen2.collectors
297 - dcaegen2.collectors.snmptrap
298 - dcaegen2.collectors.ves
299 - dcaegen2.collectors.hv-ves
300 - dcaegen2.collectors.datafile
301 - dcaegen2.deployments
302 - dcaegen2.platform
303 - dcaegen2.platform.blueprints
304 - dcaegen2.platform.cli
305 - dcaegen2.platform.configbinding
306 - dcaegen2.platform.deployment-handler
307 - dcaegen2.platform.inventory-api
308 - dcaegen2.platform.plugins
309 - dcaegen2.platform.policy-handler
310 - dcaegen2.platform.servicechange-handler
311 - dcaegen2.services.heartbeat
312 - dcaegen2.services.mapper
313 - dcaegen2.services.prh
314 - dcaegen2.utils
315
316**Bug Fixes**
317
318**Known Issues**
319
320- 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.
321
322**Security Notes**
323
324DCAE 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>`_.
325
326Quick Links:
327 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
328
329 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
330
Vijay VKab471f62018-11-26 17:49:43 +0000331 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100332
333
Vijay VKf6659fc2018-11-02 05:07:27 +0100334**New component Notes**
335The following components are introduced in R3
336
337 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000338 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100339 - Description : Bulk data file collector to fetch non-realtime PM data
340 - PNF Registrator handler
341 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200342 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100343 - HV-VES Collector
344 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
345 - Description : High Volume VES Collector for fetching real-time PM measurement data
346 - SNMP Trap Collector
347 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200348 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100349
Vijay VK2648c6d2018-09-19 04:30:37 +0100350
351**Upgrade Notes**
352
353The following components are upgraded from R2:
354 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100355 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100356 - 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 +0200357 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100358 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100359 - 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 +0200360 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100361 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
362 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
363 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100364 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100365 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100366 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100367 - Description: Policy Handler now supports the new configuration policy format and support for TLS
368 - Service Change Handler
369 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
370 - Description: Refactoring.
371 - Inventory API
372 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
373 - Description: Refactoring.
374 - VES Collector
375 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500376 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100377 - Threshold Crossing Analytics
378 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
379 - 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.
380
381
382
383
Lusheng Jib2a561b2018-03-27 23:24:33 -0400384Version: 2.0.0
385--------------
386
Gildas Lanilis82799c72018-05-30 13:22:48 -0700387:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400388
389**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400390
Lusheng Jib2a561b2018-03-27 23:24:33 -0400391DCAE R2 improves upon previous release with the following new features:
392
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200393- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400394 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400395 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400396 - Bootstrap container
397 - Configuration Binding Service
398 - Deployment Handler
399 - Policy Handler
400 - Service Change Handler
401 - Inventory API
402 - Service components
403 - VES Collector
404 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400405 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400406 - Holmes Rule Management *
407 - Holmes Engine Management *
408 - Additional resources that DCAE utilizes:
409 - Postgres Database
410 - Redis Cluster Database
411 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400412
Lusheng Ji768421b2018-06-01 16:36:54 -0400413 Notes:
414 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400415
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200416- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400417
Lusheng Ji768421b2018-06-01 16:36:54 -0400418 - 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 -0400419 - 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 -0400420
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200421- 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 -0400422
423- All DCAE components are designed to support platform maturity requirements.
424
425
426**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400427
428Source code of DCAE components are released under the following repositories on gerrit.onap.org:
429 - dcaegen2
430 - dcaegen2.analytics
431 - dcaegen2.analytics.tca
432 - dcaegen2.collectors
433 - dcaegen2.collectors.snmptrap
434 - dcaegen2.collectors.ves
435 - dcaegen2.deployments
436 - dcaegen2.platform
437 - dcaegen2.platform.blueprints
438 - dcaegen2.platform.cli
439 - dcaegen2.platform.configbinding
440 - dcaegen2.platform.deployment-handler
441 - dcaegen2.platform.inventory-api
442 - dcaegen2.platform.plugins
443 - dcaegen2.platform.policy-handler
444 - dcaegen2.platform.servicechange-handler
445 - dcaegen2.services.heartbeat
446 - dcaegen2.services.mapper
447 - dcaegen2.services.prh
448 - dcaegen2.utils
449
450**Bug Fixes**
451
452**Known Issues**
453
Lusheng Ji768421b2018-06-01 16:36:54 -0400454- 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.
455
Gildas Lanilis82799c72018-05-30 13:22:48 -0700456**Security Notes**
457
458DCAE 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>`_.
459
460Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400461 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
462
463 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
464
465 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
466
467
Lusheng Jib2a561b2018-03-27 23:24:33 -0400468
469**Upgrade Notes**
470
Lusheng Ji768421b2018-06-01 16:36:54 -0400471The following components are upgraded from R1:
472 - Cloudify Manager:
473 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
474 - 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 +0200475 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400476 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400477 - 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 +0200478 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400479 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
480 - Description: Configuration Binding Sevice now supports the new configuration policy format.
481 - Deployment Handler
482 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
483 - Policy Handler
484 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
485 - Description: Policy Handler now supports the new configuration policy format.
486 - Service Change Handler
487 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
488 - Description: Refactoring.
489 - Inventory API
490 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
491 - Description: Refactoring.
492 - VES Collector
493 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
494 - Threshold Crossing Analytics
495 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
496 - 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.
497
Lusheng Jib2a561b2018-03-27 23:24:33 -0400498
499
Lusheng Ji8fafa432017-11-06 21:52:26 -0500500Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000501--------------
502
Lusheng Ji8fafa432017-11-06 21:52:26 -0500503:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000504
505
506**New Features**
507
Lusheng Ji8fafa432017-11-06 21:52:26 -0500508DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
509sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
510DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
511vDNS, vCPU, and vVoLTE.
512
513Specifically, DCAE R1 includes the following components:
514
515- Core platform
516 - Cloudify manager
517 - Consul cluster
518- Extended platform
519 - Platform component docker host
520 - Service component docker host
521 - CDAP cluster
522 - PostgreSQL database (*)
523- Platform docker container components
524 - Configuration binding service
525 - Deployment handler
526 - Service change handler
527 - Inventory
528 - Policy handler
529 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200530- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500531 - Docker container components
532 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000533 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500534 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000535 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500536
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200537(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
538VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500539other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200540(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500541in R1.
542
543Source codes of DCAE are released under the following repositories on gerrit.onap.org:
544
545- dcaegen2
546- dcaegen2/analytics
547- dcaegen2/analytics/tca
548- dcaegen2/collectors
549- dcaegen2/collectors/snmptrap
550- dcaegen2/collectors/ves
551- dcaegen2/deployments
552- dcaegen2/platform
553- dcaegen2/platform/blueprints
554- dcaegen2/platform/cdapbroker
555- dcaegen2/platform/cli
556- dcaegen2/platform/configbinding
557- dcaegen2/platform/deployment-handler
558- dcaegen2/platform/inventory-api
559- dcaegen2/platform/plugins
560- dcaegen2/platform/policy-handler
561- dcaegen2/platform/servicechange-handler
562- dcaegen2/utils
563
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000564
565**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500566
567This is the initial release.
568
569
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000570**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500571
572- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
573- Need to provide a dev configuration DCAE.
574
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000575
576**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000577
ankatare30c4cb42018-09-28 14:26:59 +0530578- 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 -0400579- 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.
580
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000581
582**Upgrade Notes**
583
Lusheng Ji8fafa432017-11-06 21:52:26 -0500584This is the initial release.
585
586
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000587**Deprecation Notes**
588
Lusheng Ji8fafa432017-11-06 21:52:26 -0500589There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
590DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
591following Gerrit repos are voided and already locked as read-only.
592
593- dcae
594- dcae/apod
595- dcae/apod/analytics
596- dcae/apod/buildtools
597- dcae/apod/cdap
598- dcae/collectors
599- dcae/collectors/ves
600- dcae/controller
601- dcae/controller/analytics
602- dcae/dcae-inventory
603- dcae/demo
604- dcae/demo/startup
605- dcae/demo/startup/aaf
606- dcae/demo/startup/controller
607- dcae/demo/startup/message-router
608- dcae/dmaapbc
609- dcae/operation
610- dcae/operation/utils
611- dcae/orch-dispatcher
612- dcae/pgaas
613- dcae/utils
614- dcae/utils/buildtools
615- ncomp
616- ncomp/cdap
617- ncomp/core
618- ncomp/docker
619- ncomp/maven
620- ncomp/openstack
621- ncomp/sirius
622- ncomp/sirius/manager
623- ncomp/utils
624
625
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000626**Other**
627
Vijay0fbc6732017-11-08 13:55:01 +0000628SNMP trap collector is seed code delivery only.