docs/sections/version_8.0.0.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ..      ==========================
   5 ..      * * *    HONOLULU    * * *
   6 ..      ==========================
   7
   8
   9 Version: 8.0.0
  10 ==============
  11
  12
  13 Abstract
  14 --------
  15
  16 This document provides the release notes for Honolulu release.
  17
  18 Summary
  19 -------
  20
  21 Following DCAE components are available with default ONAP/DCAE installation.
  22
  23     - Platform components
  24
  25         - Cloudify Manager (helm chart)
  26         - Bootstrap container (helm chart)
  27         - Configuration Binding Service (helm chart)
  28         - Deployment Handler (helm chart)
  29         - Policy Handler (helm chart
  30         - Service Change Handler (helm chart)
  31         - Inventory API (helm chart)
  32         - Dashboard (helm chart)
  33         - VES OpenAPI Manager (helm chart)
  34
  35     - Service components
  36
  37         - VES Collector (helm chart  & cloudify blueprint)
  38         - HV-VES Collector (helm chart  & cloudify blueprint)
  39         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
  40         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
  41         - Holmes Rule Management (helm chart  & cloudify blueprint)
  42         - Holmes Engine Management (helm chart  & cloudify blueprint)
  43
  44     - Additional resources that DCAE utilizes deployed using ONAP common charts:
  45
  46         - Postgres Database
  47         - Mongo Database
  48         - Consul Cluster
  49
  50 Below service components (mS) are available to be deployed on-demand (through Cloudify Blueprint)
  51
  52         - SNMPTrap Collector
  53         - RESTConf Collector
  54         - DataFile Collector
  55         - PM-Mapper
  56         - BBS-EventProcessor
  57         - VES Mapper
  58         - Heartbeat mS
  59         - SON-Handler
  60         - PM-Subscription Handler
  61         - DataLake Handler (Admin and Feeder)
  62         - Slice Analysis mS
  63         - DataLake Extraction Service
  64         - KPI-Ms
  65
  66     Notes:
  67
  68         \*  These components are delivered by the Holmes project.
  69
  70
  71
  72 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.
  73
  74
  75 Release Data
  76 ------------
  77
  78 +--------------------------------------+--------------------------------------------------------+
  79 | **DCAE Project**                     |                                                        |
  80 |                                      |                                                        |
  81 +--------------------------------------+--------------------------------------------------------+
  82 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
  83 |                                      |                                                        |
  84 +--------------------------------------+--------------------------------------------------------+
  85 | **Release designation**              | 8.0.0 Honolulu                                         |
  86 |                                      |                                                        |
  87 +--------------------------------------+--------------------------------------------------------+
  88 | **Release date**                     | 2021-04-29                                             |
  89 |                                      |                                                        |
  90 +--------------------------------------+--------------------------------------------------------+
  91
  92
  93 New features
  94 ------------
  95
  96 *DCAE Enhancements*
  97
  98
  99 Functional Updates
 100
 101    - New service VES-Openapi-Manager component added to DCAE, allowing to notify of missing openAPI description, at xNF distribution phase (DCAEGEN2-2571)
 102    - Added VES 7.2.1 support in VESCollector (DCAEGEN2-2539, DCAEGEN2-2477)
 103    - DCAE MS deployment through helm with introduction of common dcae-service template to standardize charts with migration (DCAEGEN2-2488)
 104    - New service KPI-Computation MS introduced for support for E2E Slicing Usecase (DCAEGEN2-2521)
 105    - K8S configMap support through onboarding/design/deployment via DCAE-MOD and DCAE-Platform (DCAEGEN2-2539)
 106    - BP-generation Enhancements - support Native-kafka & Config-map through onboarding (DCAEGEN2-2458)
 107    - CFY plugin enhancements - support IPV6 service exposure + Config-Map + Cert-Manager's CMPv2 issuer integration (DCAEGEN2-2539, DCAEGEN2-2458, DCAEGEN2-2388)
 108    - DCAE SDK enhancement - Dmaap Client update for timeout/retry + CBS client update (DCAEGEN2-1483)
 109    - DFC enhancement - support in HTTP/HTTPS/enroll certificate from CMPv2 server (DCAEGEN2-2517)
 110
 111 Non-Functional
 112
 113    - DCAE Cloudify py3 upgrade including plugins/bootstrap cli (DCAEGEN2-1546)
 114    - CII Badging improvements (DCAEGEN2-2570)
 115    - Policy-Handler Py3 upgrade  (DCAEGEN2-2494)
 116    - Vulnerability updates for several DCAE MS (DataFile Collector, RESTConf, VESCollector, InventoryAPI, MOD/RuntimeAPI, VES-mapper, PM-Mapper, PRH, SON-Handler) (DCAEGEN2-2551)
 117    - Code Coverage improvement (DataFile, SDK, Blueprint-generator, Plugins, Acumos Adapter) (DCAEGEN2-2382)
 118    - Documentation/user-guide updates
 119
 120 Bug Fixes
 121
 122    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
 123    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
 124
 125
 126 - Following new services are delivered this release
 127     - VES OpenAPI Manager
 128     - KPI MS (Analytics/RCA)
 129
 130 .. _honolulu_deliverable:
 131
 132 Deliverables
 133 ------------
 134
 135 Software Deliverables
 136
 137 .. csv-table::
 138    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 139    :widths: auto
 140
 141    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
 142    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.5.5"
 143    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.6.0"
 144    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.4"
 145    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.4"
 146    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.8.0"
 147    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.4.2"
 148    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.0"
 149    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
 150    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
 151    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
 152    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.0"
 153    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
 154    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
 155    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
 156    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
 157    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
 158    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
 159    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
 160    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.4"
 161    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.0.4"
 162    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
 163    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
 164    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"
 165    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.2"
 166    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
 167    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
 168    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
 169    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
 170    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
 171    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
 172    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.4"
 173    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
 174    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.0"
 175    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
 176    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.2.0"
 177    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.5.2"
 178    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.6"
 179    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.3"
 180    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.7.3 (jar)"
 181    "dcaegen2/services/sdk", "", "DCAE SDK 1.7.0 (jar)"
 182    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
 183
 184
 185 Known Limitations, Issues and Workarounds
 186 -----------------------------------------
 187
 188 The new, Helm based installation mechanism for collectors doesn't support yet certain features available with the traditional Cloudify orchestration based mechanisms:
 189    - Obtaining X.509 certificates from external CMP v2 server for secure xNF connections
 190    - Exposing the Collector port in Dual Stack IPv4/IPv6 networks.
 191
 192 Such features are available, when the collectors are installed using the Cloudify mechanisms.
 193 Refer to collector installation page for more details:
 194
 195 .. toctree::
 196    :maxdepth: 1
 197
 198    ./services/ves-http/installation-helm.rst
 199    ./services/ves-hv/installation-helm.rst
 200
 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/pages/viewpage.action?pageId=51282478>`_.
 226
 227 Test Results
 228 ------------
 229
 230  - `DCAE R8 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Honolulu+Release>`_
 231  - `DCAE R8 Functional Test <https://wiki.onap.org/display/DW/DCAE+R8+Testplan>`_
 232
 233
 234 References
 235 ----------
 236
 237 For more information on the ONAP Honolulu 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>`_