docs/sections/version_9.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 ..      * * *    ISTANBUL    * * *
   6 ..      ==========================
   7
   8
   9 Version: 9.0.0
  10 ==============
  11
  12
  13 Abstract
  14 --------
  15
  16 This document provides the release notes for Istanbul 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
  42     - Additional resources that DCAE utilizes deployed using ONAP common charts:
  43
  44         - Postgres Database
  45         - Mongo Database
  46         - Consul Cluster
  47
  48     \*  These components will be retired next ONAP release as cloudify deployments will be diabled after Istanbul.
  49
  50
  51 Below service components (mS) are available to be deployed on-demand (helm chart & Cloudify Blueprint)
  52
  53         - SNMPTrap Collector
  54         - RESTConf Collector
  55         - DataFile Collector
  56         - PM-Mapper
  57         - BBS-EventProcessor
  58         - VES Mapper
  59         - Heartbeat mS
  60         - SON-Handler
  61         - PM-Subscription Handler
  62         - DataLake Handler (Admin and Feeder)
  63         - Slice Analysis mS
  64         - DataLake Extraction Service
  65         - KPI-Ms
  66
  67
  68 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
  69 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.
  70
  71 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>`.
  72
  73 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.
  74
  75
  76 Release Data
  77 ------------
  78
  79 +--------------------------------------+--------------------------------------------------------+
  80 | **DCAE Project**                     |                                                        |
  81 |                                      |                                                        |
  82 +--------------------------------------+--------------------------------------------------------+
  83 | **Docker images**                    | Refer :any:`Deliverable <istanbul_deliverable>`        |
  84 |                                      |                                                        |
  85 +--------------------------------------+--------------------------------------------------------+
  86 | **Release designation**              | 9.0.0 Istanbul                                         |
  87 |                                      |                                                        |
  88 +--------------------------------------+--------------------------------------------------------+
  89 | **Release date**                     | 2021-11-18                                             |
  90 |                                      |                                                        |
  91 +--------------------------------------+--------------------------------------------------------+
  92
  93
  94 New features
  95 ------------
  96
  97 *DCAE Enhancements Features*
  98
  99 DCAEGEN2-2771 DCAE Impacts for E2E Network Slicing in Istanbul release
 100     - SliceAnalysis and KPI-Computation MS migrated from ConfigDb to CPS
 101     - Integration with new CBS client SDK and support policy sidecar
 102
 103 DCAEGEN2-2703 Add stndDefined domain to HV-VES
 104     - HV_VES microservice was adapted to support stdDefined domain introduced under VES7.2.1 spec
 105
 106 DCAEGEN2-2630 DCAE Helm Transformation (Phase 2)
 107     - All DCAE microservices migration to helm was completed in Istanbul release. Since Honolulu, 13 additional MS has been delivered added for Helm deployment support
 108     - All DCAE Microservice are supported under both Helm and Cloudify/blueprint based deployments (legacy)
 109     - 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
 110             - K8S Secret/Environment mapping
 111             - CMPv2 Certificate support
 112             - Policy Sidecar
 113             - Mount data from configmap through PV/PVC
 114             - Topic/feed provisioning support
 115             - AAF certificates generation/distribution
 116             - Consul loader for application config
 117
 118     - Reducing Consul Dependency for DCAE components
 119          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.
 120
 121     - 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.
 122
 123 DCAEGEN2-2541 Bulk PM (PMSH) - Additional use cases, deployment and documentation enhancements
 124     - Enhanced PMSH Microservice to support subscription property updates, config updates to support 'n' subscriptions, support resource name in filter
 125
 126 DCAEGEN2-2522 Enhancements for OOF SON use case
 127     - Implemented CPS client interface (replacing ConfigDb)
 128     - Switched to new CBS client SDK for removing consul dependency and enabling policy configuration through sidecar.
 129
 130 *Non-Functional*
 131
 132    - Removed GPLv3 license from software by switching to onap/integration base images (DCAEGEN2-2455)
 133    - CII Badging improvements (DCAEGEN2-2622)
 134    - Healthcheck container Py3 upgrade  (DCAEGEN2-2737)
 135    - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS) (DCAEGEN2-2768)
 136
 137
 138 Bug Fixes
 139
 140    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
 141    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
 142
 143
 144 .. _istanbul_deliverable:
 145
 146 Deliverables
 147 ------------
 148
 149 Software Deliverables
 150
 151 .. csv-table::
 152    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 153    :widths: auto
 154
 155    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.1"
 156    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.6.1"
 157    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.9.1"
 158    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.5"
 159    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.5"
 160    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1"
 161    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
 162    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
 163    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
 164    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.2.0"
 165    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
 166    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
 167    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
 168    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
 169    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
 170    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
 171    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
 172    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
 173    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
 174    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.6"
 175    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
 176    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
 177    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
 178    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"
 179    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
 180    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
 181    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
 182    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
 183    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
 184    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
 185    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.3.2"
 186    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.6"
 187    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
 188    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.1"
 189    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
 190    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.3.0"
 191    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.7.2"
 192    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.7.1"
 193    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.5"
 194    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.8.0 (jar)"
 195    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.7 (jar)"
 196    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
 197
 198
 199 Known Limitations, Issues and Workarounds
 200 -----------------------------------------
 201
 202 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
 203 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
 204
 205
 206 *Known Vulnerabilities*
 207
 208 None
 209
 210 *Workarounds*
 211
 212 Documented under corresponding jira if applicable.
 213
 214 Security Notes
 215 --------------
 216
 217 *Fixed Security Issues*
 218
 219     Documented on earlier section
 220
 221 *Known Security Issues*
 222
 223     None
 224
 225 *Known Vulnerabilities in Used Modules*
 226
 227     None
 228
 229 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>`_.
 230
 231 Test Results
 232 ------------
 233
 234  - `DCAE R9 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Istanbul+Release>`_
 235  - `DCAE R9 Functional Test <https://wiki.onap.org/display/DW/DCAE+R9+Testplan>`_
 236
 237
 238 References
 239 ----------
 240
 241 For more information on the ONAP Honolulu release, please see:
 242
 243 #. `ONAP Home Page`_
 244 #. `ONAP Documentation`_
 245 #. `ONAP Release Downloads`_
 246 #. `ONAP Wiki Page`_
 247
 248
 249 .. _`ONAP Home Page`: https://www.onap.org
 250 .. _`ONAP Wiki Page`: https://wiki.onap.org
 251 .. _`ONAP Documentation`: https://docs.onap.org
 252 .. _`ONAP Release Downloads`: https://git.onap.org
 253
 254 Quick Links:
 255
 256         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 257         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_