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