docs/oom_user_guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2018-2020 Amdocs, Bell Canada, Orange, Samsung
   5 .. _oom_user_guide:
   6
   7 .. Links
   8 .. _Curated applications for Kubernetes: https://github.com/kubernetes/charts
   9 .. _Services: https://kubernetes.io/docs/concepts/services-networking/service/
  10 .. _ReplicaSet: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
  11 .. _StatefulSet: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
  12 .. _Helm Documentation: https://docs.helm.sh/helm/
  13 .. _Helm: https://docs.helm.sh/
  14 .. _Kubernetes: https://Kubernetes.io/
  15 .. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer
  16 .. _user-guide-label:
  17
  18 OOM User Guide helm3 (experimental)
  19 ###################################
  20
  21 The ONAP Operations Manager (OOM) provide the ability to manage the entire
  22 life-cycle of an ONAP installation, from the initial deployment to final
  23 decommissioning. This guide provides instructions for users of ONAP to
  24 use the Kubernetes_/Helm_ system as a complete ONAP management system.
  25
  26 This guide provides many examples of Helm command line operations.  For a
  27 complete description of these commands please refer to the `Helm
  28 Documentation`_.
  29
  30 .. figure:: oomLogoV2-medium.png
  31    :align: right
  32
  33 The following sections describe the life-cycle operations:
  34
  35 - Deploy_ - with built-in component dependency management
  36 - Configure_ - unified configuration across all ONAP components
  37 - Monitor_ - real-time health monitoring feeding to a Consul UI and Kubernetes
  38 - Heal_- failed ONAP containers are recreated automatically
  39 - Scale_ - cluster ONAP services to enable seamless scaling
  40 - Upgrade_ - change-out containers or configuration with little or no service
  41   impact
  42 - Delete_ - cleanup individual containers or entire deployments
  43
  44 .. figure:: oomLogoV2-Deploy.png
  45    :align: right
  46
  47 Deploy
  48 ======
  49
  50 The OOM team with assistance from the ONAP project teams, have built a
  51 comprehensive set of Helm charts, yaml files very similar to TOSCA files, that
  52 describe the composition of each of the ONAP components and the relationship
  53 within and between components. Using this model Helm is able to deploy all of
  54 ONAP with a few simple commands.
  55
  56 Pre-requisites
  57 --------------
  58 Your environment must have both the Kubernetes `kubectl` and Helm setup as a
  59 one time activity.
  60
  61 Install Kubectl
  62 ~~~~~~~~~~~~~~~
  63 Enter the following to install kubectl (on Ubuntu, there are slight differences
  64 on other O/Ss), the Kubernetes command line interface used to manage a
  65 Kubernetes cluster::
  66
  67   > curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.15.11/bin/linux/amd64/kubectl
  68   > chmod +x ./kubectl
  69   > sudo mv ./kubectl /usr/local/bin/kubectl
  70   > mkdir ~/.kube
  71
  72 Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for
  73 alternative Kubernetes environment setups) into the `~/.kube/config` file.
  74
  75 Verify that the Kubernetes config is correct::
  76
  77   > kubectl get pods --all-namespaces
  78
  79 At this point you should see Kubernetes pods running.
  80
  81 Install Helm
  82 ~~~~~~~~~~~~
  83 Helm is used by OOM for package and configuration management. To install Helm,
  84 enter the following::
  85
  86   > wget https://get.helm.sh/helm-v3.5.2-linux-amd64.tar.gz
  87   > tar -zxvf helm-v3.5.2-linux-amd64.tar.gz
  88   > sudo mv linux-amd64/helm /usr/local/bin/helm
  89
  90 Verify the Helm version with::
  91
  92   > helm version
  93
  94 Install the Helm Repo
  95 ---------------------
  96 Once kubectl and Helm are setup, one needs to setup a local Helm server to
  97 server up the ONAP charts::
  98
  99   > helm install osn/onap
 100
 101 .. note::
 102   The osn repo is not currently available so creation of a local repository is
 103   required.
 104
 105 Helm is able to use charts served up from a repository and comes setup with a
 106 default CNCF provided `Curated applications for Kubernetes`_ repository called
 107 stable which should be removed to avoid confusion::
 108
 109   > helm repo remove stable
 110
 111 .. To setup the Open Source Networking Nexus repository for helm enter::
 112 ..  > helm repo add osn 'https://nexus3.onap.org:10001/helm/helm-repo-in-nexus/master/'
 113
 114 To prepare your system for an installation of ONAP, you'll need to::
 115
 116   > git clone -b guilin --recurse-submodules -j2 http://gerrit.onap.org/r/oom
 117   > cd oom/kubernetes
 118
 119
 120 To install a local Helm server::
 121
 122   > curl -LO https://s3.amazonaws.com/chartmuseum/release/latest/bin/linux/amd64/chartmuseum
 123   > chmod +x ./chartmuseum
 124   > mv ./chartmuseum /usr/local/bin
 125
 126 To setup a local Helm server to server up the ONAP charts::
 127
 128   > mkdir -p ~/helm3-storage
 129   > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 &
 130
 131 Note the port number that is listed and use it in the Helm repo add as
 132 follows::
 133
 134   > helm repo add local http://127.0.0.1:8879
 135
 136 To get a list of all of the available Helm chart repositories::
 137
 138   > helm repo list
 139   NAME   URL
 140   local  http://127.0.0.1:8879
 141
 142 Then build your local Helm repository::
 143
 144   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
 145
 146 `HELM_BIN`
 147   Sets the helm binary to be used. The default value use helm from PATH
 148
 149 The Helm search command reads through all of the repositories configured on the
 150 system, and looks for matches::
 151
 152   > helm search repo local
 153   NAME                    VERSION    DESCRIPTION
 154   local/appc              2.0.0      Application Controller
 155   local/clamp             2.0.0      ONAP Clamp
 156   local/common            2.0.0      Common templates for inclusion in other charts
 157   local/onap              2.0.0      Open Network Automation Platform (ONAP)
 158   local/robot             2.0.0      A helm Chart for kubernetes-ONAP Robot
 159   local/so                2.0.0      ONAP Service Orchestrator
 160
 161 In any case, setup of the Helm repository is a one time activity.
 162
 163 Next, install Helm Plugins required to deploy the ONAP release::
 164
 165   > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins
 166
 167 Once the repo is setup, installation of ONAP can be done with a single
 168 command::
 169
 170   > helm deploy development local/onap --namespace onap --set global.masterPassword=password
 171
 172 This will install ONAP from a local repository in a 'development' Helm release.
 173 As described below, to override the default configuration values provided by
 174 OOM, an environment file can be provided on the command line as follows::
 175
 176
 177
 178   > helm deploy development local/onap --namespace onap -f overrides.yaml --set global.masterPassword=password
 179
 180 .. note::
 181   Refer the Configure_ section on how to update overrides.yaml and values.yaml
 182
 183 To get a summary of the status of all of the pods (containers) running in your
 184 deployment::
 185
 186   > kubectl get pods --namespace onap -o=wide
 187
 188 .. note::
 189   The Kubernetes namespace concept allows for multiple instances of a component
 190   (such as all of ONAP) to co-exist with other components in the same
 191   Kubernetes cluster by isolating them entirely.  Namespaces share only the
 192   hosts that form the cluster thus providing isolation between production and
 193   development systems as an example.
 194
 195 .. note::
 196   The Helm `--name` option refers to a release name and not a Kubernetes namespace.
 197
 198
 199 To install a specific version of a single ONAP component (`so` in this example)
 200 with the given release name enter::
 201
 202   > helm deploy so onap/so --version 8.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap
 203
 204 .. note::
 205    The dependent components should be installed for component being installed
 206
 207
 208 To display details of a specific resource or group of resources type::
 209
 210   > kubectl describe pod so-1071802958-6twbl
 211
 212 where the pod identifier refers to the auto-generated pod identifier.
 213
 214 .. figure:: oomLogoV2-Configure.png
 215    :align: right
 216
 217 Configure
 218 =========
 219
 220 Each project within ONAP has its own configuration data generally consisting
 221 of: environment variables, configuration files, and database initial values.
 222 Many technologies are used across the projects resulting in significant
 223 operational complexity and an inability to apply global parameters across the
 224 entire ONAP deployment. OOM solves this problem by introducing a common
 225 configuration technology, Helm charts, that provide a hierarchical
 226 configuration with the ability to override values with higher
 227 level charts or command line options.
 228
 229 The structure of the configuration of ONAP is shown in the following diagram.
 230 Note that key/value pairs of a parent will always take precedence over those
 231 of a child. Also note that values set on the command line have the highest
 232 precedence of all.
 233
 234 .. graphviz::
 235
 236    digraph config {
 237       {
 238          node     [shape=folder]
 239          oValues  [label="values.yaml"]
 240          demo     [label="onap-demo.yaml"]
 241          prod     [label="onap-production.yaml"]
 242          oReq     [label="requirements.yaml"]
 243          soValues [label="values.yaml"]
 244          soReq    [label="requirements.yaml"]
 245          mdValues [label="values.yaml"]
 246       }
 247       {
 248          oResources  [label="resources"]
 249       }
 250       onap -> oResources
 251       onap -> oValues
 252       oResources -> environments
 253       oResources -> oReq
 254       oReq -> so
 255       environments -> demo
 256       environments -> prod
 257       so -> soValues
 258       so -> soReq
 259       so -> charts
 260       charts -> mariadb
 261       mariadb -> mdValues
 262
 263    }
 264
 265 The top level onap/values.yaml file contains the values required to be set
 266 before deploying ONAP.  Here is the contents of this file:
 267
 268 .. include:: ../kubernetes/onap/values.yaml
 269    :code: yaml
 270
 271 One may wish to create a value file that is specific to a given deployment such
 272 that it can be differentiated from other deployments.  For example, a
 273 onap-development.yaml file may create a minimal environment for development
 274 while onap-production.yaml might describe a production deployment that operates
 275 independently of the developer version.
 276
 277 For example, if the production OpenStack instance was different from a
 278 developer's instance, the onap-production.yaml file may contain a different
 279 value for the vnfDeployment/openstack/oam_network_cidr key as shown below.
 280
 281 .. code-block:: yaml
 282
 283   nsPrefix: onap
 284   nodePortPrefix: 302
 285   apps: consul msb mso message-router sdnc vid robot portal policy appc aai
 286   sdc dcaegen2 log cli multicloud clamp vnfsdk aaf kube2msb
 287   dataRootDir: /dockerdata-nfs
 288
 289   # docker repositories
 290   repository:
 291     onap: nexus3.onap.org:10001
 292     oom: oomk8s
 293     aai: aaionap
 294     filebeat: docker.elastic.co
 295
 296   image:
 297     pullPolicy: Never
 298
 299   # vnf deployment environment
 300   vnfDeployment:
 301     openstack:
 302       ubuntu_14_image: "Ubuntu_14.04.5_LTS"
 303       public_net_id: "e8f51956-00dd-4425-af36-045716781ffc"
 304       oam_network_id: "d4769dfb-c9e4-4f72-b3d6-1d18f4ac4ee6"
 305       oam_subnet_id: "191f7580-acf6-4c2b-8ec0-ba7d99b3bc4e"
 306       oam_network_cidr: "192.168.30.0/24"
 307   <...>
 308
 309
 310 To deploy ONAP with this environment file, enter::
 311
 312   > helm deploy local/onap -n onap -f onap/resources/environments/onap-production.yaml --set global.masterPassword=password
 313
 314 .. include:: environments_onap_demo.yaml
 315    :code: yaml
 316
 317 When deploying all of ONAP a requirements.yaml file control which and what
 318 version of the ONAP components are included.  Here is an excerpt of this
 319 file:
 320
 321 .. code-block:: yaml
 322
 323   # Referencing a named repo called 'local'.
 324   # Can add this repo by running commands like:
 325   # > helm serve
 326   # > helm repo add local http://127.0.0.1:8879
 327   dependencies:
 328   <...>
 329     - name: so
 330       version: ~8.0.0
 331       repository: '@local'
 332       condition: so.enabled
 333   <...>
 334
 335 The ~ operator in the `so` version value indicates that the latest "8.X.X"
 336 version of `so` shall be used thus allowing the chart to allow for minor
 337 upgrades that don't impact the so API; hence, version 8.0.1 will be installed
 338 in this case.
 339
 340 The onap/resources/environment/dev.yaml (see the excerpt below) enables
 341 for fine grained control on what components are included as part of this
 342 deployment. By changing this `so` line to `enabled: false` the `so` component
 343 will not be deployed.  If this change is part of an upgrade the existing `so`
 344 component will be shut down. Other `so` parameters and even `so` child values
 345 can be modified, for example the `so`'s `liveness` probe could be disabled
 346 (which is not recommended as this change would disable auto-healing of `so`).
 347
 348 .. code-block:: yaml
 349
 350   #################################################################
 351   # Global configuration overrides.
 352   #
 353   # These overrides will affect all helm charts (ie. applications)
 354   # that are listed below and are 'enabled'.
 355   #################################################################
 356   global:
 357   <...>
 358
 359   #################################################################
 360   # Enable/disable and configure helm charts (ie. applications)
 361   # to customize the ONAP deployment.
 362   #################################################################
 363   aaf:
 364     enabled: false
 365   <...>
 366   so: # Service Orchestrator
 367     enabled: true
 368
 369     replicaCount: 1
 370
 371     liveness:
 372       # necessary to disable liveness probe when setting breakpoints
 373       # in debugger so K8s doesn't restart unresponsive container
 374       enabled: true
 375
 376   <...>
 377
 378 Accessing the ONAP Portal using OOM and a Kubernetes Cluster
 379 ------------------------------------------------------------
 380
 381 The ONAP deployment created by OOM operates in a private IP network that isn't
 382 publicly accessible (i.e. OpenStack VMs with private internal network) which
 383 blocks access to the ONAP Portal. To enable direct access to this Portal from a
 384 user's own environment (a laptop etc.) the portal application's port 8989 is
 385 exposed through a `Kubernetes LoadBalancer`_ object.
 386
 387 Typically, to be able to access the Kubernetes nodes publicly a public address
 388 is assigned. In OpenStack this is a floating IP address.
 389
 390 When the `portal-app` chart is deployed a Kubernetes service is created that
 391 instantiates a load balancer.  The LB chooses the private interface of one of
 392 the nodes as in the example below (10.0.0.4 is private to the K8s cluster only).
 393 Then to be able to access the portal on port 8989 from outside the K8s &
 394 OpenStack environment, the user needs to assign/get the floating IP address that
 395 corresponds to the private IP as follows::
 396
 397   > kubectl -n onap get services|grep "portal-app"
 398   portal-app  LoadBalancer   10.43.142.201   10.0.0.4   8989:30215/TCP,8006:30213/TCP,8010:30214/TCP   1d   app=portal-app,release=dev
 399
 400
 401 In this example, use the 10.0.0.4 private address as a key find the
 402 corresponding public address which in this example is 10.12.6.155. If you're
 403 using OpenStack you'll do the lookup with the horizon GUI or the OpenStack CLI
 404 for your tenant (openstack server list).  That IP is then used in your
 405 `/etc/hosts` to map the fixed DNS aliases required by the ONAP Portal as shown
 406 below::
 407
 408   10.12.6.155 portal.api.simpledemo.onap.org
 409   10.12.6.155 vid.api.simpledemo.onap.org
 410   10.12.6.155 sdc.api.fe.simpledemo.onap.org
 411   10.12.6.155 sdc.workflow.plugin.simpledemo.onap.org
 412   10.12.6.155 sdc.dcae.plugin.simpledemo.onap.org
 413   10.12.6.155 portal-sdk.simpledemo.onap.org
 414   10.12.6.155 policy.api.simpledemo.onap.org
 415   10.12.6.155 aai.api.sparky.simpledemo.onap.org
 416   10.12.6.155 cli.api.simpledemo.onap.org
 417   10.12.6.155 msb.api.discovery.simpledemo.onap.org
 418   10.12.6.155 msb.api.simpledemo.onap.org
 419   10.12.6.155 clamp.api.simpledemo.onap.org
 420   10.12.6.155 so.api.simpledemo.onap.org
 421   10.12.6.155 sdc.workflow.plugin.simpledemo.onap.org
 422
 423 Ensure you've disabled any proxy settings the browser you are using to access
 424 the portal and then simply access now the new ssl-encrypted URL:
 425 ``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm``
 426
 427 .. note::
 428   Using the HTTPS based Portal URL the Browser needs to be configured to accept
 429   unsecure credentials.
 430   Additionally when opening an Application inside the Portal, the Browser
 431   might block the content, which requires to disable the blocking and reloading
 432   of the page
 433
 434 .. note::
 435   Besides the ONAP Portal the Components can deliver additional user interfaces,
 436   please check the Component specific documentation.
 437
 438 .. note::
 439
 440    | Alternatives Considered:
 441
 442    -  Kubernetes port forwarding was considered but discarded as it would require
 443       the end user to run a script that opens up port forwarding tunnels to each of
 444       the pods that provides a portal application widget.
 445
 446    -  Reverting to a VNC server similar to what was deployed in the Amsterdam
 447       release was also considered but there were many issues with resolution, lack
 448       of volume mount, /etc/hosts dynamic update, file upload that were a tall order
 449       to solve in time for the Beijing release.
 450
 451    Observations:
 452
 453    -  If you are not using floating IPs in your Kubernetes deployment and directly attaching
 454       a public IP address (i.e. by using your public provider network) to your K8S Node
 455       VMs' network interface, then the output of 'kubectl -n onap get services | grep "portal-app"'
 456       will show your public IP instead of the private network's IP. Therefore,
 457       you can grab this public IP directly (as compared to trying to find the floating
 458       IP first) and map this IP in /etc/hosts.
 459
 460 .. figure:: oomLogoV2-Monitor.png
 461    :align: right
 462
 463 Monitor
 464 =======
 465
 466 All highly available systems include at least one facility to monitor the
 467 health of components within the system.  Such health monitors are often used as
 468 inputs to distributed coordination systems (such as etcd, Zookeeper, or Consul)
 469 and monitoring systems (such as Nagios or Zabbix). OOM provides two mechanisms
 470 to monitor the real-time health of an ONAP deployment:
 471
 472 - a Consul GUI for a human operator or downstream monitoring systems and
 473   Kubernetes liveness probes that enable automatic healing of failed
 474   containers, and
 475 - a set of liveness probes which feed into the Kubernetes manager which
 476   are described in the Heal section.
 477
 478 Within ONAP, Consul is the monitoring system of choice and deployed by OOM in
 479 two parts:
 480
 481 - a three-way, centralized Consul server cluster is deployed as a highly
 482   available monitor of all of the ONAP components, and
 483 - a number of Consul agents.
 484
 485 The Consul server provides a user interface that allows a user to graphically
 486 view the current health status of all of the ONAP components for which agents
 487 have been created - a sample from the ONAP Integration labs follows:
 488
 489 .. figure:: consulHealth.png
 490    :align: center
 491
 492 To see the real-time health of a deployment go to: ``http://<kubernetes IP>:30270/ui/``
 493 where a GUI much like the following will be found:
 494
 495 .. note::
 496   If Consul GUI is not accessible, you can refer this
 497   `kubectl port-forward <https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/>`_ method to access an application
 498
 499 .. figure:: oomLogoV2-Heal.png
 500    :align: right
 501
 502 Heal
 503 ====
 504
 505 The ONAP deployment is defined by Helm charts as mentioned earlier.  These Helm
 506 charts are also used to implement automatic recoverability of ONAP components
 507 when individual components fail. Once ONAP is deployed, a "liveness" probe
 508 starts checking the health of the components after a specified startup time.
 509
 510 Should a liveness probe indicate a failed container it will be terminated and a
 511 replacement will be started in its place - containers are ephemeral. Should the
 512 deployment specification indicate that there are one or more dependencies to
 513 this container or component (for example a dependency on a database) the
 514 dependency will be satisfied before the replacement container/component is
 515 started. This mechanism ensures that, after a failure, all of the ONAP
 516 components restart successfully.
 517
 518 To test healing, the following command can be used to delete a pod::
 519
 520   > kubectl delete pod [pod name] -n [pod namespace]
 521
 522 One could then use the following command to monitor the pods and observe the
 523 pod being terminated and the service being automatically healed with the
 524 creation of a replacement pod::
 525
 526   > kubectl get pods --all-namespaces -o=wide
 527
 528 .. figure:: oomLogoV2-Scale.png
 529    :align: right
 530
 531 Scale
 532 =====
 533
 534 Many of the ONAP components are horizontally scalable which allows them to
 535 adapt to expected offered load.  During the Beijing release scaling is static,
 536 that is during deployment or upgrade a cluster size is defined and this cluster
 537 will be maintained even in the presence of faults. The parameter that controls
 538 the cluster size of a given component is found in the values.yaml file for that
 539 component.  Here is an excerpt that shows this parameter:
 540
 541 .. code-block:: yaml
 542
 543   # default number of instances
 544   replicaCount: 1
 545
 546 In order to change the size of a cluster, an operator could use a helm upgrade
 547 (described in detail in the next section) as follows::
 548
 549    > helm upgrade [RELEASE] [CHART] [flags]
 550
 551 The RELEASE argument can be obtained from the following command::
 552
 553    > helm list
 554
 555 Below is the example for the same::
 556
 557   > helm list
 558     NAME                    REVISION        UPDATED                         STATUS          CHART                   APP VERSION     NAMESPACE
 559     dev                     1               Wed Oct 14 13:49:52 2020        DEPLOYED        onap-8.0.0              Honolulu        onap
 560     dev-cassandra           5               Thu Oct 15 14:45:34 2020        DEPLOYED        cassandra-8.0.0                         onap
 561     dev-contrib             1               Wed Oct 14 13:52:53 2020        DEPLOYED        contrib-8.0.0                           onap
 562     dev-mariadb-galera      1               Wed Oct 14 13:55:56 2020        DEPLOYED        mariadb-galera-8.0.0                    onap
 563
 564 Here the Name column shows the RELEASE NAME, In our case we want to try the
 565 scale operation on cassandra, thus the RELEASE NAME would be dev-cassandra.
 566
 567 Now we need to obtain the chart name for casssandra. Use the below
 568 command to get the chart name::
 569
 570   > helm search cassandra
 571
 572 Below is the example for the same::
 573
 574   > helm search cassandra
 575     NAME                    CHART VERSION   APP VERSION     DESCRIPTION
 576     local/cassandra         8.0.0                           ONAP cassandra
 577     local/portal-cassandra  8.0.0                           Portal cassandra
 578     local/aaf-cass          8.0.0                           ONAP AAF cassandra
 579     local/sdc-cs            8.0.0                           ONAP Service Design and Creation Cassandra
 580
 581 Here the Name column shows the chart name. As we want to try the scale
 582 operation for cassandra, thus the correponding chart name is local/cassandra
 583
 584
 585 Now we have both the command's arguments, thus we can perform the
 586 scale opeartion for cassandra as follows::
 587
 588   > helm upgrade dev-cassandra local/cassandra --set replicaCount=3
 589
 590 Using this command we can scale up or scale down the cassadra db instances.
 591
 592
 593 The ONAP components use Kubernetes provided facilities to build clustered,
 594 highly available systems including: Services_ with load-balancers, ReplicaSet_,
 595 and StatefulSet_.  Some of the open-source projects used by the ONAP components
 596 directly support clustered configurations, for example ODL and MariaDB Galera.
 597
 598 The Kubernetes Services_ abstraction to provide a consistent access point for
 599 each of the ONAP components, independent of the pod or container architecture
 600 of that component.  For example, SDN-C uses OpenDaylight clustering with a
 601 default cluster size of three but uses a Kubernetes service to and change the
 602 number of pods in this abstract this cluster from the other ONAP components
 603 such that the cluster could change size and this change is isolated from the
 604 other ONAP components by the load-balancer implemented in the ODL service
 605 abstraction.
 606
 607 A ReplicaSet_ is a construct that is used to describe the desired state of the
 608 cluster.  For example 'replicas: 3' indicates to Kubernetes that a cluster of 3
 609 instances is the desired state.  Should one of the members of the cluster fail,
 610 a new member will be automatically started to replace it.
 611
 612 Some of the ONAP components many need a more deterministic deployment; for
 613 example to enable intra-cluster communication. For these applications the
 614 component can be deployed as a Kubernetes StatefulSet_ which will maintain a
 615 persistent identifier for the pods and thus a stable network id for the pods.
 616 For example: the pod names might be web-0, web-1, web-{N-1} for N 'web' pods
 617 with corresponding DNS entries such that intra service communication is simple
 618 even if the pods are physically distributed across multiple nodes. An example
 619 of how these capabilities can be used is described in the Running Consul on
 620 Kubernetes tutorial.
 621
 622 .. figure:: oomLogoV2-Upgrade.png
 623    :align: right
 624
 625 Upgrade
 626 =======
 627
 628 Helm has built-in capabilities to enable the upgrade of pods without causing a
 629 loss of the service being provided by that pod or pods (if configured as a
 630 cluster).  As described in the OOM Developer's Guide, ONAP components provide
 631 an abstracted 'service' end point with the pods or containers providing this
 632 service hidden from other ONAP components by a load balancer. This capability
 633 is used during upgrades to allow a pod with a new image to be added to the
 634 service before removing the pod with the old image. This 'make before break'
 635 capability ensures minimal downtime.
 636
 637 Prior to doing an upgrade, determine of the status of the deployed charts::
 638
 639   > helm list
 640   NAME REVISION UPDATED                  STATUS    CHART     NAMESPACE
 641   so   1        Mon Feb 5 10:05:22 2020  DEPLOYED  so-8.0.0  onap
 642
 643 When upgrading a cluster a parameter controls the minimum size of the cluster
 644 during the upgrade while another parameter controls the maximum number of nodes
 645 in the cluster.  For example, SNDC configured as a 3-way ODL cluster might
 646 require that during the upgrade no fewer than 2 pods are available at all times
 647 to provide service while no more than 5 pods are ever deployed across the two
 648 versions at any one time to avoid depleting the cluster of resources. In this
 649 scenario, the SDNC cluster would start with 3 old pods then Kubernetes may add
 650 a new pod (3 old, 1 new), delete one old (2 old, 1 new), add two new pods (2
 651 old, 3 new) and finally delete the 2 old pods (3 new).  During this sequence
 652 the constraints of the minimum of two pods and maximum of five would be
 653 maintained while providing service the whole time.
 654
 655 Initiation of an upgrade is triggered by changes in the Helm charts.  For
 656 example, if the image specified for one of the pods in the SDNC deployment
 657 specification were to change (i.e. point to a new Docker image in the nexus3
 658 repository - commonly through the change of a deployment variable), the
 659 sequence of events described in the previous paragraph would be initiated.
 660
 661 For example, to upgrade a container by changing configuration, specifically an
 662 environment value::
 663
 664   > helm upgrade so onap/so --version 8.0.1 --set enableDebug=true
 665
 666 Issuing this command will result in the appropriate container being stopped by
 667 Kubernetes and replaced with a new container with the new environment value.
 668
 669 To upgrade a component to a new version with a new configuration file enter::
 670
 671   > helm upgrade so onap/so --version 8.0.1 -f environments/demo.yaml
 672
 673 To fetch release history enter::
 674
 675   > helm history so
 676   REVISION UPDATED                  STATUS     CHART     DESCRIPTION
 677   1        Mon Feb 5 10:05:22 2020  SUPERSEDED so-8.0.0  Install complete
 678   2        Mon Feb 5 10:10:55 2020  DEPLOYED   so-8.0.1  Upgrade complete
 679
 680 Unfortunately, not all upgrades are successful.  In recognition of this the
 681 lineup of pods within an ONAP deployment is tagged such that an administrator
 682 may force the ONAP deployment back to the previously tagged configuration or to
 683 a specific configuration, say to jump back two steps if an incompatibility
 684 between two ONAP components is discovered after the two individual upgrades
 685 succeeded.
 686
 687 This rollback functionality gives the administrator confidence that in the
 688 unfortunate circumstance of a failed upgrade the system can be rapidly brought
 689 back to a known good state.  This process of rolling upgrades while under
 690 service is illustrated in this short YouTube video showing a Zero Downtime
 691 Upgrade of a web application while under a 10 million transaction per second
 692 load.
 693
 694 For example, to roll-back back to previous system revision enter::
 695
 696   > helm rollback so 1
 697
 698   > helm history so
 699   REVISION UPDATED                  STATUS     CHART     DESCRIPTION
 700   1        Mon Feb 5 10:05:22 2020  SUPERSEDED so-8.0.0  Install complete
 701   2        Mon Feb 5 10:10:55 2020  SUPERSEDED so-8.0.1  Upgrade complete
 702   3        Mon Feb 5 10:14:32 2020  DEPLOYED   so-8.0.0  Rollback to 1
 703
 704 .. note::
 705
 706   The description field can be overridden to document actions taken or include
 707   tracking numbers.
 708
 709 Many of the ONAP components contain their own databases which are used to
 710 record configuration or state information.  The schemas of these databases may
 711 change from version to version in such a way that data stored within the
 712 database needs to be migrated between versions. If such a migration script is
 713 available it can be invoked during the upgrade (or rollback) by Container
 714 Lifecycle Hooks. Two such hooks are available, PostStart and PreStop, which
 715 containers can access by registering a handler against one or both. Note that
 716 it is the responsibility of the ONAP component owners to implement the hook
 717 handlers - which could be a shell script or a call to a specific container HTTP
 718 endpoint - following the guidelines listed on the Kubernetes site. Lifecycle
 719 hooks are not restricted to database migration or even upgrades but can be used
 720 anywhere specific operations need to be taken during lifecycle operations.
 721
 722 OOM uses Helm K8S package manager to deploy ONAP components. Each component is
 723 arranged in a packaging format called a chart - a collection of files that
 724 describe a set of k8s resources. Helm allows for rolling upgrades of the ONAP
 725 component deployed. To upgrade a component Helm release you will need an
 726 updated Helm chart. The chart might have modified, deleted or added values,
 727 deployment yamls, and more.  To get the release name use::
 728
 729   > helm ls
 730
 731 To easily upgrade the release use::
 732
 733   > helm upgrade [RELEASE] [CHART]
 734
 735 To roll back to a previous release version use::
 736
 737   > helm rollback [flags] [RELEASE] [REVISION]
 738
 739 For example, to upgrade the onap-so helm release to the latest SO container
 740 release v1.1.2:
 741
 742 - Edit so values.yaml which is part of the chart
 743 - Change "so: nexus3.onap.org:10001/openecomp/so:v1.1.1" to
 744   "so: nexus3.onap.org:10001/openecomp/so:v1.1.2"
 745 - From the chart location run::
 746
 747   > helm upgrade onap-so
 748
 749 The previous so pod will be terminated and a new so pod with an updated so
 750 container will be created.
 751
 752 .. figure:: oomLogoV2-Delete.png
 753    :align: right
 754
 755 Delete
 756 ======
 757
 758 Existing deployments can be partially or fully removed once they are no longer
 759 needed.  To minimize errors it is recommended that before deleting components
 760 from a running deployment the operator perform a 'dry-run' to display exactly
 761 what will happen with a given command prior to actually deleting anything.
 762 For example::
 763
 764   > helm undeploy onap --dry-run
 765
 766 will display the outcome of deleting the 'onap' release from the
 767 deployment.
 768 To completely delete a release and remove it from the internal store enter::
 769
 770   > helm undeploy onap
 771
 772 Once complete undeploy is done then delete the namespace as well
 773 using following command::
 774
 775   >  kubectl delete namespace <name of namespace>
 776
 777 .. note::
 778    You need to provide the namespace name which you used during deployment,
 779    below is the example::
 780
 781    >  kubectl delete namespace onap
 782
 783 One can also remove individual components from a deployment by changing the
 784 ONAP configuration values.  For example, to remove `so` from a running
 785 deployment enter::
 786
 787   > helm undeploy onap-so
 788
 789 will remove `so` as the configuration indicates it's no longer part of the
 790 deployment. This might be useful if a one wanted to replace just `so` by
 791 installing a custom version.