update link to upper-constraints.txt
[dcaegen2.git] / docs / sections / version_6.0.0.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 ..      ===========================
5 ..      * * *    FRANKFURT    * * *
6 ..      ===========================
7
8
9 Version: 6.0.0
10 ==============
11
12
13 Abstract
14 --------
15
16 This document provides the release notes for the Frankfurt release.
17
18 Summary
19 -------
20
21 Following DCAE components are available with default ONAP/DCAE installation.
22
23     - Platform components
24
25         - Cloudify Manager (helm chart)
26         - Bootstrap container (helm chart)
27         - Configuration Binding Service (helm chart)
28         - Deployment Handler (helm chart)
29         - Policy Handler (helm chart
30         - Service Change Handler (helm chart)
31         - Inventory API (helm chart)
32         - Dashboard (helm chart)
33
34     - Service components
35
36         - VES Collector
37         - Threshold Crossing Analytics (TCA/CDAP)
38         - HV-VES Collector
39         - PNF-Registration Handler
40         - Docker based Threshold Crossing Analytics (TCA-Gen2)
41         - Holmes Rule Management *
42         - Holmes Engine Management *
43
44     - Additional resources that DCAE utilizes deployed using ONAP common charts:
45
46         - Postgres Database
47         - Mongo Database
48         - Redis Cluster Database
49         - Consul Cluster
50
51 Below service components (mS) are available to be deployed on-demand.
52
53         - SNMPTrap Collector
54         - RESTConf Collector
55         - DataFile Collector
56         - PM-Mapper
57         - BBS-EventProcessor
58         - VES Mapper
59         - Heartbeat mS
60         - SON-Handler
61         - PM-Subscription Handler
62
63     Notes:
64
65         \*  These components are delivered by the Holmes project.
66
67
68
69 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
70
71
72 Release Data
73 ------------
74
75 +--------------------------------------+--------------------------------------------------------+
76 | **DCAE Project**                     |                                                        |
77 |                                      |                                                        |
78 +--------------------------------------+--------------------------------------------------------+
79 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
80 |                                      |                                                        |
81 +--------------------------------------+--------------------------------------------------------+
82 | **Release designation**              | 6.0.0 frankfurt                                        |
83 |                                      |                                                        |
84 +--------------------------------------+--------------------------------------------------------+
85 | **Release date**                     | 2020-06-04                                             |
86 |                                      |                                                        |
87 +--------------------------------------+--------------------------------------------------------+
88
89
90 New features
91 ------------
92
93 - DCAE Platform Enhancement
94
95     - Introduction of Microservice and Onboarding Design (MOD) platform
96     - Policy Notification support for DCAE components
97     - Dynamic AAF certificate creation during component instantiation
98     - Helm chart optimization to control each platform component separate
99     - Dashboard Optimization
100     - Blueprint generator tool to simplify deployment artifact creation
101
102
103 - Following new services are delivered this release
104
105     - Event Processors
106
107         - PM Subscription Handler
108         - DataLake Handlers
109     - Analytics/RCA
110
111         - TCA-GEN2
112
113         - Acumos Adapter (PoC)
114
115 .. _frankfurt_deliverable:
116
117 Deliverables
118 ------------
119
120 Software Deliverables
121
122 .. csv-table::
123    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
124    :widths: auto
125
126    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
127    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
128    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
129    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
130    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
131    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
132    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
133    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
134    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
135    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
136    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
137    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
138    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
139    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
140    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
141    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
142    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
143    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
144    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
145    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
146    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
147    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6"
148    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
149    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
150    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
151    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
152    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
153    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
154    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
155    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
156    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
157    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
158    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
159    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
160    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
161    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
162    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
163    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
164    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
165    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
166
167
168 Known Limitations, Issues and Workarounds
169 -----------------------------------------
170
171     * Blueprint generator escape char issue (DCAEGEN2-2140)
172     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
173     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
174
175
176
177 *System Limitations*
178
179 None
180
181 *Known Vulnerabilities*
182
183 None
184
185 *Workarounds*
186
187 Documented under corresponding jira if applicable.
188
189 Security Notes
190 --------------
191
192 *Fixed Security Issues*
193
194     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
195     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
196     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
197     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
198     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
199
200
201 *Known Security Issues*
202
203         None
204
205
206 *Known Vulnerabilities in Used Modules*
207
208         None
209
210 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>`_.
211
212 Test Results
213 ------------
214
215  - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
216  - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
217
218
219 References
220 ----------
221
222 For more information on the ONAP Frankfurt release, please see:
223
224 #. `ONAP Home Page`_
225 #. `ONAP Documentation`_
226 #. `ONAP Release Downloads`_
227 #. `ONAP Wiki Page`_
228
229
230 .. _`ONAP Home Page`: https://www.onap.org
231 .. _`ONAP Wiki Page`: https://wiki.onap.org
232 .. _`ONAP Documentation`: https://docs.onap.org
233 .. _`ONAP Release Downloads`: https://git.onap.org
234
235 Quick Links:
236
237         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
238         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_