update link to upper-constraints.txt
[dcaegen2.git] / docs / sections / version_3.0.1.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Version: 3.0.1
5 ==============
6
7 :Release Date: 2019-01-31
8
9 DCAE R3 Maintenance release includes following fixes
10
11 **Bug Fixes**
12
13 - DataFileCollector
14      - DCAEGEN2-940
15        Larger files of size 100Kb publish to DR
16      - DCAEGEN2-941
17        DFC error after running over 12 hours
18      - DCAEGEN2-1001
19        Multiple Fileready notification not handled
20
21 - HighVolume VES Collector (protobuf/tcp)
22      - DCAEGEN2-976
23        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
24
25 - VESCollector (http)
26      - DCAEGEN2-1035
27        Issue with VES batch event publish
28
29 - Heat deployment
30      - DCAEGEN2-1007
31        Removing obsolete services configuration
32
33
34 The following containers are updated in R3.0.1
35
36     - DataFile Collector
37        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
38     - HV-VES Collector
39        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
40     - VES Collector
41        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
42
43 **Known Issues**
44
45 - 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
46
47 - 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
48     kubectl get deployments -n onap | grep deployment-handler
49     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
50     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
51
52
53
54
55 Version: 3.0.0
56 --------------
57
58 :Release Date: 2018-11-30
59
60 **New Features**
61
62 DCAE R3 improves upon previous release with the following new features:
63
64 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
65     - Platform components
66         - Cloudify Manager
67         - Bootstrap container
68         - Configuration Binding Service
69         - Deployment Handler
70         - Policy Handler
71         - Service Change Handler
72         - Inventory API
73     - Service components
74         - VES Collector
75         - SNMP Collector
76         - Threshold Crossing Analytics
77         - Holmes Rule Management *
78         - Holmes Engine Management *
79     - Additional resources that DCAE utilizes:
80         - Postgres Database
81         - Redis Cluster Database
82         - Consul Cluster
83
84     Notes:
85         \*  These components are delivered by the Holmes project.
86
87 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
88
89     - 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".
90     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
91
92 - 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.
93
94 - All DCAE components are designed to support platform maturity requirements.
95
96
97 **Source Code**
98
99 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
100     - dcaegen2
101     - dcaegen2.analytics
102     - dcaegen2.analytics.tca
103     - dcaegen2.collectors
104     - dcaegen2.collectors.snmptrap
105     - dcaegen2.collectors.ves
106     - dcaegen2.collectors.hv-ves
107     - dcaegen2.collectors.datafile
108     - dcaegen2.deployments
109     - dcaegen2.platform
110     - dcaegen2.platform.blueprints
111     - dcaegen2.platform.cli
112     - dcaegen2.platform.configbinding
113     - dcaegen2.platform.deployment-handler
114     - dcaegen2.platform.inventory-api
115     - dcaegen2.platform.plugins
116     - dcaegen2.platform.policy-handler
117     - dcaegen2.platform.servicechange-handler
118     - dcaegen2.services.heartbeat
119     - dcaegen2.services.mapper
120     - dcaegen2.services.prh
121     - dcaegen2.utils
122
123 **Bug Fixes**
124
125 **Known Issues**
126
127 - 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.
128
129 **Security Notes**
130
131 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>`_.
132
133 Quick Links:
134         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
135
136         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
137
138         - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
139
140
141 **New component Notes**
142 The following components are introduced in R3
143
144     - DataFile Collector
145        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
146        - Description : Bulk data file collector to fetch non-realtime PM data
147     - PNF Registrator handler
148        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
149        - Description : Recieves VES registration event and updates AAI and SO
150     - HV-VES Collector
151        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
152        - Description : High Volume VES Collector for fetching real-time PM measurement data
153     - SNMP Trap Collector
154        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
155        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
156
157
158 **Upgrade Notes**
159
160 The following components are upgraded from R2:
161     - Cloudify Manager:
162        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
163        - 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.
164     - Bootstrap container:
165        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
166        - 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.
167     - Configuration Binding Service:
168        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
169        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
170     - Deployment Handler
171        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
172     - Policy Handler
173        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
174        - Description: Policy Handler now supports the new configuration policy format and support for TLS
175     - Service Change Handler
176        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
177        - Description: Refactoring.
178     - Inventory API
179        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
180        - Description: Refactoring.
181     - VES Collector
182        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
183        - Description : Refactoring
184     - Threshold Crossing Analytics
185        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
186        - 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.