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