Overview
In the Casablanca release ONAP has become very large with many Helm charts ( ~6 x that of Amsterdam ). Every Helm chart contains some amount of external configuration and, unfortunately, there is a limit to the amount of configuration that can exist in a Helm chart (1 MB). As of Casablanca, we in ONAP have exceeded this limit.
ONAP is installed as an umbrella (ie. parent) chart containing many subcharts, each with configuration. The total amount of configuration that resides in configmaps within K8s (exceeding 1MB) causes an installation of ONAP to fail. To work around this issue, a Helm plugin has been introduced that will install/upgrade ONAP by deploying the parent chart and each subchart within its own Helm "release". It is important to note that all releases must be deployed within the same Kubernetes namespace in order for communication between the components to succeed.
Disclaimer:
The plugins described here were introduced to address config map limitations in the Casablanca release. There are alternative projects, such as https://github.com/roboll/helmfile, that can also solve this problem.
The decision to not use an existing project was due to:
- not wanting to introduce a new project-specific deployment specification this late in the release cycle
- the desire to stay as close to an existing Helm solution as possible (we anticipate significant improvements in Helm 3)
That said, the use of deploy and undeploy plugins can be viewed as a temporary solution. In their current state, they have not been hardened (eg. resilient to networking errors) but are made available to unblock installation of ONAP. To avoid networking errors that can cause some of the sub-charts to fail to deploy, it is recommend that Helm deploy and undeploy commands execute from within the same network (e.g Rancher node or Jumpnode) as the K8s cluster you are deploying to.
Install Helm Plugins (deploy & undeploy)
Clone oom repository
Copy oom/kubernetes/helm/plugins directory into your local ~/.helm/ folder.
sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
Verify plugins installed correctly
Execute 'helm' (no arguments) should show both 'deploy' and 'undeploy' in list of available commands.
>sudo helm ....... Usage: Available Commands: dependency manage a chart's dependencies template locally render templates |
|---|
Deploying ONAP
Deploy from public Helm Chart Repository
Example is using one of the public Helm Chart repos https://nexus.onap.org/content/sites/ (ie. staging).
Prerequisite:
- helm repo add staging https://nexus.onap.org/content/sites/oom-helm-staging/
helm deploy demo staging/onap --namespace onap
Deploy from cloned OOM codebase
Prerequisites:
- clone oom repository
- cd oom/kubernetes
- make repo
- make; make onap
- use sudo for helm commands except when running root
sudo helm deploy demo local/onap --namespace onap
or
sudo helm deploy demo ./onap --namespace onap
Results
ONAP pods deployed into the 'onap' Kubernetes namespace. Each application project is installed as a Helm Release that is prefixed by the parent release name (e.g. "demo-")
> helm list |
|---|
Advanced Options
Note that any overrides that can be used using Helm install or update can be applied.
Customizing ONAP deployment using overrides *
helm deploy demo ./onap --namespace onap -f ~/overrides.yaml --set vid.enabled=false
Update (or install) a specific ONAP component *
helm deploy demo-robot ./onap --namespace onap -f ~/overrides.yaml --set vid.enabled=false
* Note that any in order for any changes to a Helm Chart to take affect, a make is required (e.g. "make; make onap" or "make robot; make onap")
Undeploying ONAP
Undeploy entire ONAP deployment
helm undeploy demo --purge
Undeploy specific ONAP component
helm undeploy demo-robot --purge