blob: b3637a05896cd518a43f79b9a3746855aecfd981 [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 Opasiak1f224ee2019-05-30 17:43:06 +0200115 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
Krzysztof Opasiak61cf8dc2019-05-30 17:43:51 +0200116 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200117
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200118*Known Vulnerabilities in Used Modules*
119
Vijay VK6b0fa462019-05-20 16:06:11 +0100120DCAE 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>`_.
121
122Quick Links:
123 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
124
125 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
126
127 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
128
129
130**New component Notes**
131The following components are introduced in R4
132
133 - Dashboard
134 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
135 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
136 - Blueprint generator
137 - 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 +0200138 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100139 - RESTConf collector 
140 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
141 - Description: Provides RESTConf interfaces to events from external domain controllers
142 - VES/Universal Mapper
143 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200144 - 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 +0100145 - 3gpp PM-Mapper
146 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200147 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +0100148 - BBS Event processor
149 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200150 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +0100151 - SON-Handler
Vijay VKf9e43442019-05-22 22:10:29 +0100152 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200153 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +0100154 - Heartbeat MS
155 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
156 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200157
Vijay VK6b0fa462019-05-20 16:06:11 +0100158
159**Upgrade Notes**
160
161The following components are upgraded from R3
162 - Cloudify Manager:
163 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
164 - 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 +0200165 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +0100166 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200167 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
168 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +0100169 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
170 - Description: Code optimization and bug fixes
171 - Deployment Handler
172 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
173 - Include updates for health and service endpoint check and bug fixes
174 - Policy Handler
175 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
176 - Description: Policy Handler supports the new lifecycle API's from Policy framework
177 - Service Change Handler
178 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
179 - Description: No update from R3
180 - Inventory API
181 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
182 - Description: Refactoring and updates for health and service endpoint check
183 - VES Collector
184 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200185 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +0100186 - Threshold Crossing Analytics
187 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
188 - 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.
189 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +0100190 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +0100191 - Description : Code optimization, bug fixes, logging and performance improvement
192 - PNF Registrator handler
193 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200194 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +0100195 - HV-VES Collector
196 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
197 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
198 - SNMP Trap Collector
199 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200200 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +0100201
202
203
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500204
205Version: 3.0.1
206--------------
207
208:Release Date: 2019-01-31
209
210DCAE R3 Maintenance release includes following fixes
211
212**Bug Fixes**
213
214- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200215 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500216 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200217 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500218 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200219 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500220 Multiple Fileready notification not handled
221
222- HighVolume VES Collector (protobuf/tcp)
223 - DCAEGEN2-976
224 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
225
226- VESCollector (http)
227 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200228 Issue with VES batch event publish
229
230- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500231 - DCAEGEN2-1007
232 Removing obsolete services configuration
233
234
235The following containers are updated in R3.0.1
236
237 - DataFile Collector
238 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
239 - HV-VES Collector
240 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
241 - VES Collector
242 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
243
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500244**Known Issues**
245
246- 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
247
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200248- 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 +0100249 kubectl get deployments -n onap | grep deployment-handler
250 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
251 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
252
253
VENKATESH KUMARb81c2972019-01-31 14:19:18 -0500254
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500255
Vijay VK2648c6d2018-09-19 04:30:37 +0100256Version: 3.0.0
257--------------
258
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -0800259:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +0100260
261**New Features**
262
263DCAE R3 improves upon previous release with the following new features:
264
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200265- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +0100266 - Platform components
267 - Cloudify Manager
268 - Bootstrap container
269 - Configuration Binding Service
270 - Deployment Handler
271 - Policy Handler
272 - Service Change Handler
273 - Inventory API
274 - Service components
275 - VES Collector
276 - SNMP Collector
277 - Threshold Crossing Analytics
278 - Holmes Rule Management *
279 - Holmes Engine Management *
280 - Additional resources that DCAE utilizes:
281 - Postgres Database
282 - Redis Cluster Database
283 - Consul Cluster
284
285 Notes:
Vijay VKab471f62018-11-26 17:49:43 +0000286 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +0100287
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200288- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +0100289
290 - 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".
291 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
292
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200293- 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 +0100294
295- All DCAE components are designed to support platform maturity requirements.
296
297
298**Source Code**
299
300Source code of DCAE components are released under the following repositories on gerrit.onap.org:
301 - dcaegen2
302 - dcaegen2.analytics
303 - dcaegen2.analytics.tca
304 - dcaegen2.collectors
305 - dcaegen2.collectors.snmptrap
306 - dcaegen2.collectors.ves
307 - dcaegen2.collectors.hv-ves
308 - dcaegen2.collectors.datafile
309 - dcaegen2.deployments
310 - dcaegen2.platform
311 - dcaegen2.platform.blueprints
312 - dcaegen2.platform.cli
313 - dcaegen2.platform.configbinding
314 - dcaegen2.platform.deployment-handler
315 - dcaegen2.platform.inventory-api
316 - dcaegen2.platform.plugins
317 - dcaegen2.platform.policy-handler
318 - dcaegen2.platform.servicechange-handler
319 - dcaegen2.services.heartbeat
320 - dcaegen2.services.mapper
321 - dcaegen2.services.prh
322 - dcaegen2.utils
323
324**Bug Fixes**
325
326**Known Issues**
327
328- 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.
329
330**Security Notes**
331
332DCAE 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>`_.
333
334Quick Links:
335 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
336
337 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
338
Vijay VKab471f62018-11-26 17:49:43 +0000339 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +0100340
341
Vijay VKf6659fc2018-11-02 05:07:27 +0100342**New component Notes**
343The following components are introduced in R3
344
345 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +0000346 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +0100347 - Description : Bulk data file collector to fetch non-realtime PM data
348 - PNF Registrator handler
349 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200350 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +0100351 - HV-VES Collector
352 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
353 - Description : High Volume VES Collector for fetching real-time PM measurement data
354 - SNMP Trap Collector
355 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200356 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +0100357
Vijay VK2648c6d2018-09-19 04:30:37 +0100358
359**Upgrade Notes**
360
361The following components are upgraded from R2:
362 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +0100363 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +0100364 - 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 +0200365 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +0100366 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +0100367 - 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 +0200368 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +0100369 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
370 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
371 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +0100372 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +0100373 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +0100374 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +0100375 - Description: Policy Handler now supports the new configuration policy format and support for TLS
376 - Service Change Handler
377 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
378 - Description: Refactoring.
379 - Inventory API
380 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
381 - Description: Refactoring.
382 - VES Collector
383 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -0500384 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +0100385 - Threshold Crossing Analytics
386 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
387 - 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.
388
389
390
391
Lusheng Jib2a561b2018-03-27 23:24:33 -0400392Version: 2.0.0
393--------------
394
Gildas Lanilis82799c72018-05-30 13:22:48 -0700395:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -0400396
397**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -0400398
Lusheng Jib2a561b2018-03-27 23:24:33 -0400399DCAE R2 improves upon previous release with the following new features:
400
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200401- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400402 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -0400403 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -0400404 - Bootstrap container
405 - Configuration Binding Service
406 - Deployment Handler
407 - Policy Handler
408 - Service Change Handler
409 - Inventory API
410 - Service components
411 - VES Collector
412 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -0400413 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -0400414 - Holmes Rule Management *
415 - Holmes Engine Management *
416 - Additional resources that DCAE utilizes:
417 - Postgres Database
418 - Redis Cluster Database
419 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -0400420
Lusheng Ji768421b2018-06-01 16:36:54 -0400421 Notes:
422 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400423
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200424- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -0400425
Lusheng Ji768421b2018-06-01 16:36:54 -0400426 - 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 -0400427 - 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 -0400428
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200429- 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 -0400430
431- All DCAE components are designed to support platform maturity requirements.
432
433
434**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -0400435
436Source code of DCAE components are released under the following repositories on gerrit.onap.org:
437 - dcaegen2
438 - dcaegen2.analytics
439 - dcaegen2.analytics.tca
440 - dcaegen2.collectors
441 - dcaegen2.collectors.snmptrap
442 - dcaegen2.collectors.ves
443 - dcaegen2.deployments
444 - dcaegen2.platform
445 - dcaegen2.platform.blueprints
446 - dcaegen2.platform.cli
447 - dcaegen2.platform.configbinding
448 - dcaegen2.platform.deployment-handler
449 - dcaegen2.platform.inventory-api
450 - dcaegen2.platform.plugins
451 - dcaegen2.platform.policy-handler
452 - dcaegen2.platform.servicechange-handler
453 - dcaegen2.services.heartbeat
454 - dcaegen2.services.mapper
455 - dcaegen2.services.prh
456 - dcaegen2.utils
457
458**Bug Fixes**
459
460**Known Issues**
461
Lusheng Ji768421b2018-06-01 16:36:54 -0400462- 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.
463
Gildas Lanilis82799c72018-05-30 13:22:48 -0700464**Security Notes**
465
466DCAE 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>`_.
467
468Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -0400469 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
470
471 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
472
473 - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
474
475
Lusheng Jib2a561b2018-03-27 23:24:33 -0400476
477**Upgrade Notes**
478
Lusheng Ji768421b2018-06-01 16:36:54 -0400479The following components are upgraded from R1:
480 - Cloudify Manager:
481 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
482 - 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 +0200483 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -0400484 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -0400485 - 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 +0200486 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -0400487 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
488 - Description: Configuration Binding Sevice now supports the new configuration policy format.
489 - Deployment Handler
490 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
491 - Policy Handler
492 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
493 - Description: Policy Handler now supports the new configuration policy format.
494 - Service Change Handler
495 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
496 - Description: Refactoring.
497 - Inventory API
498 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
499 - Description: Refactoring.
500 - VES Collector
501 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
502 - Threshold Crossing Analytics
503 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
504 - 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.
505
Lusheng Jib2a561b2018-03-27 23:24:33 -0400506
507
Lusheng Ji8fafa432017-11-06 21:52:26 -0500508Version: 1.0.0
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000509--------------
510
Lusheng Ji8fafa432017-11-06 21:52:26 -0500511:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000512
513
514**New Features**
515
Lusheng Ji8fafa432017-11-06 21:52:26 -0500516DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
517sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
518DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
519vDNS, vCPU, and vVoLTE.
520
521Specifically, DCAE R1 includes the following components:
522
523- Core platform
524 - Cloudify manager
525 - Consul cluster
526- Extended platform
527 - Platform component docker host
528 - Service component docker host
529 - CDAP cluster
530 - PostgreSQL database (*)
531- Platform docker container components
532 - Configuration binding service
533 - Deployment handler
534 - Service change handler
535 - Inventory
536 - Policy handler
537 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200538- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -0500539 - Docker container components
540 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +0000541 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -0500542 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +0000543 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -0500544
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200545(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
546VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -0500547other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200548(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -0500549in R1.
550
551Source codes of DCAE are released under the following repositories on gerrit.onap.org:
552
553- dcaegen2
554- dcaegen2/analytics
555- dcaegen2/analytics/tca
556- dcaegen2/collectors
557- dcaegen2/collectors/snmptrap
558- dcaegen2/collectors/ves
559- dcaegen2/deployments
560- dcaegen2/platform
561- dcaegen2/platform/blueprints
562- dcaegen2/platform/cdapbroker
563- dcaegen2/platform/cli
564- dcaegen2/platform/configbinding
565- dcaegen2/platform/deployment-handler
566- dcaegen2/platform/inventory-api
567- dcaegen2/platform/plugins
568- dcaegen2/platform/policy-handler
569- dcaegen2/platform/servicechange-handler
570- dcaegen2/utils
571
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000572
573**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500574
575This is the initial release.
576
577
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000578**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -0500579
580- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
581- Need to provide a dev configuration DCAE.
582
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000583
584**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000585
ankatare30c4cb42018-09-28 14:26:59 +0530586- 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 -0400587- 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.
588
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000589
590**Upgrade Notes**
591
Lusheng Ji8fafa432017-11-06 21:52:26 -0500592This is the initial release.
593
594
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000595**Deprecation Notes**
596
Lusheng Ji8fafa432017-11-06 21:52:26 -0500597There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
598DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
599following Gerrit repos are voided and already locked as read-only.
600
601- dcae
602- dcae/apod
603- dcae/apod/analytics
604- dcae/apod/buildtools
605- dcae/apod/cdap
606- dcae/collectors
607- dcae/collectors/ves
608- dcae/controller
609- dcae/controller/analytics
610- dcae/dcae-inventory
611- dcae/demo
612- dcae/demo/startup
613- dcae/demo/startup/aaf
614- dcae/demo/startup/controller
615- dcae/demo/startup/message-router
616- dcae/dmaapbc
617- dcae/operation
618- dcae/operation/utils
619- dcae/orch-dispatcher
620- dcae/pgaas
621- dcae/utils
622- dcae/utils/buildtools
623- ncomp
624- ncomp/cdap
625- ncomp/core
626- ncomp/docker
627- ncomp/maven
628- ncomp/openstack
629- ncomp/sirius
630- ncomp/sirius/manager
631- ncomp/utils
632
633
Lusheng Ji72c4fba2017-10-10 18:12:22 +0000634**Other**
635
Vijay0fbc6732017-11-08 13:55:01 +0000636SNMP trap collector is seed code delivery only.