blob: 8bd62db045d1061641ed3aa1ad06c24daae46559 [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 Opasiak07fa5872019-05-30 17:40:07 +0200108 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200109 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200110 * 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 +0200111 * 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 +0200112 * 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 +0200113 * 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 +0200114 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200115
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200116*Known Vulnerabilities in Used Modules*
117
Vijay VK6b0fa462019-05-20 16:06:11 +0100118DCAE 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>`_.
119
120Quick Links:
121 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
122
123 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
124
125 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
126
127
128**New component Notes**
129The following components are introduced in R4
130
131 - Dashboard
132 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
133 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
134 - Blueprint generator
135 - 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 +0200136 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100137 - RESTConf collector 
138 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
139 - Description: Provides RESTConf interfaces to events from external domain controllers
140 - VES/Universal Mapper
141 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200142 - 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 +0100143 - 3gpp PM-Mapper
144 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200145 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100146 - BBS Event processor
147 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200148 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100149 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100150 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200151 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100152 - Heartbeat MS
153 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
154 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200155
Vijay VK6b0fa462019-05-20 16:06:11 +0100156
157**Upgrade Notes**
158
159The following components are upgraded from R3
160 - Cloudify Manager:
161 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
162 - 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 +0200163 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100164 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200165 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
166 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100167 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
168 - Description: Code optimization and bug fixes
169 - Deployment Handler
170 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
171 - Include updates for health and service endpoint check and bug fixes
172 - Policy Handler
173 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
174 - Description: Policy Handler supports the new lifecycle API's from Policy framework
175 - Service Change Handler
176 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
177 - Description: No update from R3
178 - Inventory API
179 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
180 - Description: Refactoring and updates for health and service endpoint check
181 - VES Collector
182 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200183 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100184 - Threshold Crossing Analytics
185 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
186 - 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.
187 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100188 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100189 - Description : Code optimization, bug fixes, logging and performance improvement
190 - PNF Registrator handler
191 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200192 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100193 - HV-VES Collector
194 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
195 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
196 - SNMP Trap Collector
197 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200198 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100199
200
201
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500202
203Version: 3.0.1
204--------------
205
206:Release Date: 2019-01-31
207
208DCAE R3 Maintenance release includes following fixes
209
210**Bug Fixes**
211
212- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200213 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500214 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200215 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500216 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200217 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500218 Multiple Fileready notification not handled
219
220- HighVolume VES Collector (protobuf/tcp)
221 - DCAEGEN2-976
222 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
223
224- VESCollector (http)
225 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200226 Issue with VES batch event publish
227
228- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500229 - DCAEGEN2-1007
230 Removing obsolete services configuration
231
232
233The following containers are updated in R3.0.1
234
235 - DataFile Collector
236 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
237 - HV-VES Collector
238 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
239 - VES Collector
240 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
241
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500242**Known Issues**
243
244- 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
245
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200246- 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 +0100247 kubectl get deployments -n onap | grep deployment-handler
248 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
249 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
250
251
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500252
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500253
Vijay VK2648c6d2018-09-19 04:30:37 +0100254Version: 3.0.0
255--------------
256
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800257:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100258
259**New Features**
260
261DCAE R3 improves upon previous release with the following new features:
262
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200263- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100264 - Platform components
265 - Cloudify Manager
266 - Bootstrap container
267 - Configuration Binding Service
268 - Deployment Handler
269 - Policy Handler
270 - Service Change Handler
271 - Inventory API
272 - Service components
273 - VES Collector
274 - SNMP Collector
275 - Threshold Crossing Analytics
276 - Holmes Rule Management *
277 - Holmes Engine Management *
278 - Additional resources that DCAE utilizes:
279 - Postgres Database
280 - Redis Cluster Database
281 - Consul Cluster
282
283 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000284 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100285
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200286- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100287
288 - 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".
289 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
290
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200291- 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 +0100292
293- All DCAE components are designed to support platform maturity requirements.
294
295
296**Source Code**
297
298Source code of DCAE components are released under the following repositories on gerrit.onap.org:
299 - dcaegen2
300 - dcaegen2.analytics
301 - dcaegen2.analytics.tca
302 - dcaegen2.collectors
303 - dcaegen2.collectors.snmptrap
304 - dcaegen2.collectors.ves
305 - dcaegen2.collectors.hv-ves
306 - dcaegen2.collectors.datafile
307 - dcaegen2.deployments
308 - dcaegen2.platform
309 - dcaegen2.platform.blueprints
310 - dcaegen2.platform.cli
311 - dcaegen2.platform.configbinding
312 - dcaegen2.platform.deployment-handler
313 - dcaegen2.platform.inventory-api
314 - dcaegen2.platform.plugins
315 - dcaegen2.platform.policy-handler
316 - dcaegen2.platform.servicechange-handler
317 - dcaegen2.services.heartbeat
318 - dcaegen2.services.mapper
319 - dcaegen2.services.prh
320 - dcaegen2.utils
321
322**Bug Fixes**
323
324**Known Issues**
325
326- 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.
327
328**Security Notes**
329
330DCAE 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>`_.
331
332Quick Links:
333 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
334
335 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
336
Vijay VKab471f62018-11-26 17:49:43 +0000337 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100338
339
Vijay VKf6659fc2018-11-02 05:07:27 +0100340**New component Notes**
341The following components are introduced in R3
342
343 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000344 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100345 - Description : Bulk data file collector to fetch non-realtime PM data
346 - PNF Registrator handler
347 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200348 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100349 - HV-VES Collector
350 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
351 - Description : High Volume VES Collector for fetching real-time PM measurement data
352 - SNMP Trap Collector
353 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200354 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100355
Vijay VK2648c6d2018-09-19 04:30:37 +0100356
357**Upgrade Notes**
358
359The following components are upgraded from R2:
360 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100361 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100362 - 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 +0200363 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100364 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100365 - 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 +0200366 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100367 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
368 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
369 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100370 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100371 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100372 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100373 - Description: Policy Handler now supports the new configuration policy format and support for TLS
374 - Service Change Handler
375 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
376 - Description: Refactoring.
377 - Inventory API
378 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
379 - Description: Refactoring.
380 - VES Collector
381 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500382 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100383 - Threshold Crossing Analytics
384 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
385 - 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.
386
387
388
389
Lusheng Jib2a561b2018-03-27 23:24:33 -0400390Version: 2.0.0
391--------------
392
Gildas Lanilis82799c72018-05-30 13:22:48 -0700393:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400394
395**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400396
Lusheng Jib2a561b2018-03-27 23:24:33 -0400397DCAE R2 improves upon previous release with the following new features:
398
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200399- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400400 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400401 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400402 - Bootstrap container
403 - Configuration Binding Service
404 - Deployment Handler
405 - Policy Handler
406 - Service Change Handler
407 - Inventory API
408 - Service components
409 - VES Collector
410 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400411 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400412 - Holmes Rule Management *
413 - Holmes Engine Management *
414 - Additional resources that DCAE utilizes:
415 - Postgres Database
416 - Redis Cluster Database
417 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400418
Lusheng Ji768421b2018-06-01 16:36:54 -0400419 Notes:
420 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400421
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200422- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400423
Lusheng Ji768421b2018-06-01 16:36:54 -0400424 - 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 -0400425 - 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 -0400426
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200427- 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 -0400428
429- All DCAE components are designed to support platform maturity requirements.
430
431
432**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400433
434Source code of DCAE components are released under the following repositories on gerrit.onap.org:
435 - dcaegen2
436 - dcaegen2.analytics
437 - dcaegen2.analytics.tca
438 - dcaegen2.collectors
439 - dcaegen2.collectors.snmptrap
440 - dcaegen2.collectors.ves
441 - dcaegen2.deployments
442 - dcaegen2.platform
443 - dcaegen2.platform.blueprints
444 - dcaegen2.platform.cli
445 - dcaegen2.platform.configbinding
446 - dcaegen2.platform.deployment-handler
447 - dcaegen2.platform.inventory-api
448 - dcaegen2.platform.plugins
449 - dcaegen2.platform.policy-handler
450 - dcaegen2.platform.servicechange-handler
451 - dcaegen2.services.heartbeat
452 - dcaegen2.services.mapper
453 - dcaegen2.services.prh
454 - dcaegen2.utils
455
456**Bug Fixes**
457
458**Known Issues**
459
Lusheng Ji768421b2018-06-01 16:36:54 -0400460- 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.
461
Gildas Lanilis82799c72018-05-30 13:22:48 -0700462**Security Notes**
463
464DCAE 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>`_.
465
466Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400467 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
468
469 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
470
471 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
472
473
Lusheng Jib2a561b2018-03-27 23:24:33 -0400474
475**Upgrade Notes**
476
Lusheng Ji768421b2018-06-01 16:36:54 -0400477The following components are upgraded from R1:
478 - Cloudify Manager:
479 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
480 - 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 +0200481 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400482 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400483 - 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 +0200484 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400485 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
486 - Description: Configuration Binding Sevice now supports the new configuration policy format.
487 - Deployment Handler
488 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
489 - Policy Handler
490 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
491 - Description: Policy Handler now supports the new configuration policy format.
492 - Service Change Handler
493 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
494 - Description: Refactoring.
495 - Inventory API
496 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
497 - Description: Refactoring.
498 - VES Collector
499 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
500 - Threshold Crossing Analytics
501 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
502 - 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.
503
Lusheng Jib2a561b2018-03-27 23:24:33 -0400504
505
Lusheng Ji8fafa432017-11-06 21:52:26 -0500506Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000507--------------
508
Lusheng Ji8fafa432017-11-06 21:52:26 -0500509:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000510
511
512**New Features**
513
Lusheng Ji8fafa432017-11-06 21:52:26 -0500514DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
515sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
516DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
517vDNS, vCPU, and vVoLTE.
518
519Specifically, DCAE R1 includes the following components:
520
521- Core platform
522 - Cloudify manager
523 - Consul cluster
524- Extended platform
525 - Platform component docker host
526 - Service component docker host
527 - CDAP cluster
528 - PostgreSQL database (*)
529- Platform docker container components
530 - Configuration binding service
531 - Deployment handler
532 - Service change handler
533 - Inventory
534 - Policy handler
535 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200536- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500537 - Docker container components
538 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000539 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500540 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000541 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500542
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200543(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
544VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500545other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200546(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500547in R1.
548
549Source codes of DCAE are released under the following repositories on gerrit.onap.org:
550
551- dcaegen2
552- dcaegen2/analytics
553- dcaegen2/analytics/tca
554- dcaegen2/collectors
555- dcaegen2/collectors/snmptrap
556- dcaegen2/collectors/ves
557- dcaegen2/deployments
558- dcaegen2/platform
559- dcaegen2/platform/blueprints
560- dcaegen2/platform/cdapbroker
561- dcaegen2/platform/cli
562- dcaegen2/platform/configbinding
563- dcaegen2/platform/deployment-handler
564- dcaegen2/platform/inventory-api
565- dcaegen2/platform/plugins
566- dcaegen2/platform/policy-handler
567- dcaegen2/platform/servicechange-handler
568- dcaegen2/utils
569
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000570
571**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500572
573This is the initial release.
574
575
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000576**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500577
578- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
579- Need to provide a dev configuration DCAE.
580
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000581
582**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000583
ankatare30c4cb42018-09-28 14:26:59 +0530584- 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 -0400585- 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.
586
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000587
588**Upgrade Notes**
589
Lusheng Ji8fafa432017-11-06 21:52:26 -0500590This is the initial release.
591
592
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000593**Deprecation Notes**
594
Lusheng Ji8fafa432017-11-06 21:52:26 -0500595There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
596DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
597following Gerrit repos are voided and already locked as read-only.
598
599- dcae
600- dcae/apod
601- dcae/apod/analytics
602- dcae/apod/buildtools
603- dcae/apod/cdap
604- dcae/collectors
605- dcae/collectors/ves
606- dcae/controller
607- dcae/controller/analytics
608- dcae/dcae-inventory
609- dcae/demo
610- dcae/demo/startup
611- dcae/demo/startup/aaf
612- dcae/demo/startup/controller
613- dcae/demo/startup/message-router
614- dcae/dmaapbc
615- dcae/operation
616- dcae/operation/utils
617- dcae/orch-dispatcher
618- dcae/pgaas
619- dcae/utils
620- dcae/utils/buildtools
621- ncomp
622- ncomp/cdap
623- ncomp/core
624- ncomp/docker
625- ncomp/maven
626- ncomp/openstack
627- ncomp/sirius
628- ncomp/sirius/manager
629- ncomp/utils
630
631
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000632**Other**
633
Vijay0fbc6732017-11-08 13:55:01 +0000634SNMP trap collector is seed code delivery only.