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