Merge "[SLICEMS] Docs for SliceMS Kohn"
[dcaegen2.git] / docs / sections / release-notes.rst
1 .. ==============================LICENSE_START==========================================
2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (c) 2017-2022 AT&T Intellectual Property. All rights reserved.
5 .. Copyright 2021 Nokia Solutions and Networks.
6 .. ==============================LICENSE_END============================================
7 .. _release_notes:
8
9
10
11 ==================
12 DCAE Release Notes
13 ==================
14
15 .. contents::
16     :depth: 2
17 ..
18
19
20
21 ..      =====================
22 ..      * * *    KOHN   * * *
23 ..      =====================
24
25
26 Version: 11.0.0
27 ===============
28
29
30 Abstract
31 --------
32
33 This document provides the release notes for Kohn release.
34
35 Summary
36 -------
37
38 The following DCAE components are available with default ONAP/DCAE installation:
39
40     - Service components
41         - VES Collector
42         - HV-VES Collector
43         - PNF-Registration Handler
44         - Docker based Threshold Crossing Analytics (TCA-Gen2)
45         - VES OpenAPI Manager
46
47     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
48
49         - Postgresql Database
50         - Mongo Database
51
52
53 These service components (mS) are available to be deployed on-demand via helm:
54
55         - SNMPTrap Collector
56         - RESTConf Collector
57         - DataFile Collector
58         - PM-Mapper
59         - VES Mapper
60         - Heartbeat mS
61         - SON-Handler
62         - PM-Subscription Handler
63         - DataLake Handler (Admin & Feeder)
64         - Slice Analysis mS
65         - DataLake Extraction Service
66         - KPI-Ms
67
68
69 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services.
70
71 For Helm managed microservices,  dependencies are identified on each chart individually.
72 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
73
74 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
75
76
77 Release Data
78 ------------
79
80 +--------------------------------------+--------------------------------------------------------+
81 | **DCAE Project**                     |                                                        |
82 |                                      |                                                        |
83 +--------------------------------------+--------------------------------------------------------+
84 | **Docker images**                    | Refer :any:`Deliverable <kohn_deliverable>`            |
85 |                                      |                                                        |
86 +--------------------------------------+--------------------------------------------------------+
87 | **Release designation**              | 11.0.0 Kohn                                            |
88 |                                      |                                                        |
89 +--------------------------------------+--------------------------------------------------------+
90 | **Release date**                     | 2022-11-10                                             |
91 |                                      |                                                        |
92 +--------------------------------------+--------------------------------------------------------+
93
94
95 New features
96 ------------
97
98 *DCAE Enhancements and Features*
99
100 DCAEGEN2-3148 5G SON use case enhancements for Kohn release
101     - CL message for ANR modified to align with A1-based flow/support
102
103 DCAEGEN2-3195 CCVPN Kohn Enhancements for Intent-based Cloud Leased Line and Transport Slicing
104     - DCAE SDK alignment for SliceAnalysis MS & enhancing AAI interface for supporting IBN CL 
105
106 DCAEGEN2-3194 Maintenance and Enhancement of Intent-driven Closed-loop Autonomous Networks
107     - Slice Analysis Enhancement with AAI Interface/processing for CL notification
108
109 DCAEGEN2-3119 Helm Transformation - Post migration
110      - DCAE Common Template improvements
111      - Removed Cloudify and associated platform component chartsĀ 
112      - Removed Consul/CBS API dependency from each DCAE MS, enabling independent config management via respective charts
113      
114 DCAEGEN2-2975 VES 7.2.1 support for DCAE Microservices
115      - TCAgen2 enhanced to support VES 7.2.1
116
117 DCAEGEN2-3037 AAF certificate dependency removal
118     - DFC Enhanced to support additional property to disable certificates checks
119
120 DCAEGEN2-3030 DMAAP SDK standardization for DCAE Microservices
121     - SliceAnalysis MS, SON-Handler MS switched to use DMAAP SDK
122
123
124 *Non-Functional*
125
126    - DCAEGEN2-3089 - Sonarcoverage improvements for DCAE components - SliceAnalysis mS, SNMPTrap, TCA-gen2, SON-Handler, KPi-MS, Mapper, RESTConf  (meeting 80% or more coverage) 
127    - DCAEGEN2-3209 - CII Badging improvements (Silver badge completion)
128    - DCAEGEN2-3196 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector, HV-VES, RESTConf, VES, Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
129    - DCAEGEN2-3225 - SBOM Enablement for DCAE components  
130
131
132 .. _kohn_deliverable:
133
134 Deliverables
135 ------------
136
137 Software Deliverables
138
139 .. csv-table::
140    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
141    :widths: auto
142
143    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.4"
144    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.9.0"
145    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.11.0"
146    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.4"
147    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.7"
148    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.1"
149    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
150    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
151    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
152    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
153    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
154    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
155    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
156    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
157    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
158    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"
159    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.2.0"
160    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
161    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
162    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
163    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
164    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.5"
165    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.10"
166    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.4.1"
167    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.3"
168    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.9.0"
169    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.1"
170    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.10"
171    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.4 (jar)"
172    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.10 (jar)"
173
174 The following repositories (and containers) have been deprecated with this release.
175
176 .. csv-table::
177    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
178    :widths: auto
179
180    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
181
182 As DCAEMOD has been identified for EOL with London, following containers will be deprecated in next release and removed from OOM.
183
184 .. csv-table::
185    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
186    :widths: auto
187
188    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
189    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
190    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
191    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
192    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
193    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
194    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"   
195
196 Known Limitations, Issues and Workarounds
197 -----------------------------------------
198
199
200    - DCAEGEN2-3184 DL-Feeder log error and configuration issue
201
202 *Known Vulnerabilities*
203
204 None
205
206 *Workarounds*
207
208 Documented under corresponding jira if applicable.
209
210 Security Notes
211 --------------
212
213 *Fixed Security Issues*
214
215     Documented on earlier section
216
217 *Known Security Issues*
218
219     None
220
221 *Known Vulnerabilities in Used Modules*
222
223     None
224
225 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/display/SV/Kohn+DCAE>`_.
226
227 Test Results
228 ------------
229
230  - `DCAE R11 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Kohn+Release>`_
231  - `DCAE R11 Functional Test <https://wiki.onap.org/display/DW/DCAE+R11+Kohn+Testplan>`_
232
233
234 References
235 ----------
236
237 For more information on the ONAP Jakarta release, please see:
238
239 #. `ONAP Home Page`_
240 #. `ONAP Documentation`_
241 #. `ONAP Release Downloads`_
242 #. `ONAP Wiki Page`_
243
244
245 .. _`ONAP Home Page`: https://www.onap.org
246 .. _`ONAP Wiki Page`: https://wiki.onap.org
247 .. _`ONAP Documentation`: https://docs.onap.org
248 .. _`ONAP Release Downloads`: https://git.onap.org
249
250 Quick Links:
251
252         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
253         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
254
255
256
257
258
259 ..      ==========================
260 ..      * * *    JAKARTA    * * *
261 ..      ==========================
262
263
264 Version: 10.0.0
265 ===============
266
267
268 Abstract
269 --------
270
271 This document provides the release notes for Jakarta release.
272
273 Summary
274 -------
275
276 With DCAE transformation to HELM completed this release, all Cloudify/platform handler components have been retired
277 and only helm based MS deployment mode is supported.
278 The following DCAE components are available with default ONAP/DCAE installation:
279
280     - Service components
281         - VES Collector
282         - HV-VES Collector
283         - PNF-Registration Handler
284         - Docker based Threshold Crossing Analytics (TCA-Gen2)
285         - VES OpenAPI Manager
286
287     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
288
289         - Postgresql Database
290         - Mongo Database
291
292
293 These service components (mS) are available to be deployed on-demand via helm:
294
295         - SNMPTrap Collector
296         - RESTConf Collector
297         - DataFile Collector
298         - PM-Mapper
299         - VES Mapper
300         - Heartbeat mS
301         - SON-Handler
302         - PM-Subscription Handler
303         - DataLake Handler (Admin and Feeder)
304         - Slice Analysis mS
305         - DataLake Extraction Service
306         - KPI-Ms
307
308
309 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into a Kubernetes cluster.
310
311 For Helm managed microservices, the dependencies/pre-requisite are identified on each chart individually.
312 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
313
314 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
315
316
317 Release Data
318 ------------
319
320 +--------------------------------------+--------------------------------------------------------+
321 | **DCAE Project**                     |                                                        |
322 |                                      |                                                        |
323 +--------------------------------------+--------------------------------------------------------+
324 | **Docker images**                    | Refer :any:`Deliverable <jakarta_deliverable>`         |
325 |                                      |                                                        |
326 +--------------------------------------+--------------------------------------------------------+
327 | **Release designation**              | 10.0.0 Jakarta                                         |
328 |                                      |                                                        |
329 +--------------------------------------+--------------------------------------------------------+
330 | **Release date**                     | 2022-06-02                                             |
331 |                                      |                                                        |
332 +--------------------------------------+--------------------------------------------------------+
333
334
335 New features
336 ------------
337
338 *DCAE Enhancements and Features*
339
340 DCAEGEN2-3021 DCAE Impacts for E2E Network Slicing in Jakarta release
341     - Slice selection taking into consideration resource occupancy levels
342     - IBN based Closed loop for Network Slicing
343
344 DCAEGEN2-3063 CCVPN Jakarta Enhancements for Intent-based Cloud Leased Line and Closed-loop
345     - Support bandwidth evaluation and CL event generation
346     - AAI Interface for bandwidth update notification
347
348 DCAEGEN2-2773 DCAE Helm Transformation (Phase 3/Final)
349     - Removed Consul dependency across all DCAE service components.
350     - All DCAE microservices migrated to use latest CBS SDK library to support configmap/policy retrieval
351     - Enhancement on DCAE common template for DR Feed pub/sub configuration consistency and disable Consul loader
352     - DCAEMOD enhanced to support Helm chart generation for onboarded MS/flows
353     - Cloudify and related Handlers removal from ONAP/DCAE Deployment
354     - v3 spec introduced for MOD Helm flow support
355
356 DCAEGEN2-2906 - Bulk PM / PM Data Control Improvements (PMSH)
357     - PMSH functional enhancement and support for dynamic filter/subscription change via API
358
359 DCAEGEN2-3031 - Topic alignment for DCAE microservices
360     - Migrate DCAE MS to use standard topics for PM-Mapper, Slice-Analysis, KPI-MS
361
362
363 *Non-Functional*
364
365    - DCAEGEN2-2829 - CII Badging improvements
366    - DCAEGEN2-3006 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
367    - DCAEGEN2-2961/DCAEGEN2-2962/DCAEGEN2-2963 - Removed GPLv3 license from software by switching to onap/integration base images for VESCollector, RESTConf, SliceAnalysis MS
368    - DCAEGEN2-2958 - STDOUT log compliance for DCAE SNMPTRap collector and Healthcheck container
369
370
371
372
373 .. _jakarta_deliverable:
374
375 Deliverables
376 ------------
377
378 Software Deliverables
379
380 .. csv-table::
381    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
382    :widths: auto
383
384    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.2"
385    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.7.1"
386    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.10.0"
387    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.2"
388    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.6"
389    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.0"
390    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
391    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
392    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
393    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
394    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
395    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
396    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
397    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
398    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
399    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.2"
400    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
401    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.1.0"
402    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
403    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
404    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
405    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
406    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.3"
407    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.4"
408    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
409    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.0"
410    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.8.0"
411    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.0"
412    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.7"
413    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.3 (jar)"
414    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.8 (jar)"
415
416 The following repositories (and containers) have been deprecated with this release.
417
418 .. csv-table::
419    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
420    :widths: auto
421
422    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
423    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
424    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
425    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
426    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
427    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
428    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
429    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
430    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
431    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
432    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
433
434
435 Known Limitations, Issues and Workarounds
436 -----------------------------------------
437
438 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
439 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
440
441
442 *Known Vulnerabilities*
443
444 None
445
446 *Workarounds*
447
448 Documented under corresponding jira if applicable.
449
450 Security Notes
451 --------------
452
453 *Fixed Security Issues*
454
455     Documented on earlier section
456
457 *Known Security Issues*
458
459     None
460
461 *Known Vulnerabilities in Used Modules*
462
463     None
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/display/SV/Jakarta+DCAE>`_.
466
467 Test Results
468 ------------
469
470  - `DCAE R10 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Jakarta+Release>`_
471  - `DCAE R10 Functional Test <https://wiki.onap.org/display/DW/DCAE+R10+Testplan>`_
472
473
474 References
475 ----------
476
477 For more information on the ONAP Jakarta release, please see:
478
479 #. `ONAP Home Page`_
480 #. `ONAP Documentation`_
481 #. `ONAP Release Downloads`_
482 #. `ONAP Wiki Page`_
483
484
485 .. _`ONAP Home Page`: https://www.onap.org
486 .. _`ONAP Wiki Page`: https://wiki.onap.org
487 .. _`ONAP Documentation`: https://docs.onap.org
488 .. _`ONAP Release Downloads`: https://git.onap.org
489
490 Quick Links:
491
492         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
493         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
494
495
496
497 ..      =====================================
498 ..      * * *    ISTANBUL  MAINTENANCE  * * *
499 ..      =====================================
500
501
502 Version: 9.0.1
503 ==============
504
505 Abstract
506 --------
507
508 This document provides the release notes for the Istanbul Maintenance release
509
510
511 Summary
512 -------
513
514 This maintenance release is primarily to resolve bugs identified during Istanbul release testing.
515
516
517 Release Data
518 ------------
519
520 +--------------------------------------+--------------------------------------+
521 | **Project**                          | DCAE                                 |
522 |                                      |                                      |
523 +--------------------------------------+--------------------------------------+
524 | **Docker images**                    | See Istanbul Maintenance Release     |
525 |                                      |         Deliverable (below)          |
526 +--------------------------------------+--------------------------------------+
527 | **Release designation**              | Istanbul Maintenance Release         |
528 |                                      |                                      |
529 +--------------------------------------+--------------------------------------+
530 | **Release date**                     | 2022/01/31                           |
531 |                                      |                                      |
532 +--------------------------------------+--------------------------------------+
533
534 New features
535 ------------
536
537 None
538
539 **Bug fixes**
540
541 - `DCAEGEN2-3022 <https://jira.onap.org/browse/DCAEGEN2-3022>`_ Log4j vulnerability fix
542 - `DCAEGEN2-2998 <https://jira.onap.org/browse/DCAEGEN2-2998>`_ Update SON-Handler missing configuration in helm
543
544
545 **Known Issues**
546
547 None
548
549
550 Security Notes
551 --------------
552
553 *Known Vulnerabilities in Used Modules*
554
555     dcaegne2/services/mapper includes transitive dependency on log4j 1.2.17; this will be addressed in later release (DCAEGEN2-3105)
556
557
558 Istanbul Maintenance Rls Deliverables
559 -------------------------------------
560
561 Software Deliverables
562
563 .. csv-table::
564    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
565    :widths: auto
566
567    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.7"
568    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.3"
569    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.3.2"
570
571
572
573 ..      ==========================
574 ..      * * *    ISTANBUL    * * *
575 ..      ==========================
576
577
578 Version: 9.0.0
579 ==============
580
581
582 Abstract
583 --------
584
585 This document provides the release notes for Istanbul release.
586
587 Summary
588 -------
589
590 Following DCAE components are available with default ONAP/DCAE installation.
591
592     - Platform components
593
594         - Cloudify Manager (helm chart)*
595         - Bootstrap container (helm chart)*
596         - Configuration Binding Service (helm chart)
597         - Deployment Handler (helm chart)*
598         - Policy Handler (helm chart*
599         - Service Change Handler (helm chart)*
600         - Inventory API (helm chart)*
601         - Dashboard (helm chart)*
602         - VES OpenAPI Manager (helm chart)
603
604     - Service components
605
606         - VES Collector (helm chart  & cloudify blueprint)
607         - HV-VES Collector (helm chart  & cloudify blueprint)
608         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
609         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
610
611     - Additional resources that DCAE utilizes deployed using ONAP common charts:
612
613         - Postgres Database
614         - Mongo Database
615         - Consul Cluster
616
617     \*  These components will be retired next ONAP release as cloudify deployments will be diabled after Istanbul.
618  
619
620 Below service components (mS) are available to be deployed on-demand (helm chart & Cloudify Blueprint)
621
622         - SNMPTrap Collector
623         - RESTConf Collector
624         - DataFile Collector
625         - PM-Mapper
626         - BBS-EventProcessor
627         - VES Mapper
628         - Heartbeat mS
629         - SON-Handler
630         - PM-Subscription Handler
631         - DataLake Handler (Admin and Feeder)
632         - Slice Analysis mS
633         - DataLake Extraction Service
634         - KPI-Ms
635
636
637 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
638 With DCAE tranformation to Helm in Istanbul release - all DCAE components are available to be deployed under Helm; Cloudify blueprint deployment is provided for backward compatibility support in this release.
639
640 For Helm managed microservices, the dependencies/pre-requisite are identified on each charts individually. In general, most DCAE microservice rely on Consul/Configbindingservice for sourcing configuration updates (this dependency will be removed in next release). Each microservice can be deployed independently and based on dcaegen2-services-common template, features can be enabled or disabled via configuration override during deployment. For list of supported features in helm refer - :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
641
642 DCAE continues to provides Cloudify deployment through plugins (cloudify) 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.
643
644
645 Release Data
646 ------------
647
648 +--------------------------------------+--------------------------------------------------------+
649 | **DCAE Project**                     |                                                        |
650 |                                      |                                                        |
651 +--------------------------------------+--------------------------------------------------------+
652 | **Docker images**                    | Refer :any:`Deliverable <istanbul_deliverable>`        |
653 |                                      |                                                        |
654 +--------------------------------------+--------------------------------------------------------+
655 | **Release designation**              | 9.0.0 Istanbul                                         |
656 |                                      |                                                        |
657 +--------------------------------------+--------------------------------------------------------+
658 | **Release date**                     | 2021-11-18                                             |
659 |                                      |                                                        |
660 +--------------------------------------+--------------------------------------------------------+
661
662
663 New features
664 ------------
665
666 *DCAE Enhancements Features*
667
668 DCAEGEN2-2771 DCAE Impacts for E2E Network Slicing in Istanbul release
669     - SliceAnalysis and KPI-Computation MS migrated from ConfigDb to CPS
670     - Integration with new CBS client SDK and support policy sidecar
671
672 DCAEGEN2-2703 Add stndDefined domain to HV-VES
673     - HV_VES microservice was adapted to support stdDefined domain introduced under VES7.2.1 spec  
674
675 DCAEGEN2-2630 DCAE Helm Transformation (Phase 2)
676     - All DCAE microservices migration to helm was completed in Istanbul release. Since Honolulu, 13 additional MS has been delivered added for Helm deployment support
677     - All DCAE Microservice are supported under both Helm and Cloudify/blueprint based deployments (legacy)
678     - Helm Templated resuable function - Several new common features has been added in generic fashion as named template/functions defined in dcaegen2-services-common charts; each DCAEcomponents/mS can enable required features via configuration override. Following are current set of features available under dcaegen2-services-common
679             - K8S Secret/Environment mapping
680             - CMPv2 Certificate support
681             - Policy Sidecar
682             - Mount data from configmap through PV/PVC
683             - Topic/feed provisioning support
684             - AAF certificates generation/distribution
685             - Consul loader for application config
686
687     - Reducing Consul Dependency for DCAE components
688          Under cloudify deployments, Consul is used as central configuration store for all applications. With migration to Helm, the consul dependency is being removed by switching config management through K8S Configmap (via python/java SDK libraries). This allows application to be deployed standalone in multi/edge cloud without any dependency on central platform components.          
689
690     - Helm-generator tool (POC) available for generating DCAE component helm-chart given component spec. This tool will be integrated with MOD/design flow to support helm chart generation and distribution for Jakarta release. 
691
692 DCAEGEN2-2541 Bulk PM (PMSH) - Additional use cases, deployment and documentation enhancements
693     - Enhanced PMSH Microservice to support subscription property updates, config updates to support 'n' subscriptions, support resource name in filter
694
695 DCAEGEN2-2522 Enhancements for OOF SON use case
696     - Implemented CPS client interface (replacing ConfigDb)
697     - Switched to new CBS client SDK for removing consul dependency and enabling policy configuration through sidecar.
698
699 *Non-Functional*
700
701    - Removed GPLv3 license from software by switching to onap/integration base images (DCAEGEN2-2455)
702    - CII Badging improvements (DCAEGEN2-2622)
703    - Healthcheck container Py3 upgrade  (DCAEGEN2-2737)
704    - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS) (DCAEGEN2-2768)
705
706
707 Bug Fixes
708
709    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
710    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
711
712
713 .. _istanbul_deliverable:
714
715 Deliverables
716 ------------
717
718 Software Deliverables
719
720 .. csv-table::
721    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
722    :widths: auto
723
724    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.1"
725    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.6.1"
726    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.9.1"
727    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.5"
728    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.5"
729    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1"
730    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
731    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
732    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
733    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.2.0"
734    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
735    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
736    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
737    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
738    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
739    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
740    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
741    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
742    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
743    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.6"
744    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
745    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
746    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
747    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
748    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
749    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
750    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
751    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
752    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
753    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
754    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.3.2"
755    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.6"
756    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
757    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.1"
758    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
759    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.3.0"
760    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.7.2"
761    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.7.1"
762    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.5"
763    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.8.0 (jar)"
764    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.7 (jar)"
765    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
766
767
768 Known Limitations, Issues and Workarounds
769 -----------------------------------------
770
771 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
772 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
773
774
775 *Known Vulnerabilities*
776
777 None
778
779 *Workarounds*
780
781 Documented under corresponding jira if applicable.
782
783 Security Notes
784 --------------
785
786 *Fixed Security Issues*
787
788     Documented on earlier section
789
790 *Known Security Issues*
791
792     None
793
794 *Known Vulnerabilities in Used Modules*
795
796     None
797
798 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>`_.
799
800 Test Results
801 ------------
802
803  - `DCAE R9 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Istanbul+Release>`_
804  - `DCAE R9 Functional Test <https://wiki.onap.org/display/DW/DCAE+R9+Testplan>`_
805
806
807 References
808 ----------
809
810 For more information on the ONAP Honolulu release, please see:
811
812 #. `ONAP Home Page`_
813 #. `ONAP Documentation`_
814 #. `ONAP Release Downloads`_
815 #. `ONAP Wiki Page`_
816
817
818 .. _`ONAP Home Page`: https://www.onap.org
819 .. _`ONAP Wiki Page`: https://wiki.onap.org
820 .. _`ONAP Documentation`: https://docs.onap.org
821 .. _`ONAP Release Downloads`: https://git.onap.org
822
823 Quick Links:
824
825         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
826         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
827
828
829 ..      =====================================
830 ..      * * *    HONOLULU  MAINTENANCE  * * *
831 ..      =====================================
832
833
834 Version: 8.0.1
835 ==============
836
837 Abstract
838 --------
839
840 This document provides the release notes for the Honolulu Maintenance release
841
842
843 Summary
844 -------
845
846 This maintenance release is primarily to resolve bugs identified during Honolulu release testing.
847
848
849 Release Data
850 ------------
851
852 +--------------------------------------+--------------------------------------+
853 | **Project**                          | DCAE                                 |
854 |                                      |                                      |
855 +--------------------------------------+--------------------------------------+
856 | **Docker images**                    | onap/org.onap.ccsdk.dashboard.       |
857 |                                      |   .ccsdk-app-os:1.4.4                |
858 +--------------------------------------+--------------------------------------+
859 | **Release designation**              | Honolulu Maintenance Release         |
860 |                                      |                                      |
861 +--------------------------------------+--------------------------------------+
862 | **Release date**                     | 2021/06/01                           |
863 |                                      |                                      |
864 +--------------------------------------+--------------------------------------+
865
866 New features
867 ------------
868
869 None
870
871 **Bug fixes**
872
873 - `DCAEGEN2-2751 <https://jira.onap.org/browse/DCAEGEN2-2751>`_ Dashboard login issue due to oom/common PG upgrade to centos8-13.2-4.6.1
874 - `CCSDK-3233 <https://jira.onap.org/browse/CCSDK-3233>`_ Switch to integration base image & vulnerability updates fixes
875 - `DCAEGEN2-2800 <https://jira.onap.org/browse/DCAEGEN2-2800>`_ DCAE Healthcheck failure due to Dashboard 
876 - `DCAEGEN2-2869 <https://jira.onap.org/browse/DCAEGEN2-2869>`_ Fix PRH aai lookup url config
877
878 **Known Issues**
879
880 None
881
882 ..      ==========================
883 ..      * * *    HONOLULU    * * *
884 ..      ==========================
885
886
887 Version: 8.0.0
888 ==============
889
890
891 Abstract
892 --------
893
894 This document provides the release notes for Honolulu release.
895
896 Summary
897 -------
898
899 Following DCAE components are available with default ONAP/DCAE installation.
900
901     - Platform components
902
903         - Cloudify Manager (helm chart)
904         - Bootstrap container (helm chart)
905         - Configuration Binding Service (helm chart)
906         - Deployment Handler (helm chart)
907         - Policy Handler (helm chart
908         - Service Change Handler (helm chart)
909         - Inventory API (helm chart)
910         - Dashboard (helm chart)
911         - VES OpenAPI Manager (helm chart)
912
913     - Service components
914
915         - VES Collector (helm chart  & cloudify blueprint)
916         - HV-VES Collector (helm chart  & cloudify blueprint)
917         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
918         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
919         - Holmes Rule Management (helm chart  & cloudify blueprint)
920         - Holmes Engine Management (helm chart  & cloudify blueprint)
921
922     - Additional resources that DCAE utilizes deployed using ONAP common charts:
923
924         - Postgres Database
925         - Mongo Database
926         - Consul Cluster
927
928 Below service components (mS) are available to be deployed on-demand (through Cloudify Blueprint)
929
930         - SNMPTrap Collector
931         - RESTConf Collector
932         - DataFile Collector
933         - PM-Mapper 
934         - BBS-EventProcessor
935         - VES Mapper
936         - Heartbeat mS
937         - SON-Handler
938         - PM-Subscription Handler
939         - DataLake Handler (Admin and Feeder)
940         - Slice Analysis mS
941         - DataLake Extraction Service
942         - KPI-Ms
943
944     Notes:
945
946         \*  These components are delivered by the Holmes project.
947
948
949
950 Under OOM (Kubernetes) all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE components are deployed using combination of Helm charts and Cloudify blueprint as noted above. 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.
951
952
953 Release Data
954 ------------
955
956 +--------------------------------------+--------------------------------------------------------+
957 | **DCAE Project**                     |                                                        |
958 |                                      |                                                        |
959 +--------------------------------------+--------------------------------------------------------+
960 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
961 |                                      |                                                        |
962 +--------------------------------------+--------------------------------------------------------+
963 | **Release designation**              | 8.0.0 Honolulu                                         |
964 |                                      |                                                        |
965 +--------------------------------------+--------------------------------------------------------+
966 | **Release date**                     | 2021-04-29                                             |
967 |                                      |                                                        |
968 +--------------------------------------+--------------------------------------------------------+
969
970
971 New features
972 ------------
973
974 *DCAE Enhancements*
975
976
977 Functional Updates
978
979    - New service VES-Openapi-Manager component added to DCAE, allowing to notify of missing openAPI description, at xNF distribution phase (DCAEGEN2-2571) 
980    - Added VES 7.2.1 support in VESCollector (DCAEGEN2-2539, DCAEGEN2-2477)
981    - DCAE MS deployment through helm with introduction of common dcae-service template to standardize charts with migration (DCAEGEN2-2488) 
982    - New service KPI-Computation MS introduced for support for E2E Slicing Usecase (DCAEGEN2-2521)
983    - K8S configMap support through onboarding/design/deployment via DCAE-MOD and DCAE-Platform (DCAEGEN2-2539)
984    - BP-generation Enhancements - support Native-kafka & Config-map through onboarding (DCAEGEN2-2458)
985    - CFY plugin enhancements - support IPV6 service exposure + Config-Map + Cert-Manager's CMPv2 issuer integration (DCAEGEN2-2539, DCAEGEN2-2458, DCAEGEN2-2388)
986    - DCAE SDK enhancement - Dmaap Client update for timeout/retry + CBS client update (DCAEGEN2-1483)
987    - DFC enhancement - support in HTTP/HTTPS/enroll certificate from CMPv2 server (DCAEGEN2-2517)
988
989 Non-Functional
990
991    - DCAE Cloudify py3 upgrade including plugins/bootstrap cli (DCAEGEN2-1546)
992    - CII Badging improvements (DCAEGEN2-2570)
993    - Policy-Handler Py3 upgrade  (DCAEGEN2-2494)
994    - Vulnerability updates for several DCAE MS (DataFile Collector, RESTConf, VESCollector, InventoryAPI, MOD/RuntimeAPI, VES-mapper, PM-Mapper, PRH, SON-Handler) (DCAEGEN2-2551)
995    - Code Coverage improvement (DataFile, SDK, Blueprint-generator, Plugins, Acumos Adapter) (DCAEGEN2-2382)
996    - Documentation/user-guide updates
997
998 Bug Fixes
999
1000    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
1001    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
1002
1003
1004 - Following new services are delivered this release
1005     - VES OpenAPI Manager
1006     - KPI MS (Analytics/RCA)
1007
1008 .. _honolulu_deliverable:
1009
1010 Deliverables
1011 ------------
1012
1013 Software Deliverables
1014
1015 .. csv-table::
1016    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1017    :widths: auto
1018
1019    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
1020    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.5.5"
1021    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.6.0"
1022    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.4"
1023    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.4"
1024    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.8.0"
1025    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.4.2"
1026    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.0"
1027    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1028    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
1029    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1030    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.0"
1031    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
1032    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
1033    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1034    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
1035    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
1036    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1037    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
1038    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.4"
1039    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.0.4" 
1040    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
1041    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
1042    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
1043    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.2"
1044    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
1045    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
1046    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
1047    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
1048    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
1049    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
1050    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.4"
1051    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
1052    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.0"
1053    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
1054    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.2.0"
1055    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.5.2"
1056    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.6"
1057    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.3"
1058    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.7.3 (jar)"
1059    "dcaegen2/services/sdk", "", "DCAE SDK 1.7.0 (jar)"
1060    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
1061
1062
1063 Known Limitations, Issues and Workarounds
1064 -----------------------------------------
1065
1066 The new, Helm based installation mechanism for collectors doesn't support yet certain features available with the traditional Cloudify orchestration based mechanisms:
1067    - Obtaining X.509 certificates from external CMP v2 server for secure xNF connections
1068    - Exposing the Collector port in Dual Stack IPv4/IPv6 networks.
1069
1070 Such features are available, when the collectors are installed using the Cloudify mechanisms.
1071 Refer to collector installation page for more details:
1072
1073 .. toctree::
1074    :maxdepth: 1
1075
1076    ./services/ves-http/installation.rst
1077    ./services/ves-hv/installation.rst
1078
1079     
1080 *Known Vulnerabilities*
1081
1082 None
1083
1084 *Workarounds*
1085
1086 Documented under corresponding jira if applicable.
1087
1088 Security Notes
1089 --------------
1090
1091 *Fixed Security Issues*
1092     
1093     Documented on earlier section
1094
1095 *Known Security Issues*
1096     
1097     None
1098
1099 *Known Vulnerabilities in Used Modules*
1100     
1101     None
1102         
1103 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>`_.
1104
1105 Test Results
1106 ------------
1107
1108  - `DCAE R8 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Honolulu+Release>`_
1109  - `DCAE R8 Functional Test <https://wiki.onap.org/display/DW/DCAE+R8+Testplan>`_
1110
1111
1112 References
1113 ----------
1114
1115 For more information on the ONAP Honolulu release, please see:
1116
1117 #. `ONAP Home Page`_
1118 #. `ONAP Documentation`_
1119 #. `ONAP Release Downloads`_
1120 #. `ONAP Wiki Page`_
1121
1122
1123 .. _`ONAP Home Page`: https://www.onap.org
1124 .. _`ONAP Wiki Page`: https://wiki.onap.org
1125 .. _`ONAP Documentation`: https://docs.onap.org
1126 .. _`ONAP Release Downloads`: https://git.onap.org
1127
1128 Quick Links:
1129
1130         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1131         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1132
1133
1134 ..      ===================================
1135 ..      * * *    GUILIN  MAINTENANCE  * * *
1136 ..      ===================================
1137
1138
1139 Version: 7.0.1
1140 ==============
1141
1142 Abstract
1143 --------
1144
1145 This document provides the release notes for the Guilin Maintenance release
1146
1147
1148 Summary
1149 -------
1150
1151 This maintenance release is primarily to resolve bugs identified during Guilin release testing.
1152
1153
1154 Release Data
1155 ------------
1156
1157 +--------------------------------------+--------------------------------------+
1158 | **Project**                          | DCAE                                 |
1159 |                                      |                                      |
1160 +--------------------------------------+--------------------------------------+
1161 | **Docker images**                    | onap/org.onap.dcaegen2.collectors    |
1162 |                                      |   .hv-ves.hv-collector-main:1.5.1    |
1163 +--------------------------------------+--------------------------------------+
1164 | **Release designation**              | Guilin Maintenance Release           |
1165 |                                      |                                      |
1166 +--------------------------------------+--------------------------------------+
1167 | **Release date**                     | 2021/04/19                           |
1168 |                                      |                                      |
1169 +--------------------------------------+--------------------------------------+
1170
1171 New features
1172 ------------
1173
1174 None
1175
1176 **Bug fixes**
1177
1178 - `DCAEGEN2-2516 <https://jira.onap.org/browse/DCAEGEN2-2516>`_ HV-VES Pod recovery when config-fetch fails
1179 - `OOM-2641 <https://jira.onap.org/browse/OOM-2641>`_ Fix DCAEMOD paths based on Guilin ingress template
1180
1181 **Known Issues**
1182
1183 Same as Guilin Release
1184
1185
1186 ..      ========================
1187 ..      * * *    GUILIN    * * *
1188 ..      ========================
1189
1190
1191 Version: 7.0.0
1192 ==============
1193
1194
1195 Abstract
1196 --------
1197
1198 This document provides the release notes for Guilin release.
1199
1200 Summary
1201 -------
1202
1203 Following DCAE components are available with default ONAP/DCAE installation.
1204
1205     - Platform components
1206
1207         - Cloudify Manager (helm chart)
1208         - Bootstrap container (helm chart)
1209         - Configuration Binding Service (helm chart)
1210         - Deployment Handler (helm chart)
1211         - Policy Handler (helm chart
1212         - Service Change Handler (helm chart)
1213         - Inventory API (helm chart)
1214         - Dashboard (helm chart)
1215
1216     - Service components
1217
1218         - VES Collector
1219         - HV-VES Collector
1220         - PNF-Registration Handler
1221         - Docker based Threshold Crossing Analytics (TCA-Gen2)
1222         - Holmes Rule Management *
1223         - Holmes Engine Management *
1224
1225     - Additional resources that DCAE utilizes deployed using ONAP common charts:
1226     
1227         - Postgres Database
1228         - Mongo Database
1229         - Redis Cluster Database
1230         - Consul Cluster 
1231
1232 Below service components (mS) are available to be deployed on-demand.
1233
1234         - SNMPTrap Collector
1235         - RESTConf Collector
1236         - DataFile Collector
1237         - PM-Mapper 
1238         - BBS-EventProcessor
1239         - VES Mapper
1240         - Heartbeat mS
1241         - SON-Handler
1242         - PM-Subscription Handler
1243         - DataLake Handler (Admin and Feeder)
1244         - Slice Analysis
1245         - DataLake Extraction Service
1246
1247     Notes:
1248
1249         \*  These components are delivered by the Holmes project.
1250
1251
1252
1253 Under OOM (Kubernetes) 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.
1254
1255
1256 Release Data
1257 ------------
1258
1259 +--------------------------------------+--------------------------------------------------------+
1260 | **DCAE Project**                     |                                                        |
1261 |                                      |                                                        |
1262 +--------------------------------------+--------------------------------------------------------+
1263 | **Docker images**                    | Refer :any:`Deliverable <guilin_deliverable>`          |
1264 |                                      |                                                        |
1265 +--------------------------------------+--------------------------------------------------------+
1266 | **Release designation**              | 7.0.0 Guilin                                           |
1267 |                                      |                                                        |
1268 +--------------------------------------+--------------------------------------------------------+
1269 | **Release date**                     | 2020-11-19                                             |
1270 |                                      |                                                        |
1271 +--------------------------------------+--------------------------------------------------------+
1272
1273
1274 New features
1275 ------------
1276
1277 - DCAE Enhancements
1278
1279     - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
1280     - Bootstrap container optimization  (DCAEGEN2-1791)
1281     - MOD/Runtime ā€“ Enable configuration for dynamic topic support (DCAEGEN2-1996)
1282     - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
1283     - DCAE Dashboard UI Optimization  and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
1284     - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
1285     - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
1286     - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
1287     - Java 11 upgrade complete for following modules - RESTConf, PM-Mapper, DFC, VES-Mapper, SON-handler, TCA-gen2, DL-Feeder, InventoryAPI, ServiceChangeHandler, MOD/RuntimeAPI, MOD/Bp-gen (DCAEGEN2-2223)
1288     - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
1289     - Best practice compliance
1290          - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
1291          - No more than one main process (DCAEGEN2-2327/REQ-365)
1292          - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
1293          - All containers must run as non-root (REQ-362)
1294          - Code coverage >55% (DCAEGEN2-2333)
1295     - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
1296  
1297
1298 - Following new services are delivered this release
1299
1300     - Event Processors
1301         - DataLake Extraction Service 
1302        
1303     - Analytics/RCA
1304         - Slice Analysis MS
1305         
1306 .. _guilin_deliverable:
1307
1308 Deliverables
1309 ------------
1310
1311 Software Deliverables
1312
1313 .. csv-table::
1314    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1315    :widths: auto
1316
1317    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
1318    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
1319    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
1320    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
1321    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
1322    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
1323    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
1324    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
1325    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1326    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
1327    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
1328    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1329    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
1330    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
1331    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1332    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
1333    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
1334    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1335    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
1336    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
1337    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8" 
1338    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
1339    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
1340    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"  
1341    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
1342    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
1343    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
1344    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
1345    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
1346    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
1347    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
1348    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
1349    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
1350    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
1351    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
1352    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
1353    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
1354    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
1355    "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
1356    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
1357         
1358
1359 Known Limitations, Issues and Workarounds
1360 -----------------------------------------
1361
1362     * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
1363     * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
1364     * HV-VES - Pod recovery when config-fetch fails (DCAEGEN2-2516)
1365     
1366
1367 *System Limitations*
1368
1369 None
1370
1371 *Known Vulnerabilities*
1372
1373 None
1374
1375 *Workarounds*
1376
1377 Documented under corresponding jira if applicable.
1378
1379 Security Notes
1380 --------------
1381
1382 *Fixed Security Issues*
1383     Listed above
1384     
1385 *Known Security Issues*
1386
1387         None
1388         
1389         
1390 *Known Vulnerabilities in Used Modules*
1391
1392         None
1393         
1394 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>`_.
1395
1396 Test Results
1397 ------------
1398
1399  - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
1400  - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
1401
1402
1403 References
1404 ----------
1405
1406 For more information on the ONAP Guilin release, please see:
1407
1408 #. `ONAP Home Page`_
1409 #. `ONAP Documentation`_
1410 #. `ONAP Release Downloads`_
1411 #. `ONAP Wiki Page`_
1412
1413
1414 .. _`ONAP Home Page`: https://www.onap.org
1415 .. _`ONAP Wiki Page`: https://wiki.onap.org
1416 .. _`ONAP Documentation`: https://docs.onap.org
1417 .. _`ONAP Release Downloads`: https://git.onap.org
1418
1419 Quick Links:
1420
1421         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1422         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1423
1424
1425
1426
1427 ..      ======================================
1428 ..      * * *    EL-ALTO  MAINTENANCE  * * *
1429 ..      ======================================
1430
1431
1432 Version: 5.0.2
1433 ==============
1434
1435 Abstract
1436 --------
1437
1438 This document provides the release notes for the El-Alto Maintenance release
1439
1440
1441 Summary
1442 -------
1443
1444 This maintenance release is primarily to update expired certificates 
1445 from original El-Alto released TLS-init container.
1446
1447 This patch is not required for Frankfurt release (and beyond) as certificates are dynamically 
1448 retrieved from AAF at deployment time for all DCAE components.
1449
1450 Release Data
1451 ------------
1452
1453 +--------------------------------------+--------------------------------------+
1454 | **Project**                          | DCAE                                 |
1455 |                                      |                                      |
1456 +--------------------------------------+--------------------------------------+
1457 | **Docker images**                    | onap/org.onap.dcaegen2.deployments   |
1458 |                                      |   .tls-init-container:1.0.4          |
1459 +--------------------------------------+--------------------------------------+
1460 | **Release designation**              | El-Alto  Maintenance Release         |
1461 |                                      |                                      |
1462 +--------------------------------------+--------------------------------------+
1463 | **Release date**                     | 2020/08/24                           |
1464 |                                      |                                      |
1465 +--------------------------------------+--------------------------------------+
1466
1467 New features
1468 ------------
1469
1470 None
1471
1472 **Bug fixes**
1473
1474 - `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
1475
1476 **Known Issues**
1477 Same as El-Alto Release
1478
1479
1480
1481 ..      ======================================
1482 ..      * * *    FRANKFURT  MAINTENANCE  * * *
1483 ..      ======================================
1484
1485
1486 Version: 6.0.1
1487 ==============
1488
1489 Abstract
1490 --------
1491
1492 This document provides the release notes for the Frankfurt Maintenance release
1493
1494
1495 Summary
1496 -------
1497
1498 The focus of this release is to correct issues found on Frankfurt release.
1499
1500 Release Data
1501 ------------
1502
1503 +--------------------------------------+--------------------------------------+
1504 | **Project**                          | DCAE                                 |
1505 |                                      |                                      |
1506 +--------------------------------------+--------------------------------------+
1507 | **Docker images**                    | onap/org.onap.dcaegen2.services.     |
1508 |                                      |   son-handler:2.0.4                  |
1509 +--------------------------------------+--------------------------------------+
1510 | **Release designation**              | Frankfurt  Maintenance Release 1     |
1511 |                                      |                                      |
1512 +--------------------------------------+--------------------------------------+
1513 | **Release date**                     | 2020/08/17                           |
1514 |                                      |                                      |
1515 +--------------------------------------+--------------------------------------+
1516
1517 New features
1518 ------------
1519
1520 None
1521
1522 **Bug fixes**
1523
1524 - `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
1525 - `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification  to align with policy component updates
1526
1527 **Known Issues**
1528
1529 Same as Frankfurt Release
1530
1531
1532
1533
1534 ..      ===========================
1535 ..      * * *    FRANKFURT    * * *
1536 ..      ===========================
1537
1538
1539 Version: 6.0.0
1540 ==============
1541
1542
1543 Abstract
1544 --------
1545
1546 This document provides the release notes for the Frankfurt release.
1547
1548 Summary
1549 -------
1550
1551 Following DCAE components are available with default ONAP/DCAE installation.
1552
1553     - Platform components
1554
1555         - Cloudify Manager (helm chart)
1556         - Bootstrap container (helm chart)
1557         - Configuration Binding Service (helm chart)
1558         - Deployment Handler (helm chart)
1559         - Policy Handler (helm chart
1560         - Service Change Handler (helm chart)
1561         - Inventory API (helm chart)
1562         - Dashboard (helm chart)
1563
1564     - Service components
1565
1566         - VES Collector
1567         - Threshold Crossing Analytics (TCA/CDAP)
1568         - HV-VES Collector
1569         - PNF-Registration Handler
1570         - Docker based Threshold Crossing Analytics (TCA-Gen2)
1571         - Holmes Rule Management *
1572         - Holmes Engine Management *
1573
1574     - Additional resources that DCAE utilizes deployed using ONAP common charts:
1575     
1576         - Postgres Database
1577         - Mongo Database
1578         - Redis Cluster Database
1579         - Consul Cluster 
1580
1581 Below service components (mS) are available to be deployed on-demand.
1582
1583         - SNMPTrap Collector
1584         - RESTConf Collector
1585         - DataFile Collector
1586         - PM-Mapper 
1587         - BBS-EventProcessor
1588         - VES Mapper
1589         - Heartbeat mS
1590         - SON-Handler
1591         - PM-Subscription Handler
1592
1593     Notes:
1594
1595         \*  These components are delivered by the Holmes project.
1596
1597
1598
1599 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.
1600
1601
1602 Release Data
1603 ------------
1604
1605 +--------------------------------------+--------------------------------------------------------+
1606 | **DCAE Project**                     |                                                        |
1607 |                                      |                                                        |
1608 +--------------------------------------+--------------------------------------------------------+
1609 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
1610 |                                      |                                                        |
1611 +--------------------------------------+--------------------------------------------------------+
1612 | **Release designation**              | 6.0.0 frankfurt                                        |
1613 |                                      |                                                        |
1614 +--------------------------------------+--------------------------------------------------------+
1615 | **Release date**                     | 2020-06-04                                             |
1616 |                                      |                                                        |
1617 +--------------------------------------+--------------------------------------------------------+
1618
1619
1620 New features
1621 ------------
1622
1623 - DCAE Platform Enhancement
1624
1625     - Introduction of Microservice and Onboarding Design (MOD) platform 
1626     - Policy Notification support for DCAE components
1627     - Dynamic AAF certificate creation during component instantiation
1628     - Helm chart optimization to control each platform component separate
1629     - Dashboard Optimization 
1630     - Blueprint generator tool to simplify deployment artifact creation
1631    
1632
1633 - Following new services are delivered this release
1634
1635     - Event Processors
1636     
1637         - PM Subscription Handler
1638         - DataLake Handlers 
1639     - Analytics/RCA
1640     
1641         - TCA-GEN2
1642         
1643         - Acumos Adapter (PoC)
1644
1645 .. _frankfurt_deliverable:
1646
1647 Deliverables
1648 ------------
1649
1650 Software Deliverables
1651
1652 .. csv-table::
1653    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1654    :widths: auto
1655
1656    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
1657    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
1658    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
1659    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
1660    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
1661    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
1662    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
1663    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
1664    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1665    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
1666    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
1667    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
1668    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
1669    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1670    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
1671    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
1672    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1673    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
1674    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
1675    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1676    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
1677    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
1678    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
1679    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
1680    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
1681    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
1682    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
1683    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
1684    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
1685    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
1686    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
1687    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
1688    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
1689    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
1690    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
1691    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
1692    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
1693    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
1694    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
1695    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
1696         
1697
1698 Known Limitations, Issues and Workarounds
1699 -----------------------------------------
1700
1701     * Blueprint generator escape char issue (DCAEGEN2-2140)
1702     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
1703     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
1704
1705
1706
1707 *System Limitations*
1708
1709 None
1710
1711 *Known Vulnerabilities*
1712
1713 None
1714
1715 *Workarounds*
1716
1717 Documented under corresponding jira if applicable.
1718
1719 Security Notes
1720 --------------
1721
1722 *Fixed Security Issues*
1723
1724     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1725     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1726     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1727     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1728     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1729
1730     
1731 *Known Security Issues*
1732
1733         None
1734         
1735         
1736 *Known Vulnerabilities in Used Modules*
1737
1738         None
1739         
1740 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>`_.
1741
1742 Test Results
1743 ------------
1744
1745  - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
1746  - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
1747
1748
1749 References
1750 ----------
1751
1752 For more information on the ONAP Frankfurt release, please see:
1753
1754 #. `ONAP Home Page`_
1755 #. `ONAP Documentation`_
1756 #. `ONAP Release Downloads`_
1757 #. `ONAP Wiki Page`_
1758
1759
1760 .. _`ONAP Home Page`: https://www.onap.org
1761 .. _`ONAP Wiki Page`: https://wiki.onap.org
1762 .. _`ONAP Documentation`: https://docs.onap.org
1763 .. _`ONAP Release Downloads`: https://git.onap.org
1764
1765 Quick Links:
1766
1767         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1768         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1769
1770
1771 ..      =========================
1772 ..      * * *    EL-ALTO    * * *
1773 ..      =========================
1774
1775
1776 Version: 5.0.1
1777 ==============
1778
1779 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
1780
1781 Following is summary of updates done for DCAEGEN2
1782
1783 **Security**
1784
1785 Following platform components were enabled for HTTPS
1786     - ConfigBindingService (CBS)
1787       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
1788     - Cloudify Manager
1789     - InventoryAPI
1790     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
1791
1792 All components interfacing with platform components were modified to support TLS interface
1793
1794 **Miscellaneous**
1795     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1796     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1797     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1798     - CBS client libraries updated to remove consul service lookup
1799     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
1800
1801
1802
1803 With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
1804     - Platform components
1805         - Cloudify Manager (helm chart)
1806         - Bootstrap container (helm chart)
1807         - Configuration Binding Service (helm chart)
1808         - Deployment Handler (helm chart)
1809         - Policy Handler (helm chart
1810         - Service Change Handler (helm chart)
1811         - Inventory API (helm chart)
1812         - Dashboard (helm charts)
1813     - Service components
1814         - VES Collector
1815         - SNMP Collector
1816         - Threshold Crossing Analytics
1817         - HV-VES Collector
1818         - PNF-Registration Handler
1819         - Holmes Rule Management *
1820         - Holmes Engine Management *
1821     - Additional resources that DCAE utilizes:
1822         - Postgres Database
1823         - Redis Cluster Database
1824         - Consul Cluster *
1825
1826     Notes:
1827         \*  These components are delivered by external ONAP project.
1828
1829 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
1830
1831     - Collectors
1832         - RESTConf collectorĀ 
1833         - DataFile collector
1834     - Event Processors
1835         - VES Mapper
1836         - 3gpp PM-Mapper
1837         - BBS Event processor
1838     - Analytics/RCA
1839         - SON-Handler
1840         - Missing Heartbeat Ms
1841
1842 - All DCAE components are designed to support platform maturity requirements.
1843
1844
1845 **Source Code**
1846
1847 Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
1848     - dcaegen2
1849     - dcaegen2.analytics.tca
1850     - dcaegen2.collectors.snmptrap
1851     - dcaegen2.collectors.ves
1852     - dcaegen2.collectors.hv-ves
1853     - dcaegen2.collectors.datafile
1854     - dcaegen2.collectors.restconf
1855     - dcaegen2.deployments
1856     - dcaegen2.platform.blueprints
1857     - dcaegen2.platform.cli
1858     - dcaegen2.platform.configbinding
1859     - dcaegen2.platform.deployment-handler
1860     - dcaegen2.platform.inventory-api
1861     - dcaegen2.platform.plugins
1862     - dcaegen2.platform.policy-handler
1863     - dcaegen2.platform.servicechange-handler
1864     - dcaegen2.services.heartbeat
1865     - dcaegen2.services.mapper
1866     - dcaegen2.services.pm-mapper
1867     - dcaegen2.services.prh
1868     - dcaegen2.services.son-handler
1869     - dcaegen2.services
1870     - dcaegen2.services.sdk
1871     - dcaegen2.utils
1872     - ccsdk.platform.plugins
1873     - ccsdk.dashboard
1874
1875 **Bug Fixes**
1876     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1877     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1878
1879
1880 **Known Issues**
1881     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1882
1883 **Security Notes**
1884
1885 *Fixed Security Issues*
1886     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1887     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1888     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1889     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1890     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1891
1892 *Known Security Issues*
1893     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1894     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1895     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1896     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1897     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1898
1899 *Known Vulnerabilities in Used Modules*
1900
1901 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>`_.
1902
1903 Quick Links:
1904         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1905
1906         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1907
1908         - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1909
1910
1911 **Upgrade Notes**
1912
1913 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
1914     - K8S Bootstrap container:
1915        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
1916        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1917     - Configuration Binding Service:
1918        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
1919        - Description: HTTPS support, Image optimization and non-root user
1920     - Inventory API
1921        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1922        - Description: HTTPS support, container optmization and non-root user
1923     - DataFile Collector
1924        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
1925        - Description : Code optimization, bug fixes, dmaap plugin integration
1926     - SON Handler MS
1927        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
1928        - Description : Image optimization, bug fixes, CBS integration
1929     - VES Adapter/Mapper MS
1930        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
1931        - Description : Image optimization & CBS periodic polling
1932     - PRH MS
1933        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
1934        - Description : Code optimization, bug fixes and SDK alignment
1935     - HV-VES MS
1936        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
1937        - Description : Code optimization, bug fixes and SDK alignment
1938
1939 Version: 5.0.0
1940 ==============
1941
1942 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
1943
1944 Following is summary of updates done for DCAEGEN2
1945
1946 **Security**
1947
1948 Following platform components were enabled for HTTPS
1949     - ConfigBindingService (CBS)
1950       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
1951     - Cloudify Manager
1952     - InventoryAPI
1953
1954 All components interfacing with platform components were modified to support TLS interface
1955
1956 **Miscellaneous**
1957     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1958     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1959     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1960     - CBS client libraries updated to remove consul service lookup
1961
1962
1963
1964 **Bug Fixes**
1965     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1966     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1967
1968
1969 **Known Issues**
1970     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1971
1972
1973 **Security Notes**
1974
1975 *Fixed Security Issues*
1976
1977 *Known Security Issues*
1978
1979     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1980     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1981     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1982     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1983     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1984     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1985     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1986     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1987     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1988     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1989
1990 *Known Vulnerabilities in Used Modules*
1991
1992 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>`_.
1993
1994 Quick Links:
1995         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1996
1997         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1998
1999         - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
2000
2001
2002 **Upgrade Notes**
2003
2004 The following components are upgraded from Dublin/R4.
2005     - Cloudify Manager:
2006        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
2007        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5. The container was updated to support TLS.
2008     - K8S Bootstrap container:
2009        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
2010        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
2011     - Configuration Binding Service:
2012        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
2013        - Description: HTTPS support, Image optimization and non-root user
2014     - Deployment Handler
2015        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
2016        - Description: Update to node10, uninstall workflow updates
2017     - Service Change Handler
2018        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
2019        - Description: HTTPS inventoryAPI support, container optmization and non-root user
2020     - Inventory API
2021        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
2022        - Description: HTTPS support, container optmization and non-root user
2023     - DataFile Collector
2024        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
2025        - Description : Code optimization, bug fixes, dmaap plugin integration
2026     - 3gpp PM-Mapper
2027        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
2028        - Description: Code optimization, bug fixes, dmaap plugin integration
2029
2030
2031
2032 Version: 4.0.0
2033 ==============
2034
2035 :Release Date: 2019-06-06
2036
2037 **New Features**
2038
2039 DCAE R4 improves upon previous release with the following new features:
2040
2041 - DCAE Platform Enhancement
2042     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
2043     - Support helm chart deployment in DCAE using new Helm cloudify plugin
2044     - DCAE Healthcheck enhancement to cover static and dynamic deployments
2045     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
2046     - Dashboard Integration (UI for deployment/verification)
2047     - PolicyHandler Enhancement to support new Policy Lifecycle APIā€™s
2048     - Blueprint generator tool to simplify deployment artifact creation
2049     - Cloudify Manager resiliency
2050
2051 - Following new services are delivered with Dublin
2052     - Collectors
2053         - RESTConf collectorĀ 
2054     - Event Processors
2055         - VES Mapper
2056         - 3gpp PM-Mapper
2057         - BBS Event processor
2058     - Analytics/RCA
2059         - SON-Handler
2060         - Heartbeat MS
2061
2062 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
2063     - Platform components
2064         - Cloudify Manager (helm chart)
2065         - Bootstrap container (helm chart)
2066         - Configuration Binding Service (helm chart)
2067         - Deployment Handler (helm chart)
2068         - Policy Handler (helm chart
2069         - Service Change Handler (helm chart)
2070         - Inventory API (helm chart)
2071         - Dashboard (Cloudify Blueprint)
2072     - Service components
2073         - VES Collector
2074         - SNMP Collector
2075         - Threshold Crossing Analytics
2076         - HV-VES Collector
2077         - PNF-Registration Handler
2078         - Holmes Rule Management *
2079         - Holmes Engine Management *
2080     - Additional resources that DCAE utilizes:
2081         - Postgres Database
2082         - Redis Cluster Database
2083         - Consul Cluster *
2084
2085     Notes:
2086         \*  These components are delivered by the Holmes project.
2087
2088
2089 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.
2090
2091 - All DCAE components are designed to support platform maturity requirements.
2092
2093
2094 **Source Code**
2095
2096 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2097     - dcaegen2
2098     - dcaegen2.analytics.tca
2099     - dcaegen2.collectors.snmptrap
2100     - dcaegen2.collectors.ves
2101     - dcaegen2.collectors.hv-ves
2102     - dcaegen2.collectors.datafile
2103     - dcaegen2.collectors.restconf
2104     - dcaegen2.deployments
2105     - dcaegen2.platform.blueprints
2106     - dcaegen2.platform.cli
2107     - dcaegen2.platform.configbinding
2108     - dcaegen2.platform.deployment-handler
2109     - dcaegen2.platform.inventory-api
2110     - dcaegen2.platform.plugins
2111     - dcaegen2.platform.policy-handler
2112     - dcaegen2.platform.servicechange-handler
2113     - dcaegen2.services.heartbeat
2114     - dcaegen2.services.mapper
2115     - dcaegen2.services.pm-mapper
2116     - dcaegen2.services.prh
2117     - dcaegen2.services.son-handler
2118     - dcaegen2.services
2119     - dcaegen2.services.sdk
2120     - dcaegen2.utils
2121     - ccsdk.platform.plugins
2122     - ccsdk.dashboard
2123
2124 **Bug Fixes**
2125
2126 **Known Issues**
2127     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
2128
2129
2130 **Security Notes**
2131
2132 *Fixed Security Issues*
2133
2134 *Known Security Issues*
2135
2136     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
2137     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
2138     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
2139     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
2140     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
2141     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
2142     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
2143     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
2144     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
2145     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
2146
2147 *Known Vulnerabilities in Used Modules*
2148
2149 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>`_.
2150
2151 Quick Links:
2152         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2153
2154         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2155
2156         - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
2157
2158
2159 **New component Notes**
2160 The following components are introduced in R4
2161
2162     - Dashboard
2163        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
2164        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
2165     - Blueprint generator
2166        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
2167        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
2168     - RESTConf collectorĀ 
2169        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
2170        - Description: Provides RESTConf interfaces to events from external domain controllers
2171     - VES/Universal Mapper
2172        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
2173        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
2174     - 3gpp PM-Mapper
2175        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
2176        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
2177     - BBS Event processor
2178        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
2179        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
2180     - SON-Handler
2181        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
2182        - Description: Supports PC-ANR optimization analysis and generating CL events output
2183     - Heartbeat MS
2184        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
2185        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
2186
2187
2188 **Upgrade Notes**
2189
2190 The following components are upgraded from R3
2191     - Cloudify Manager:
2192        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
2193        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
2194     - K8S Bootstrap container:
2195        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
2196        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
2197     - Configuration Binding Service:
2198        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
2199        - Description: Code optimization and bug fixes
2200     - Deployment Handler
2201        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
2202        - Include updates for health and service endpoint check and bug fixes
2203     - Policy Handler
2204        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
2205        - Description: Policy Handler supports the new lifecycle API's from Policy framework
2206     - Service Change Handler
2207        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
2208        - Description: No update from R3
2209     - Inventory API
2210        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
2211        - Description: Refactoring and updates for health and service endpoint check
2212     - VES Collector
2213        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
2214        - Description : Authentication enhancement, refactoring and bug-fixes
2215     - Threshold Crossing Analytics
2216        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
2217        - 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.
2218     - DataFile Collector
2219        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
2220        - Description : Code optimization, bug fixes, logging and performance improvement
2221     - PNF Registrator handler
2222        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
2223        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
2224     - HV-VES Collector
2225        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
2226        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
2227     - SNMP Trap Collector
2228        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
2229        - Description : Code coverage improvements
2230
2231
2232
2233
2234 Version: 3.0.1
2235 ==============
2236
2237 :Release Date: 2019-01-31
2238
2239 DCAE R3 Maintenance release includes following fixes
2240
2241 **Bug Fixes**
2242
2243 - DataFileCollector
2244      - DCAEGEN2-940
2245        Larger files of size 100Kb publish to DR
2246      - DCAEGEN2-941
2247        DFC error after running over 12 hours
2248      - DCAEGEN2-1001
2249        Multiple Fileready notification not handled
2250
2251 - HighVolume VES Collector (protobuf/tcp)
2252      - DCAEGEN2-976
2253        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
2254
2255 - VESCollector (http)
2256      - DCAEGEN2-1035
2257        Issue with VES batch event publish
2258
2259 - Heat deployment
2260      - DCAEGEN2-1007
2261        Removing obsolete services configuration
2262
2263
2264 The following containers are updated in R3.0.1
2265
2266     - DataFile Collector
2267        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
2268     - HV-VES Collector
2269        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
2270     - VES Collector
2271        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
2272
2273 **Known Issues**
2274
2275 - 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
2276
2277 - 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
2278     kubectl get deployments -n onap | grep deployment-handler
2279     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
2280     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
2281
2282
2283
2284
2285 Version: 3.0.0
2286 --------------
2287
2288 :Release Date: 2018-11-30
2289
2290 **New Features**
2291
2292 DCAE R3 improves upon previous release with the following new features:
2293
2294 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
2295     - Platform components
2296         - Cloudify Manager
2297         - Bootstrap container
2298         - Configuration Binding Service
2299         - Deployment Handler
2300         - Policy Handler
2301         - Service Change Handler
2302         - Inventory API
2303     - Service components
2304         - VES Collector
2305         - SNMP Collector
2306         - Threshold Crossing Analytics
2307         - Holmes Rule Management *
2308         - Holmes Engine Management *
2309     - Additional resources that DCAE utilizes:
2310         - Postgres Database
2311         - Redis Cluster Database
2312         - Consul Cluster
2313
2314     Notes:
2315         \*  These components are delivered by the Holmes project.
2316
2317 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
2318
2319     - 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".
2320     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
2321
2322 - 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.
2323
2324 - All DCAE components are designed to support platform maturity requirements.
2325
2326
2327 **Source Code**
2328
2329 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2330     - dcaegen2
2331     - dcaegen2.analytics
2332     - dcaegen2.analytics.tca
2333     - dcaegen2.collectors
2334     - dcaegen2.collectors.snmptrap
2335     - dcaegen2.collectors.ves
2336     - dcaegen2.collectors.hv-ves
2337     - dcaegen2.collectors.datafile
2338     - dcaegen2.deployments
2339     - dcaegen2.platform
2340     - dcaegen2.platform.blueprints
2341     - dcaegen2.platform.cli
2342     - dcaegen2.platform.configbinding
2343     - dcaegen2.platform.deployment-handler
2344     - dcaegen2.platform.inventory-api
2345     - dcaegen2.platform.plugins
2346     - dcaegen2.platform.policy-handler
2347     - dcaegen2.platform.servicechange-handler
2348     - dcaegen2.services.heartbeat
2349     - dcaegen2.services.mapper
2350     - dcaegen2.services.prh
2351     - dcaegen2.utils
2352
2353 **Bug Fixes**
2354
2355 **Known Issues**
2356
2357 - 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.
2358
2359 **Security Notes**
2360
2361 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>`_.
2362
2363 Quick Links:
2364         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2365
2366         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2367
2368         - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
2369
2370
2371 **New component Notes**
2372 The following components are introduced in R3
2373
2374     - DataFile Collector
2375        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
2376        - Description : Bulk data file collector to fetch non-realtime PM data
2377     - PNF Registrator handler
2378        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
2379        - Description : Recieves VES registration event and updates AAI and SO
2380     - HV-VES Collector
2381        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
2382        - Description : High Volume VES Collector for fetching real-time PM measurement data
2383     - SNMP Trap Collector
2384        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
2385        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
2386
2387
2388 **Upgrade Notes**
2389
2390 The following components are upgraded from R2:
2391     - Cloudify Manager:
2392        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
2393        - 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.
2394     - Bootstrap container:
2395        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
2396        - 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.
2397     - Configuration Binding Service:
2398        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
2399        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
2400     - Deployment Handler
2401        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
2402     - Policy Handler
2403        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
2404        - Description: Policy Handler now supports the new configuration policy format and support for TLS
2405     - Service Change Handler
2406        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
2407        - Description: Refactoring.
2408     - Inventory API
2409        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
2410        - Description: Refactoring.
2411     - VES Collector
2412        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
2413        - Description : Refactoring
2414     - Threshold Crossing Analytics
2415        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
2416        - 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.
2417
2418
2419
2420
2421 Version: 2.0.0
2422 ==============
2423
2424 :Release Date: 2018-06-07
2425
2426 **New Features**
2427
2428 DCAE R2 improves upon previous release with the following new features:
2429
2430 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
2431     - Platform components
2432         - Cloudify Manager
2433         - Bootstrap container
2434         - Configuration Binding Service
2435         - Deployment Handler
2436         - Policy Handler
2437         - Service Change Handler
2438         - Inventory API
2439     - Service components
2440         - VES Collector
2441         - SNMP Collector
2442         - Threshold Crossing Analytics
2443         - Holmes Rule Management *
2444         - Holmes Engine Management *
2445     - Additional resources that DCAE utilizes:
2446         - Postgres Database
2447         - Redis Cluster Database
2448         - Consul Cluster
2449
2450     Notes:
2451         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
2452
2453 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
2454
2455     - 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".
2456     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
2457
2458 - 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.
2459
2460 - All DCAE components are designed to support platform maturity requirements.
2461
2462
2463 **Source Code**
2464
2465 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2466     - dcaegen2
2467     - dcaegen2.analytics
2468     - dcaegen2.analytics.tca
2469     - dcaegen2.collectors
2470     - dcaegen2.collectors.snmptrap
2471     - dcaegen2.collectors.ves
2472     - dcaegen2.deployments
2473     - dcaegen2.platform
2474     - dcaegen2.platform.blueprints
2475     - dcaegen2.platform.cli
2476     - dcaegen2.platform.configbinding
2477     - dcaegen2.platform.deployment-handler
2478     - dcaegen2.platform.inventory-api
2479     - dcaegen2.platform.plugins
2480     - dcaegen2.platform.policy-handler
2481     - dcaegen2.platform.servicechange-handler
2482     - dcaegen2.services.heartbeat
2483     - dcaegen2.services.mapper
2484     - dcaegen2.services.prh
2485     - dcaegen2.utils
2486
2487 **Bug Fixes**
2488
2489 **Known Issues**
2490
2491 - 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.
2492
2493 **Security Notes**
2494
2495 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>`_.
2496
2497 Quick Links:
2498         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2499
2500         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2501
2502         - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
2503
2504
2505
2506 **Upgrade Notes**
2507
2508 The following components are upgraded from R1:
2509     - Cloudify Manager:
2510        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
2511        - 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.
2512     - Bootstrap container:
2513        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
2514        - 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.
2515     - Configuration Binding Service:
2516        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
2517        - Description: Configuration Binding Sevice now supports the new configuration policy format.
2518     - Deployment Handler
2519        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
2520     - Policy Handler
2521        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
2522        - Description: Policy Handler now supports the new configuration policy format.
2523     - Service Change Handler
2524        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
2525        - Description: Refactoring.
2526     - Inventory API
2527        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
2528        - Description: Refactoring.
2529     - VES Collector
2530        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
2531     - Threshold Crossing Analytics
2532        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
2533        - 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.
2534
2535
2536
2537 Version: 1.0.0
2538 ==============
2539
2540 :Release Date: 2017-11-16
2541
2542
2543 **New Features**
2544
2545 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
2546 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
2547 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
2548 vDNS, vCPU, and vVoLTE.
2549
2550 Specifically, DCAE R1 includes the following components:
2551
2552 - Core platform
2553     - Cloudify manager
2554     - Consul cluster
2555 - Extended platform
2556     - Platform component docker host
2557     - Service component docker host
2558     - CDAP cluster
2559     - PostgreSQL database (*)
2560 - Platform docker container components
2561     - Configuration binding service
2562     - Deployment handler
2563     - Service change handler
2564     - Inventory
2565     - Policy handler
2566     - CDAP broker
2567 - Service components
2568     - Docker container components
2569         - VNF Event Streaming (VES) collector
2570         - Holmes (engine and rule management) **
2571     - CDAP analytics component
2572         - Threshold Crossing Analytics (TCA)
2573
2574 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
2575 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
2576 other deployment configurations not used in the R1 demos.)
2577 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
2578 in R1.
2579
2580 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
2581
2582 - dcaegen2
2583 - dcaegen2/analytics
2584 - dcaegen2/analytics/tca
2585 - dcaegen2/collectors
2586 - dcaegen2/collectors/snmptrap
2587 - dcaegen2/collectors/ves
2588 - dcaegen2/deployments
2589 - dcaegen2/platform
2590 - dcaegen2/platform/blueprints
2591 - dcaegen2/platform/cdapbroker
2592 - dcaegen2/platform/cli
2593 - dcaegen2/platform/configbinding
2594 - dcaegen2/platform/deployment-handler
2595 - dcaegen2/platform/inventory-api
2596 - dcaegen2/platform/plugins
2597 - dcaegen2/platform/policy-handler
2598 - dcaegen2/platform/servicechange-handler
2599 - dcaegen2/utils
2600
2601
2602 **Bug Fixes**
2603
2604 This is the initial release.
2605
2606
2607 **Known Issues**
2608
2609 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
2610 - Need to provide a dev configuration DCAE.
2611
2612
2613 **Security Issues**
2614
2615 - 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>`_.>`_.
2616 - 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.
2617
2618
2619 **Upgrade Notes**
2620
2621 This is the initial release.
2622
2623
2624 **Deprecation Notes**
2625
2626 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
2627 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
2628 following Gerrit repos are voided and already locked as read-only.
2629
2630 - dcae
2631 - dcae/apod
2632 - dcae/apod/analytics
2633 - dcae/apod/buildtools
2634 - dcae/apod/cdap
2635 - dcae/collectors
2636 - dcae/collectors/ves
2637 - dcae/controller
2638 - dcae/controller/analytics
2639 - dcae/dcae-inventory
2640 - dcae/demo
2641 - dcae/demo/startup
2642 - dcae/demo/startup/aaf
2643 - dcae/demo/startup/controller
2644 - dcae/demo/startup/message-router
2645 - dcae/dmaapbc
2646 - dcae/operation
2647 - dcae/operation/utils
2648 - dcae/orch-dispatcher
2649 - dcae/pgaas
2650 - dcae/utils
2651 - dcae/utils/buildtools
2652 - ncomp
2653 - ncomp/cdap
2654 - ncomp/core
2655 - ncomp/docker
2656 - ncomp/maven
2657 - ncomp/openstack
2658 - ncomp/sirius
2659 - ncomp/sirius/manager
2660 - ncomp/utils
2661
2662
2663 **Other**
2664
2665 SNMP trap collector is seed code delivery only.