docs/sections/installation_oom.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 DCAE Deployment (using Helm and Cloudify)
   5 =========================================
   6
   7 This document describes the details of the Helm chart based deployment process for R4 ONAP and how DCAE is deployed through this process.
   8
   9
  10 Deployment Overview
  11 -------------------
  12
  13 ONAP R4 extends the Kubernetes deployment method introduced in R2 and continued in R3.
  14 Kubernetes is a container orchestration technology that organizes containers into composites of various patterns for easy deployment, management, and scaling.
  15 ONAP uses Kubernetes as the foundation for fulfilling its platform maturity promises.
  16
  17 ONAP manages Kubernetes specifications using Helm charts, under which all Kubernetes yaml-formatted resource specifications and additional files
  18 are organized into a hierarchy of charts, sub-charts, and resources.  These yaml files are further augmented with Helm's templating, which makes dependencies
  19 and cross-references of parameters and parameter derivatives among resources manageable for a large and complex Kubernetes system such as ONAP.
  20
  21 At deployment time, with a single **helm deploy** command, Helm resolves all the templates and compiles the chart hierarchy into Kubernetes resource definitions,
  22 and invokes Kubernetes deployment operations for all the resources.
  23
  24 All ONAP Helm charts are organized under the **kubernetes** directory of the **OOM** project, where roughly each ONAP component occupies a subdirectory.
  25 DCAE charts are placed under the **dcaegen2** directory.
  26
  27 In Dublin, all DCAE platform components (exception of Dashboard) have corresponding Helm chart which will be used to trigger the deployment.
  28 All DCAE Services are deployed through Cloudify Blueprint. The default ONAP DCAE deployment includes small subset of DCAE services deployed through Bootstrap pod to meet
  29 ONAP Integration usecases. Optionally operators can deploy on-demand other MS required for their usecases as described in `On-demand MS Installation
  30 <installation_MS_ondemand>`_.
  31
  32 The PNDA data platform is an optional DCAE component that is placed under the **pnda**
  33 directory. Details for how to configure values to enable PNDA installation during Helm install
  34 are described in `Installing PNDA through Helm Chart
  35 <installation_pnda>`_.
  36
  37
  38 DCAE Chart Organization
  39 -----------------------
  40
  41 Following Helm conventions, the DCAE Helm chart directory (``oom/kubernetes/dcaegen2``) consists of the following files and subdirectories:
  42
  43 * ``Chart.yaml``: metadata.
  44 * ``requirements.yaml``: dependency charts.
  45 * ``values.yaml``: values for Helm templating engine to expand templates.
  46 * ``resources``: subdirectory for additional resource definitions such as configuration, scripts, etc.
  47 * ``templates``: subdirectory for Kubernetes resource definition templates.
  48 * ``charts``: subdirectory for sub-charts.
  49
  50 The dcaegen2 chart has the following sub-charts:
  51
  52 * ``dcae-bootstrap``: deploys the DCAE bootstrap service that performs some DCAE initialization and deploys additional DCAE components.
  53 * ``dcae-cloudify-manager``: deploys the DCAE Cloudify Manager instance.
  54 * ``dcae-config-binding-service``: deploys the DCAE config binding service.
  55 * ``dcae-deployment-handler``: deploys the DCAE deployment handler service.
  56 * ``dcae-healthcheck``: deploys the DCAE healthcheck service that provides an API to check the health of all DCAE components.
  57 * ``dcae-policy-handler``: deploys the DCAE policy handler service.
  58 * ``dcae-redis``: deploys the DCAE Redis cluster.
  59 * ``dcae-servicechange-handler``: deploys the DCAE service change handler service.  A subchart (``dcae-inventory-api``) deploys the DCAE inventory API service.
  60
  61 DCAE Deployment
  62 ---------------
  63
  64 At deployment time, when the **helm deploy** command is executed,
  65 all DCAE resources defined within the subcharts above are deployed.
  66 These include:
  67
  68 * the DCAE bootstrap service
  69 * the DCAE healthcheck service
  70 * the DCAE platform components:
  71
  72   * Cloudify Manager
  73   * Config binding service
  74   * Deployment handler
  75   * Policy handler
  76   * Service change handler
  77   * Inventory API service (launched as a subchart of service change handler)
  78   * Inventory postgres database service (launched as a dependency of the inventory API service)
  79   * DCAE postgres database service (launched as a dependency of the bootstrap service)
  80   * DCAE Redis cluster
  81
  82 Some of the DCAE subcharts include an initContainer that checks to see if
  83 other services that they need in order to run have become ready.  The installation
  84 of these subcharts will pause until the needed services are available.
  85
  86 In addition, DCAE operations depends on a Consul server cluster.
  87 For ONAP OOM deployment, the Consul cluster is provided as a shared
  88 resource. Its charts are defined under the ``oom/kubernetes/consul``
  89 directory, not as part of the DCAE chart hierarchy.
  90
  91 The dcae-bootstrap service has a number of prerequisites because the subsequently deployed DCAE components depends on a number of resources having entered their normal operation state.  DCAE bootstrap job will not start before these resources are ready.  They are:
  92
  93   * dcae-cloudify-manager
  94   * consul-server
  95   * msb-discovery
  96   * kube2msb
  97   * dcae-config-binding-service
  98   * dcae-db
  99
 100 Once started, the DCAE bootstrap service will call Cloudify Manager to deploy
 101 a series of blueprints which specify the additional DCAE R4 components.
 102 These blueprints use the DCAE Kubernetes plugin (``k8splugin``) to deploy
 103 Docker images into the ONAP Kubernetes cluster.  For each component, the plugin
 104 creates a Kubernetes deployment and other Kubernetes resources (services, volumes, logging sidecar, etc.)
 105 as needed.
 106
 107 The DCAE bootstrap service creates the following Kubernetes deployments:
 108
 109 * deploy/dep-dcae-dashboard
 110 * deploy/dep-dcae-hv-ves-collector
 111 * deploy/dep-dcae-prh
 112 * deploy/dep-dcae-snmptrap-collector
 113 * deploy/dep-dcae-tca-analytics
 114 * deploy/dep-dcae-ves-collector
 115 * deploy/dep-holmes-engine-mgmt
 116 * deploy/dep-holmes-rule-mgmt
 117
 118 After deploying all of the blueprints, the DCAE bootstrap service
 119 continues to run.   The bootstrap container can be useful for
 120 troubleshooting or for launching additional components.  The bootstrap
 121 container logs (accessed using the ``kubectl logs`` command) show the
 122 details of all of the component deployments.
 123
 124 DCAE Configuration
 125 ------------------
 126
 127 Deployment time configuration of DCAE components are defined in several places.
 128
 129   * Helm Chart templates:
 130      * Helm/Kubernetes template files can contain static values for configuration parameters;
 131   * Helm Chart resources:
 132      * Helm/Kubernetes resources files can contain static values for configuration parameters;
 133   * Helm values.yaml files:
 134      * The values.yaml files supply the values that Helm templating engine uses to expand any templates defined in Helm templates;
 135      * In a Helm chart hierarchy, values defined in values.yaml files in higher level supersedes values defined in values.yaml files in lower level;
 136      * Helm command line supplied values supersedes values defined in any values.yaml files.
 137
 138 In addition, for DCAE components deployed through Cloudify Manager blueprints, their configuration parameters are defined in the following places:
 139
 140      * The blueprint files can contain static values for configuration parameters;
 141         * The blueprint files are defined under the ``blueprints`` directory of the ``dcaegen2/platform/blueprints`` repo, named with "k8s" prefix.
 142      * The blueprint files can specify input parameters and the values of these parameters will be used for configuring parameters in Blueprints.  The values for these input parameters can be supplied in several ways as listed below in the order of precedence (low to high):
 143         * The blueprint files can define default values for the input parameters;
 144         * The blueprint input files can contain static values for input parameters of blueprints.  These input files are provided as config resources under the dcae-bootstrap chart;
 145         * The blueprint input files may contain Helm templates, which are resolved into actual deployment time values following the rules for Helm values.
 146
 147
 148 Now we walk through an example, how to configure the Docker image for the DCAE dashboard, which is deployed by Cloudify Manager.
 149
 150 In the ``k8s-dashboard.yaml-template`` blueprint template, the Docker image to use is defined as an input parameter with a default value:
 151
 152 .. code-block:: yaml
 153
 154   dashboard_docker_image:
 155     description: 'Docker image for dashboard'
 156     default: 'nexus3.onap.org:10001/onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0-SNAPSHOT-latest'
 157
 158 Then in the input file, ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/resources/inputs/k8s-dashboard-inputs.yaml``,
 159 it is defined again as:
 160
 161 .. code-block:: yaml
 162
 163   dashboard_docker_image: {{ include "common.repository" . }}/{{ .Values.componentImages.dashboard }}
 164
 165 Thus, when ``common.repository`` and ``componentImages.policy_handler`` are defined in the ``values.yaml`` files,
 166 their values will be plugged in here and the resulting ``policy_handler_image`` value
 167 will be passed to the Policy Handler blueprint as the Docker image tag to use instead of the default value in the blueprint.
 168
 169 Indeed the ``componentImages.dashboard`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file:
 170
 171 .. code-block:: yaml
 172
 173   componentImages:
 174     dashboard: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
 175
 176 The final result is that when DCAE bootstrap calls Cloudify Manager to deploy the DCAE dashboard, the 1.1.0 image will be deployed.
 177
 178 DCAE Service Endpoints
 179 ----------------------
 180
 181 Below is a table of default hostnames and ports for DCAE component service endpoints in Kubernetes deployment:
 182     ==================   =================================   ======================================================
 183     Component            Cluster Internal (host:port)        Cluster external (svc_name:port)
 184     ==================   =================================   ======================================================
 185     VES                  dcae-ves-collector:8080             xdcae-ves-collector.onap:30235
 186     HV-VES               dcae-hv-ves-collector:6061          xdcae-hv-ves-collector.onap:30222
 187     TCA                  dcae-tca-analytics:11011            xdcae-tca-analytics.onap:32010
 188     PRH                  dcae-prh:8100                       NA
 189     SNMPTrap             dcae-snmptrap-collector:6162/udp    xdcae-snmptrap-collector:30470/UDP
 190     Policy Handler       policy-handler:25577                NA
 191     Deployment Handler   deployment-handler:8443             NA
 192     Inventory            inventory:8080                      NA
 193     Config binding       config-binding-service:10000        config-binding-servicee:30415
 194     DCAE Healthcheck     dcae-healthcheck:80                 NA
 195     Cloudify Manager     dcae-cloudify-manager:80            NA
 196     DCAE Dashboard       dcae-dashboard:8080/8443            xdcae-dashboard:30418/30419
 197     ==================   =================================   ======================================================
 198
 199 In addition, a number of ONAP service endpoints that are used by DCAE components are listed as follows
 200 for reference by DCAE developers and testers:
 201
 202     ====================   ============================      ================================
 203     Component              Cluster Internal (host:port)      Cluster external (svc_name:port)
 204     ====================   ============================      ================================
 205     Consul Server          consul-server:8500                consul-server:30270
 206     Robot                  robot:88                          robot:30209 TCP
 207     Message router         message-router:3904               message-router:30227
 208     Message router         message-router:3905               message-router:30226
 209     Message router Kafka   message-router-kafka:9092         NA
 210     MSB Discovery          msb-discovery:10081               msb-discovery:30281
 211     Logging                log-kibana:5601                   log-kibana:30253
 212     AAI                    aai:8080                          aai:30232
 213     AAI                    aai:8443                          aai:30233
 214     ====================   ============================      ================================
 215
 216 Uninstalling DCAE
 217 -----------------
 218
 219 All of the DCAE components deployed using the OOM Helm charts will be
 220 deleted by the ``helm undeploy`` command.  This command can be used to
 221 uninstall all of ONAP by undeploying the top-level Helm release that was
 222 created by the ``helm deploy`` command.  The command can also be used to
 223 uninstall just DCAE, by having the command undeploy the `top_level_release_name`-``dcaegen2``
 224 Helm sub-release.
 225
 226 Helm will undeploy only the components that were originally deployed using
 227 Helm charts.  Components deployed by Cloudify Manager are not deleted by
 228 the Helm operations.
 229
 230 When uninstalling all of ONAP, it is sufficient to delete the namespace
 231 used for the deployment (typically ``onap``) after running the undeploy
 232 operation.  Deleting the namespace will get rid of any remaining resources
 233 in the namespace, including the components deployed by Cloudify Manager.
 234
 235 When uninstalling DCAE alone, deleting the namespace would delete the
 236 rest of ONAP as well.  To delete DCAE alone, and to make sure all of the
 237 DCAE components deployed by Cloudify Manager are uninstalled:
 238
 239 * Find the Cloudify Manager pod identifier, using a command like:
 240
 241   ``kubectl -n onap get pods | grep dcae-cloudify-manager``
 242 * Execute the DCAE cleanup script on the Cloudify Manager pod, using a command like:
 243
 244   ``kubectl -n onap exec`` `cloudify-manager-pod-id` ``-- /scripts/dcae-cleanup.sh``
 245 * Finally, run ``helm undeploy`` against the DCAE Helm subrelease
 246
 247 The DCAE cleanup script uses Cloudify Manager and the DCAE Kubernetes
 248 plugin to instruct Kubernetes to delete the components deployed by Cloudify
 249 Manager.  This includes the components deployed when the DCAE bootstrap
 250 service ran and any components deployed after bootstrap.