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 it 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.
Examples
To install ONAP using one of the public Helm Chart repos https://nexus.onap.org/content/sites/ (ie. staging):
- helm repo add staging https://nexus.onap.org/content/sites/oom-helm-staging/
- helm deploy demo staging/onap --namespace onap
This will install ONAP pods into the 'onap' Kubernetes namespace, with each component installed to a Helm release who's name is prefixed with "demo-"
To install ONAP from a cloned OOM repository:
- cd oom/kubernetes
- make repo
- make; make onap
- helm deploy demo local/onap --namespace onap (or helm deploy demo ./onap --namespace onap)
Any overrides that were used previously can still be applied. As shown below:
helm deploy demo local/onap --namespace onap -f ~/overrides.yaml --set vid.enabled=false
To delete the entire ONAP deployment:
helm undeploy demo --purge
Installation
To install, copy oom/kubernetes/helm/plugins directory into your local ~/.helm/ folder. After which you should see 'deploy' and 'undeploy' if you do a 'helm' with no arguments.
> helm
.......
Usage:
helm [command]
Available Commands:
autohelm helm autohelm plot <course.yml>
completion Generate autocompletions script for the specified shell (bash or zsh)
create create a new chart with the given name
delete given a release name, delete the release from Kubernetes
dependency manage a chart's dependencies
deploy install (upgrade if release exists) parent chart and subcharts as separate but related releases
fetch download a chart from a repository and (optionally) unpack it in local directory
...
template locally render templates
test test a release
undeploy delete parent chart and subcharts that were deployed as separate releases
upgrade upgrade a release
verify verify that a chart at the given path has been signed and is valid
version print the client/server version information