5 Install (or upgrade) an umbrella Helm Chart, and its subcharts, as separate Helm Releases
7 The umbrella Helm Chart is broken apart into a parent release and subchart releases.
8 Subcharts the are disabled (<chart>.enabled=false) will not be installed or upgraded.
9 All releases are grouped and deployed within the same namespace.
12 The deploy arguments must be a release and chart. The chart
13 argument can be either: a chart reference('stable/onap'), a path to a chart directory,
14 a packaged chart, or a fully qualified URL. For chart references, the latest
15 version will be specified unless the '--version' flag is set.
17 To override values in a chart, use either the '--values' flag and pass in a file
18 or use the '--set' flag and pass configuration from the command line, to force string
19 values, use '--set-string'.
21 You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
22 last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
23 contained a key called 'Test', the value set in override.yaml would take precedence:
25 $ helm deploy demo ./onap --namespace onap -f openstack.yaml -f overrides.yaml
27 You can specify the '--set' flag multiple times. The priority will be given to the
28 last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
29 set for a key called 'foo', the 'newbar' value would take precedence:
31 $ helm deploy demo local/onap --namespace onap -f overrides.yaml --set log.enabled=false --set vid.enabled=false
34 helm deploy [RELEASE] [CHART] [flags]
37 --namespace string namespace to install the release into. Defaults to the current kube config namespace.
38 --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
39 --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
40 -f, --values valueFiles specify values in a YAML file or a URL(can specify multiple) (default [])
41 --verbose enables full helm install/upgrade output during deploy
42 --set-last-applied set the last-applied-configuration annotation on all objects.This annotation is required to restore services using Ark/Veloro backup restore.
46 generate_overrides() {
47 SUBCHART_NAMES=($(cat $COMPUTED_OVERRIDES | grep -v '^\s\s'))
49 for index in "${!SUBCHART_NAMES[@]}"; do
50 START=${SUBCHART_NAMES[index]}
51 END=${SUBCHART_NAMES[index+1]}
52 if [[ $START == "global:" ]]; then
53 echo "global:" > $GLOBAL_OVERRIDES
54 cat $COMPUTED_OVERRIDES | sed '/common:/,/consul:/d' \
55 | sed -n '/^'"$START"'/,/'log:'/p' | sed '1d;$d' >> $GLOBAL_OVERRIDES
57 SUBCHART_DIR="$CACHE_SUBCHART_DIR/$(cut -d':' -f1 <<<"$START")"
58 if [[ -d "$SUBCHART_DIR" ]]; then
59 if [[ -z "$END" ]]; then
60 cat $COMPUTED_OVERRIDES | sed -n '/^'"$START"'/,/'"$END"'/p' \
61 | sed '1d;$d' | cut -c3- > $SUBCHART_DIR/subchart-overrides.yaml
63 cat $COMPUTED_OVERRIDES | sed -n '/^'"$START"'/,/^'"$END"'/p' \
64 | sed '1d;$d' | cut -c3- > $SUBCHART_DIR/subchart-overrides.yaml
70 resolve_deploy_flags() {
73 for (( i = 0; i < n; i++ )); do
75 if [[ $PARAM == "-f" || \
76 $PARAM == "--values" || \
77 $PARAM == "--set" || \
78 $PARAM == "--set-string" || \
79 $PARAM == "--version" ]]; then
80 # skip param and its value
83 DEPLOY_FLAGS="$DEPLOY_FLAGS $PARAM"
91 if [[ -z "$1" || -z "$2" ]]; then
99 CHART_REPO="$(cut -d'/' -f1 <<<"$CHART_URL")"
100 CHART_NAME="$(cut -d'/' -f2 <<<"$CHART_URL")"
101 if [[ $HELM_VER == "v3."* ]]; then
102 CACHE_DIR=~/.local/share/helm/plugins/deploy/cache
104 CACHE_DIR=~/.helm/plugins/deploy/cache
106 echo "Use cache dir: $CACHE_DIR"
107 CHART_DIR=$CACHE_DIR/$CHART_NAME
108 CACHE_SUBCHART_DIR=$CHART_DIR-subcharts
109 LOG_DIR=$CHART_DIR/logs
111 # determine if verbose output is enabled
113 if [[ $FLAGS = *"--verbose"* ]]; then
114 FLAGS="$(echo $FLAGS| sed -n 's/--verbose//p')"
117 # determine if delay for deployment is enabled
119 if [[ $FLAGS = *"--delay"* ]]; then
120 FLAGS="$(echo $FLAGS| sed -n 's/--delay//p')"
123 # determine if set-last-applied flag is enabled
124 SET_LAST_APPLIED="false"
125 if [[ $FLAGS = *"--set-last-applied"* ]]; then
126 FLAGS="$(echo $FLAGS| sed -n 's/--set-last-applied//p')"
127 SET_LAST_APPLIED="true"
129 if [[ $FLAGS = *"--dry-run"* ]]; then
131 FLAGS="$FLAGS --debug"
134 # should pass all flags instead
135 NAMESPACE="$(echo $FLAGS | sed -n 's/.*\(namespace\).\s*/\1/p' | cut -c10- | cut -d' ' -f1)"
137 VERSION="$(echo $FLAGS | sed -n 's/.*\(version\).\s*/\1/p' | cut -c8- | cut -d' ' -f1)"
139 if [ ! -z $VERSION ]; then
140 VERSION="--version $VERSION"
143 # Remove all override values passed in as arguments. These will be used during dry run
144 # to resolve computed override values. Remaining flags will be passed on during
145 # actual upgrade/install of parent and subcharts.
146 DEPLOY_FLAGS=$(resolve_deploy_flags "$FLAGS")
148 # determine if upgrading individual subchart or entire parent + subcharts
149 SUBCHART_RELEASE="$(cut -d'-' -f2 <<<"$RELEASE")"
150 # update specified subchart without parent
151 RELEASE="$(cut -d'-' -f1 <<<"$RELEASE")"
152 if [[ $SUBCHART_RELEASE == $RELEASE ]]; then
156 # clear previously cached charts
159 # fetch umbrella chart (parent chart containing subcharts)
160 if [[ -d "$CHART_URL" ]]; then
162 cp -R $CHART_URL/* $CHART_DIR/
164 charts=$CHART_DIR/charts/*
165 for subchart in $charts ; do
166 tar xzf ${subchart} -C $CHART_DIR/charts/
168 rm -rf $CHART_DIR/charts/*.tgz
170 echo "fetching $CHART_URL"
171 helm fetch $CHART_URL --untar --untardir $CACHE_DIR $VERSION
174 # create log driectory
177 # move out subcharts to process separately
178 mkdir -p $CACHE_SUBCHART_DIR
179 mv $CHART_DIR/charts/* $CACHE_SUBCHART_DIR/
180 # temp hack - parent chart needs common subchart
181 mv $CACHE_SUBCHART_DIR/common $CHART_DIR/charts/
183 # disable dependencies
184 rm $CHART_DIR/requirements.lock
185 mv $CHART_DIR/requirements.yaml $CHART_DIR/requirements.deploy
187 # compute overrides for parent and all subcharts
188 COMPUTED_OVERRIDES=$CACHE_DIR/$CHART_NAME/computed-overrides.yaml
189 helm upgrade -i $RELEASE $CHART_DIR $FLAGS --dry-run --debug \
190 | sed -n '/COMPUTED VALUES:/,/HOOKS:/p' | sed '1d;$d' > $COMPUTED_OVERRIDES
192 # extract global overrides to apply to parent and all subcharts
193 GLOBAL_OVERRIDES=$CHART_DIR/global-overrides.yaml
194 generate_overrides $COMPUTED_OVERRIDES $GLOBAL_OVERRIDES
196 # upgrade/install parent chart first
197 if [[ -z "$SUBCHART_RELEASE" ]]; then
198 LOG_FILE=$LOG_DIR/${RELEASE}.log
201 helm upgrade -i $RELEASE $CHART_DIR $DEPLOY_FLAGS -f $COMPUTED_OVERRIDES \
204 if [[ $VERBOSE == "true" ]]; then
207 echo "release \"$RELEASE\" deployed"
209 # Add annotation last-applied-configuration if set-last-applied flag is set
210 if [[ $SET_LAST_APPLIED == "true" ]]; then
211 helm get manifest ${RELEASE} \
212 | kubectl apply set-last-applied --create-annotation -n onap -f - \
217 # upgrade/install each "enabled" subchart
218 cd $CACHE_SUBCHART_DIR/
219 #“helm ls” is an expensive command in that it can take a long time to execute.
220 #So cache the results to prevent repeated execution.
221 ALL_HELM_RELEASES=$(helm ls -q)
222 for subchart in * ; do
223 SUBCHART_OVERRIDES=$CACHE_SUBCHART_DIR/$subchart/subchart-overrides.yaml
226 if [[ -f $SUBCHART_OVERRIDES ]]; then
227 SUBCHART_ENABLED=$(cat $SUBCHART_OVERRIDES | grep -c "^enabled: true")
230 if [[ $SUBCHART_ENABLED -eq 1 ]]; then
231 if [[ -z "$SUBCHART_RELEASE" || $SUBCHART_RELEASE == "$subchart" ]]; then
232 LOG_FILE=$LOG_DIR/"${RELEASE}-${subchart}".log
235 helm upgrade -i "${RELEASE}-${subchart}" $CACHE_SUBCHART_DIR/$subchart \
236 $DEPLOY_FLAGS -f $GLOBAL_OVERRIDES -f $SUBCHART_OVERRIDES \
239 if [[ $VERBOSE == "true" ]]; then
242 echo "release \"${RELEASE}-${subchart}\" deployed"
244 # Add annotation last-applied-configuration if set-last-applied flag is set
245 if [[ $SET_LAST_APPLIED == "true" ]]; then
246 helm get manifest "${RELEASE}-${subchart}" \
247 | kubectl apply set-last-applied --create-annotation -n onap -f - \
251 if [[ $DELAY == "true" ]]; then
256 array=($(echo "$ALL_HELM_RELEASES" | grep "${RELEASE}-${subchart}"))
258 for (( i = n-1; i >= 0; i-- )); do
259 if [[ $HELM_VER == "v3."* ]]; then
260 helm del "${array[i]}"
262 helm del "${array[i]}" --purge
268 # report on success/failures of installs/upgrades
269 if [[ $HELM_VER == "v3."* ]]; then
270 helm ls --all-namespaces | grep -i FAILED | grep $RELEASE
272 helm ls | grep FAILED | grep $RELEASE
275 HELM_VER=$(helm version --template "{{.Version}}")
278 case "${1:-"help"}" in