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
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 .. _`Docker installation guide`: https://docs.docker.com/engine/install/
22 The ONAP Operations Manager (OOM) provide the ability to manage the entire
23 life-cycle of an ONAP installation, from the initial deployment to final
24 decommissioning. This guide provides instructions for users of ONAP to
25 use the Kubernetes_/Helm_ system as a complete ONAP management system.
27 This guide provides many examples of Helm command line operations. For a
28 complete description of these commands please refer to the `Helm
31 .. figure:: oomLogoV2-medium.png
34 The following sections describe the life-cycle operations:
36 - Deploy_ - with built-in component dependency management
37 - Configure_ - unified configuration across all ONAP components
38 - Monitor_ - real-time health monitoring feeding to a Consul UI and Kubernetes
39 - Heal_- failed ONAP containers are recreated automatically
40 - Scale_ - cluster ONAP services to enable seamless scaling
41 - Upgrade_ - change-out containers or configuration with little or no service
43 - Delete_ - cleanup individual containers or entire deployments
45 .. figure:: oomLogoV2-Deploy.png
51 The OOM team with assistance from the ONAP project teams, have built a
52 comprehensive set of Helm charts, yaml files very similar to TOSCA files, that
53 describe the composition of each of the ONAP components and the relationship
54 within and between components. Using this model Helm is able to deploy all of
55 ONAP with a few simple commands.
59 Your environment must have Docker installed as well as both the Kubernetes
60 `kubectl` and Helm setup as a one time activity.
64 Follow official `Docker installation guide`_.
68 Enter the following to install kubectl (on Ubuntu, there are slight differences
69 on other O/Ss), the Kubernetes command line interface used to manage a
72 > curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.8.10/bin/linux/amd64/kubectl
74 > sudo mv ./kubectl /usr/local/bin/kubectl
77 Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for
78 alternative Kubernetes environment setups) into the `~/.kube/config` file.
80 Verify that the Kubernetes config is correct::
82 > kubectl get pods --all-namespaces
84 At this point you should see six Kubernetes pods running.
88 Helm is used by OOM for package and configuration management. To install Helm,
91 > wget http://storage.googleapis.com/kubernetes-helm/helm-v2.9.1-linux-amd64.tar.gz
92 > tar -zxvf helm-v2.9.1-linux-amd64.tar.gz
93 > sudo mv linux-amd64/helm /usr/local/bin/helm
95 Verify the Helm version with::
99 Install the Helm Tiller application and initialize with::
103 Install the Helm Repo
104 ---------------------
105 Once kubectl and Helm are setup, one needs to setup a local Helm server to
106 server up the ONAP charts::
108 > helm install osn/onap
111 The osn repo is not currently available so creation of a local repository is
114 Helm is able to use charts served up from a repository and comes setup with a
115 default CNCF provided `Curated applications for Kubernetes`_ repository called
116 stable which should be removed to avoid confusion::
118 > helm repo remove stable
120 .. To setup the Open Source Networking Nexus repository for helm enter::
121 .. > helm repo add osn 'https://nexus3.onap.org:10001/helm/helm-repo-in-nexus/master/'
123 To prepare your system for an installation of ONAP, you'll need to::
125 > git clone -b frankfurt --recurse-submodules -j2 http://gerrit.onap.org/r/oom
129 To setup a local Helm server to server up the ONAP charts::
134 Note the port number that is listed and use it in the Helm repo add as
137 > helm repo add local http://127.0.0.1:8879
139 To get a list of all of the available Helm chart repositories::
143 local http://127.0.0.1:8879
145 Then build your local Helm repository::
147 > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
150 Sets the helm binary to be used. The default value use helm from PATH.
151 Allow the user to have multiple version of helm in operating system and
152 choose which one to use.
154 The Helm search command reads through all of the repositories configured on the
155 system, and looks for matches::
158 NAME VERSION DESCRIPTION
159 local/appc 7.0.0 Application Controller
160 local/clamp 7.0.0 ONAP Clamp
161 local/common 7.0.0 Common templates for inclusion in other charts
162 local/onap 7.0.0 Open Network Automation Platform (ONAP)
163 local/robot 7.0.0 A helm Chart for kubernetes-ONAP Robot
164 local/so 7.0.0 ONAP Service Orchestrator
166 In any case, setup of the Helm repository is a one time activity.
168 Next, install Helm Plugins required to deploy the ONAP Casablanca release::
170 > cp -R helm/plugins/ ~/.helm
172 Once the repo is setup, installation of ONAP can be done with a single
175 > helm deploy development local/onap --namespace onap
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::
181 > helm deploy development local/onap --namespace onap -f overrides.yaml
183 To get a summary of the status of all of the pods (containers) running in your
186 > kubectl get pods --all-namespaces -o=wide
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. The OOM deployment of ONAP in Beijing is
194 now done within a single Kubernetes namespace where in Amsterdam a namespace
195 was created for each of the ONAP components.
198 The Helm `--name` option refers to a release name and not a Kubernetes namespace.
201 To install a specific version of a single ONAP component (`so` in this example)
202 with the given release name enter::
204 > helm deploy so onap/so --version 3.0.1
206 To display details of a specific resource or group of resources type::
208 > kubectl describe pod so-1071802958-6twbl
210 where the pod identifier refers to the auto-generated pod identifier.
212 .. figure:: oomLogoV2-Configure.png
218 Each project within ONAP has its own configuration data generally consisting
219 of: environment variables, configuration files, and database initial values.
220 Many technologies are used across the projects resulting in significant
221 operational complexity and an inability to apply global parameters across the
222 entire ONAP deployment. OOM solves this problem by introducing a common
223 configuration technology, Helm charts, that provide a hierarchical
224 configuration with the ability to override values with higher
225 level charts or command line options.
227 The structure of the configuration of ONAP is shown in the following diagram.
228 Note that key/value pairs of a parent will always take precedence over those
229 of a child. Also note that values set on the command line have the highest
237 oValues [label="values.yaml"]
238 demo [label="onap-demo.yaml"]
239 prod [label="onap-production.yaml"]
240 oReq [label="requirements.yaml"]
241 soValues [label="values.yaml"]
242 soReq [label="requirements.yaml"]
243 mdValues [label="values.yaml"]
246 oResources [label="resources"]
250 oResources -> environments
263 The top level onap/values.yaml file contains the values required to be set
264 before deploying ONAP. Here is the contents of this file:
266 .. include:: ../kubernetes/onap/values.yaml
269 One may wish to create a value file that is specific to a given deployment such
270 that it can be differentiated from other deployments. For example, a
271 onap-development.yaml file may create a minimal environment for development
272 while onap-production.yaml might describe a production deployment that operates
273 independently of the developer version.
275 For example, if the production OpenStack instance was different from a
276 developer's instance, the onap-production.yaml file may contain a different
277 value for the vnfDeployment/openstack/oam_network_cidr key as shown below.
283 apps: consul msb mso message-router sdnc vid robot portal policy appc aai
284 sdc dcaegen2 log cli multicloud clamp vnfsdk aaf kube2msb
285 dataRootDir: /dockerdata-nfs
287 # docker repositories
289 onap: nexus3.onap.org:10001
292 filebeat: docker.elastic.co
297 # vnf deployment environment
300 ubuntu_14_image: "Ubuntu_14.04.5_LTS"
301 public_net_id: "e8f51956-00dd-4425-af36-045716781ffc"
302 oam_network_id: "d4769dfb-c9e4-4f72-b3d6-1d18f4ac4ee6"
303 oam_subnet_id: "191f7580-acf6-4c2b-8ec0-ba7d99b3bc4e"
304 oam_network_cidr: "192.168.30.0/24"
308 To deploy ONAP with this environment file, enter::
310 > helm deploy local/onap -n onap -f environments/onap-production.yaml
312 .. include:: environments_onap_demo.yaml
315 When deploying all of ONAP a requirements.yaml file control which and what
316 version of the ONAP components are included. Here is an excerpt of this
321 # Referencing a named repo called 'local'.
322 # Can add this repo by running commands like:
324 # > helm repo add local http://127.0.0.1:8879
330 condition: so.enabled
333 The ~ operator in the `so` version value indicates that the latest "2.X.X"
334 version of `so` shall be used thus allowing the chart to allow for minor
335 upgrades that don't impact the so API; hence, version 2.0.1 will be installed
338 The onap/resources/environment/onap-dev.yaml (see the excerpt below) enables
339 for fine grained control on what components are included as part of this
340 deployment. By changing this `so` line to `enabled: false` the `so` component
341 will not be deployed. If this change is part of an upgrade the existing `so`
342 component will be shut down. Other `so` parameters and even `so` child values
343 can be modified, for example the `so`'s `liveness` probe could be disabled
344 (which is not recommended as this change would disable auto-healing of `so`).
348 #################################################################
349 # Global configuration overrides.
351 # These overrides will affect all helm charts (ie. applications)
352 # that are listed below and are 'enabled'.
353 #################################################################
357 #################################################################
358 # Enable/disable and configure helm charts (ie. applications)
359 # to customize the ONAP deployment.
360 #################################################################
364 so: # Service Orchestrator
370 # necessary to disable liveness probe when setting breakpoints
371 # in debugger so K8s doesn't restart unresponsive container
376 Accessing the ONAP Portal using OOM and a Kubernetes Cluster
377 ------------------------------------------------------------
379 The ONAP deployment created by OOM operates in a private IP network that isn't
380 publicly accessible (i.e. OpenStack VMs with private internal network) which
381 blocks access to the ONAP Portal. To enable direct access to this Portal from a
382 user's own environment (a laptop etc.) the portal application's port 8989 is
383 exposed through a `Kubernetes LoadBalancer`_ object.
385 Typically, to be able to access the Kubernetes nodes publicly a public address
386 is assigned. In OpenStack this is a floating IP address.
388 When the `portal-app` chart is deployed a Kubernetes service is created that
389 instantiates a load balancer. The LB chooses the private interface of one of
390 the nodes as in the example below (10.0.0.4 is private to the K8s cluster only).
391 Then to be able to access the portal on port 8989 from outside the K8s &
392 OpenStack environment, the user needs to assign/get the floating IP address that
393 corresponds to the private IP as follows::
395 > kubectl -n onap get services|grep "portal-app"
396 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 In this example, use the 10.0.0.4 private address as a key find the
400 corresponding public address which in this example is 10.12.6.155. If you're
401 using OpenStack you'll do the lookup with the horizon GUI or the OpenStack CLI
402 for your tenant (openstack server list). That IP is then used in your
403 `/etc/hosts` to map the fixed DNS aliases required by the ONAP Portal as shown
406 10.12.6.155 portal.api.simpledemo.onap.org
407 10.12.6.155 vid.api.simpledemo.onap.org
408 10.12.6.155 sdc.api.fe.simpledemo.onap.org
409 10.12.6.155 sdc.workflow.plugin.simpledemo.onap.org
410 10.12.6.155 sdc.dcae.plugin.simpledemo.onap.org
411 10.12.6.155 portal-sdk.simpledemo.onap.org
412 10.12.6.155 policy.api.simpledemo.onap.org
413 10.12.6.155 aai.api.sparky.simpledemo.onap.org
414 10.12.6.155 cli.api.simpledemo.onap.org
415 10.12.6.155 msb.api.discovery.simpledemo.onap.org
416 10.12.6.155 msb.api.simpledemo.onap.org
417 10.12.6.155 clamp.api.simpledemo.onap.org
418 10.12.6.155 so.api.simpledemo.onap.org
419 10.12.6.155 sdc.workflow.plugin.simpledemo.onap.org
421 Ensure you've disabled any proxy settings the browser you are using to access
422 the portal and then simply access now the new ssl-encrypted URL:
423 ``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm``
426 Using the HTTPS based Portal URL the Browser needs to be configured to accept
427 unsecure credentials.
428 Additionally when opening an Application inside the Portal, the Browser
429 might block the content, which requires to disable the blocking and reloading
433 Besides the ONAP Portal the Components can deliver additional user interfaces,
434 please check the Component specific documentation.
438 | Alternatives Considered:
440 - Kubernetes port forwarding was considered but discarded as it would require
441 the end user to run a script that opens up port forwarding tunnels to each of
442 the pods that provides a portal application widget.
444 - Reverting to a VNC server similar to what was deployed in the Amsterdam
445 release was also considered but there were many issues with resolution, lack
446 of volume mount, /etc/hosts dynamic update, file upload that were a tall order
447 to solve in time for the Beijing release.
451 - If you are not using floating IPs in your Kubernetes deployment and directly attaching
452 a public IP address (i.e. by using your public provider network) to your K8S Node
453 VMs' network interface, then the output of 'kubectl -n onap get services | grep "portal-app"'
454 will show your public IP instead of the private network's IP. Therefore,
455 you can grab this public IP directly (as compared to trying to find the floating
456 IP first) and map this IP in /etc/hosts.
458 .. figure:: oomLogoV2-Monitor.png
464 All highly available systems include at least one facility to monitor the
465 health of components within the system. Such health monitors are often used as
466 inputs to distributed coordination systems (such as etcd, Zookeeper, or Consul)
467 and monitoring systems (such as Nagios or Zabbix). OOM provides two mechanisms
468 to monitor the real-time health of an ONAP deployment:
470 - a Consul GUI for a human operator or downstream monitoring systems and
471 Kubernetes liveness probes that enable automatic healing of failed
473 - a set of liveness probes which feed into the Kubernetes manager which
474 are described in the Heal section.
476 Within ONAP, Consul is the monitoring system of choice and deployed by OOM in
479 - a three-way, centralized Consul server cluster is deployed as a highly
480 available monitor of all of the ONAP components, and
481 - a number of Consul agents.
483 The Consul server provides a user interface that allows a user to graphically
484 view the current health status of all of the ONAP components for which agents
485 have been created - a sample from the ONAP Integration labs follows:
487 .. figure:: consulHealth.png
490 To see the real-time health of a deployment go to: ``http://<kubernetes IP>:30270/ui/``
491 where a GUI much like the following will be found:
494 .. figure:: oomLogoV2-Heal.png
500 The ONAP deployment is defined by Helm charts as mentioned earlier. These Helm
501 charts are also used to implement automatic recoverability of ONAP components
502 when individual components fail. Once ONAP is deployed, a "liveness" probe
503 starts checking the health of the components after a specified startup time.
505 Should a liveness probe indicate a failed container it will be terminated and a
506 replacement will be started in its place - containers are ephemeral. Should the
507 deployment specification indicate that there are one or more dependencies to
508 this container or component (for example a dependency on a database) the
509 dependency will be satisfied before the replacement container/component is
510 started. This mechanism ensures that, after a failure, all of the ONAP
511 components restart successfully.
513 To test healing, the following command can be used to delete a pod::
515 > kubectl delete pod [pod name] -n [pod namespace]
517 One could then use the following command to monitor the pods and observe the
518 pod being terminated and the service being automatically healed with the
519 creation of a replacement pod::
521 > kubectl get pods --all-namespaces -o=wide
523 .. figure:: oomLogoV2-Scale.png
529 Many of the ONAP components are horizontally scalable which allows them to
530 adapt to expected offered load. During the Beijing release scaling is static,
531 that is during deployment or upgrade a cluster size is defined and this cluster
532 will be maintained even in the presence of faults. The parameter that controls
533 the cluster size of a given component is found in the values.yaml file for that
534 component. Here is an excerpt that shows this parameter:
538 # default number of instances
541 In order to change the size of a cluster, an operator could use a helm upgrade
542 (described in detail in the next section) as follows::
544 > helm upgrade --set replicaCount=3 onap/so/mariadb
546 The ONAP components use Kubernetes provided facilities to build clustered,
547 highly available systems including: Services_ with load-balancers, ReplicaSet_,
548 and StatefulSet_. Some of the open-source projects used by the ONAP components
549 directly support clustered configurations, for example ODL and MariaDB Galera.
551 The Kubernetes Services_ abstraction to provide a consistent access point for
552 each of the ONAP components, independent of the pod or container architecture
553 of that component. For example, SDN-C uses OpenDaylight clustering with a
554 default cluster size of three but uses a Kubernetes service to and change the
555 number of pods in this abstract this cluster from the other ONAP components
556 such that the cluster could change size and this change is isolated from the
557 other ONAP components by the load-balancer implemented in the ODL service
560 A ReplicaSet_ is a construct that is used to describe the desired state of the
561 cluster. For example 'replicas: 3' indicates to Kubernetes that a cluster of 3
562 instances is the desired state. Should one of the members of the cluster fail,
563 a new member will be automatically started to replace it.
565 Some of the ONAP components many need a more deterministic deployment; for
566 example to enable intra-cluster communication. For these applications the
567 component can be deployed as a Kubernetes StatefulSet_ which will maintain a
568 persistent identifier for the pods and thus a stable network id for the pods.
569 For example: the pod names might be web-0, web-1, web-{N-1} for N 'web' pods
570 with corresponding DNS entries such that intra service communication is simple
571 even if the pods are physically distributed across multiple nodes. An example
572 of how these capabilities can be used is described in the Running Consul on
575 .. figure:: oomLogoV2-Upgrade.png
581 Helm has built-in capabilities to enable the upgrade of pods without causing a
582 loss of the service being provided by that pod or pods (if configured as a
583 cluster). As described in the OOM Developer's Guide, ONAP components provide
584 an abstracted 'service' end point with the pods or containers providing this
585 service hidden from other ONAP components by a load balancer. This capability
586 is used during upgrades to allow a pod with a new image to be added to the
587 service before removing the pod with the old image. This 'make before break'
588 capability ensures minimal downtime.
590 Prior to doing an upgrade, determine of the status of the deployed charts::
593 NAME REVISION UPDATED STATUS CHART NAMESPACE
594 so 1 Mon Feb 5 10:05:22 2018 DEPLOYED so-2.0.1 default
596 When upgrading a cluster a parameter controls the minimum size of the cluster
597 during the upgrade while another parameter controls the maximum number of nodes
598 in the cluster. For example, SNDC configured as a 3-way ODL cluster might
599 require that during the upgrade no fewer than 2 pods are available at all times
600 to provide service while no more than 5 pods are ever deployed across the two
601 versions at any one time to avoid depleting the cluster of resources. In this
602 scenario, the SDNC cluster would start with 3 old pods then Kubernetes may add
603 a new pod (3 old, 1 new), delete one old (2 old, 1 new), add two new pods (2
604 old, 3 new) and finally delete the 2 old pods (3 new). During this sequence
605 the constraints of the minimum of two pods and maximum of five would be
606 maintained while providing service the whole time.
608 Initiation of an upgrade is triggered by changes in the Helm charts. For
609 example, if the image specified for one of the pods in the SDNC deployment
610 specification were to change (i.e. point to a new Docker image in the nexus3
611 repository - commonly through the change of a deployment variable), the
612 sequence of events described in the previous paragraph would be initiated.
614 For example, to upgrade a container by changing configuration, specifically an
617 > helm deploy onap onap/so --version 2.0.1 --set enableDebug=true
619 Issuing this command will result in the appropriate container being stopped by
620 Kubernetes and replaced with a new container with the new environment value.
622 To upgrade a component to a new version with a new configuration file enter::
624 > helm deploy onap onap/so --version 2.0.2 -f environments/demo.yaml
626 To fetch release history enter::
629 REVISION UPDATED STATUS CHART DESCRIPTION
630 1 Mon Feb 5 10:05:22 2018 SUPERSEDED so-2.0.1 Install complete
631 2 Mon Feb 5 10:10:55 2018 DEPLOYED so-2.0.2 Upgrade complete
633 Unfortunately, not all upgrades are successful. In recognition of this the
634 lineup of pods within an ONAP deployment is tagged such that an administrator
635 may force the ONAP deployment back to the previously tagged configuration or to
636 a specific configuration, say to jump back two steps if an incompatibility
637 between two ONAP components is discovered after the two individual upgrades
640 This rollback functionality gives the administrator confidence that in the
641 unfortunate circumstance of a failed upgrade the system can be rapidly brought
642 back to a known good state. This process of rolling upgrades while under
643 service is illustrated in this short YouTube video showing a Zero Downtime
644 Upgrade of a web application while under a 10 million transaction per second
647 For example, to roll-back back to previous system revision enter::
652 REVISION UPDATED STATUS CHART DESCRIPTION
653 1 Mon Feb 5 10:05:22 2018 SUPERSEDED so-2.0.1 Install complete
654 2 Mon Feb 5 10:10:55 2018 SUPERSEDED so-2.0.2 Upgrade complete
655 3 Mon Feb 5 10:14:32 2018 DEPLOYED so-2.0.1 Rollback to 1
659 The description field can be overridden to document actions taken or include
662 Many of the ONAP components contain their own databases which are used to
663 record configuration or state information. The schemas of these databases may
664 change from version to version in such a way that data stored within the
665 database needs to be migrated between versions. If such a migration script is
666 available it can be invoked during the upgrade (or rollback) by Container
667 Lifecycle Hooks. Two such hooks are available, PostStart and PreStop, which
668 containers can access by registering a handler against one or both. Note that
669 it is the responsibility of the ONAP component owners to implement the hook
670 handlers - which could be a shell script or a call to a specific container HTTP
671 endpoint - following the guidelines listed on the Kubernetes site. Lifecycle
672 hooks are not restricted to database migration or even upgrades but can be used
673 anywhere specific operations need to be taken during lifecycle operations.
675 OOM uses Helm K8S package manager to deploy ONAP components. Each component is
676 arranged in a packaging format called a chart - a collection of files that
677 describe a set of k8s resources. Helm allows for rolling upgrades of the ONAP
678 component deployed. To upgrade a component Helm release you will need an
679 updated Helm chart. The chart might have modified, deleted or added values,
680 deployment yamls, and more. To get the release name use::
684 To easily upgrade the release use::
686 > helm upgrade [RELEASE] [CHART]
688 To roll back to a previous release version use::
690 > helm rollback [flags] [RELEASE] [REVISION]
692 For example, to upgrade the onap-so helm release to the latest SO container
695 - Edit so values.yaml which is part of the chart
696 - Change "so: nexus3.onap.org:10001/openecomp/so:v1.1.1" to
697 "so: nexus3.onap.org:10001/openecomp/so:v1.1.2"
698 - From the chart location run::
700 > helm upgrade onap-so
702 The previous so pod will be terminated and a new so pod with an updated so
703 container will be created.
705 .. figure:: oomLogoV2-Delete.png
711 Existing deployments can be partially or fully removed once they are no longer
712 needed. To minimize errors it is recommended that before deleting components
713 from a running deployment the operator perform a 'dry-run' to display exactly
714 what will happen with a given command prior to actually deleting anything. For
717 > helm undeploy onap --dry-run
719 will display the outcome of deleting the 'onap' release from the
721 To completely delete a release and remove it from the internal store enter::
723 > helm undeploy onap --purge
725 One can also remove individual components from a deployment by changing the
726 ONAP configuration values. For example, to remove `so` from a running
729 > helm undeploy onap-so --purge
731 will remove `so` as the configuration indicates it's no longer part of the
732 deployment. This might be useful if a one wanted to replace just `so` by
733 installing a custom version.