kubernetes/helm/plugins/deploy/deploy.sh

   1 #!/bin/bash
   2
   3 usage() {
   4 cat << EOF
   5 Install (or upgrade) an umbrella Helm Chart, and its subcharts, as separate Helm Releases
   6
   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.
  10
  11
  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.
  16
  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'.
  20
  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:
  24
  25         $ helm deploy demo ./onap --namespace onap -f openstack.yaml -f overrides.yaml
  26
  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:
  30
  31         $ helm deploy demo local/onap --namespace onap -f overrides.yaml --set log.enabled=false --set vid.enabled=false
  32
  33 Usage:
  34   helm deploy [RELEASE] [CHART] [flags]
  35
  36 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.
  43 EOF
  44 }
  45
  46 generate_overrides() {
  47   SUBCHART_NAMES=($(cat $COMPUTED_OVERRIDES | grep -v '^\s\s'))
  48
  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
  56     else
  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
  62         else
  63           cat $COMPUTED_OVERRIDES | sed -n '/^'"$START"'/,/^'"$END"'/p' \
  64             | sed '1d;$d' | cut -c3- > $SUBCHART_DIR/subchart-overrides.yaml
  65         fi
  66       fi
  67     fi
  68   done
  69 }
  70 resolve_deploy_flags() {
  71   flags=($1)
  72   n=${#flags[*]}
  73   for (( i = 0; i < n; i++ )); do
  74     PARAM=${flags[i]}
  75     if [[ $PARAM == "-f" || \
  76           $PARAM == "--values" || \
  77           $PARAM == "--set" || \
  78           $PARAM == "--set-string" || \
  79           $PARAM == "--version" ]]; then
  80        # skip param and its value
  81        i=$((i + 1))
  82     else
  83       DEPLOY_FLAGS="$DEPLOY_FLAGS $PARAM"
  84     fi
  85   done
  86   echo "$DEPLOY_FLAGS"
  87 }
  88
  89 deploy() {
  90   # validate params
  91   if [[ -z "$1" || -z "$2" ]]; then
  92     usage
  93     exit 0
  94   fi
  95
  96   RELEASE=$1
  97   CHART_URL=$2
  98   FLAGS=${@:3}
  99   CHART_REPO="$(cut -d'/' -f1 <<<"$CHART_URL")"
 100   CHART_NAME="$(cut -d'/' -f2 <<<"$CHART_URL")"
 101   CACHE_DIR=~/.helm/plugins/deploy/cache
 102   CHART_DIR=$CACHE_DIR/$CHART_NAME
 103   CACHE_SUBCHART_DIR=$CHART_DIR-subcharts
 104   LOG_DIR=$CHART_DIR/logs
 105
 106   # determine if verbose output is enabled
 107   VERBOSE="false"
 108   if [[ $FLAGS = *"--verbose"* ]]; then
 109     FLAGS="$(echo $FLAGS| sed -n 's/--verbose//p')"
 110     VERBOSE="true"
 111   fi
 112   # determine if delay for deployment is enabled
 113   DELAY="false"
 114   if [[ $FLAGS = *"--delay"* ]]; then
 115     FLAGS="$(echo $FLAGS| sed -n 's/--delay//p')"
 116     DELAY="true"
 117   fi
 118   # determine if set-last-applied flag is enabled
 119   SET_LAST_APPLIED="false"
 120   if [[ $FLAGS = *"--set-last-applied"* ]]; then
 121     FLAGS="$(echo $FLAGS| sed -n 's/--set-last-applied//p')"
 122     SET_LAST_APPLIED="true"
 123   fi
 124   if [[ $FLAGS = *"--dry-run"* ]]; then
 125     VERBOSE="true"
 126     FLAGS="$FLAGS --debug"
 127   fi
 128
 129   # should pass all flags instead
 130   NAMESPACE="$(echo $FLAGS | sed -n 's/.*\(namespace\).\s*/\1/p' | cut -c10- | cut -d' ' -f1)"
 131
 132   VERSION="$(echo $FLAGS | sed -n 's/.*\(version\).\s*/\1/p' | cut -c8- | cut -d' ' -f1)"
 133
 134   if [ ! -z $VERSION ]; then
 135      VERSION="--version $VERSION"
 136   fi
 137
 138   # Remove all override values passed in as arguments. These will be used during dry run
 139   # to resolve computed override values. Remaining flags will be passed on during
 140   # actual upgrade/install of parent and subcharts.
 141   DEPLOY_FLAGS=$(resolve_deploy_flags "$FLAGS")
 142
 143   # determine if upgrading individual subchart or entire parent + subcharts
 144   SUBCHART_RELEASE="$(cut -d'-' -f2 <<<"$RELEASE")"
 145   # update specified subchart without parent
 146   RELEASE="$(cut -d'-' -f1 <<<"$RELEASE")"
 147   if [[ $SUBCHART_RELEASE == $RELEASE ]]; then
 148     SUBCHART_RELEASE=
 149   fi
 150
 151   # clear previously cached charts
 152   rm -rf $CACHE_DIR
 153
 154   # fetch umbrella chart (parent chart containing subcharts)
 155   if [[ -d "$CHART_URL" ]]; then
 156     mkdir -p $CHART_DIR
 157     cp -R $CHART_URL/* $CHART_DIR/
 158
 159     charts=$CHART_DIR/charts/*
 160     for subchart in $charts ; do
 161       tar xzf ${subchart} -C $CHART_DIR/charts/
 162     done
 163     rm -rf $CHART_DIR/charts/*.tgz
 164   else
 165     echo "fetching $CHART_URL"
 166     helm fetch $CHART_URL --untar --untardir $CACHE_DIR $VERSION
 167   fi
 168
 169   # create log driectory
 170   mkdir -p $LOG_DIR
 171
 172   # move out subcharts to process separately
 173   mkdir -p $CACHE_SUBCHART_DIR
 174   mv $CHART_DIR/charts/* $CACHE_SUBCHART_DIR/
 175   # temp hack - parent chart needs common subchart
 176   mv $CACHE_SUBCHART_DIR/common $CHART_DIR/charts/
 177
 178   # disable dependencies
 179   rm $CHART_DIR/requirements.lock
 180   mv $CHART_DIR/requirements.yaml $CHART_DIR/requirements.deploy
 181
 182   # compute overrides for parent and all subcharts
 183   COMPUTED_OVERRIDES=$CACHE_DIR/$CHART_NAME/computed-overrides.yaml
 184   helm upgrade -i $RELEASE $CHART_DIR $FLAGS --dry-run --debug \
 185    | sed -n '/COMPUTED VALUES:/,/HOOKS:/p' | sed '1d;$d' > $COMPUTED_OVERRIDES
 186
 187   # extract global overrides to apply to parent and all subcharts
 188   GLOBAL_OVERRIDES=$CHART_DIR/global-overrides.yaml
 189   generate_overrides $COMPUTED_OVERRIDES $GLOBAL_OVERRIDES
 190
 191   # upgrade/install parent chart first
 192   if [[ -z "$SUBCHART_RELEASE" ]]; then
 193     LOG_FILE=$LOG_DIR/${RELEASE}.log
 194     :> $LOG_FILE
 195
 196     helm upgrade -i $RELEASE $CHART_DIR $DEPLOY_FLAGS -f $COMPUTED_OVERRIDES \
 197      > $LOG_FILE.log 2>&1
 198
 199     if [[ $VERBOSE == "true" ]]; then
 200       cat $LOG_FILE
 201     else
 202       echo "release \"$RELEASE\" deployed"
 203     fi
 204     # Add annotation last-applied-configuration if set-last-applied flag is set
 205     if [[ $SET_LAST_APPLIED == "true" ]]; then
 206       helm get manifest ${RELEASE} \
 207       | kubectl apply set-last-applied --create-annotation -n onap -f - \
 208       > $LOG_FILE.log 2>&1
 209     fi
 210   fi
 211
 212   # upgrade/install each "enabled" subchart
 213   cd $CACHE_SUBCHART_DIR/
 214   #“helm ls” is an expensive command in that it can take a long time to execute.
 215   #So cache the results to prevent repeated execution.
 216   ALL_HELM_RELEASES=$(helm ls -q)
 217   for subchart in * ; do
 218     SUBCHART_OVERRIDES=$CACHE_SUBCHART_DIR/$subchart/subchart-overrides.yaml
 219
 220     SUBCHART_ENABLED=0
 221     if [[ -f $SUBCHART_OVERRIDES ]]; then
 222       SUBCHART_ENABLED=$(cat $SUBCHART_OVERRIDES | grep -c "^enabled: true")
 223     fi
 224
 225     if [[ $SUBCHART_ENABLED -eq 1 ]]; then
 226       if [[ -z "$SUBCHART_RELEASE" || $SUBCHART_RELEASE == "$subchart" ]]; then
 227         LOG_FILE=$LOG_DIR/"${RELEASE}-${subchart}".log
 228         :> $LOG_FILE
 229
 230         helm upgrade -i "${RELEASE}-${subchart}" $CACHE_SUBCHART_DIR/$subchart \
 231          $DEPLOY_FLAGS -f $GLOBAL_OVERRIDES -f $SUBCHART_OVERRIDES \
 232          > $LOG_FILE 2>&1
 233
 234         if [[ $VERBOSE == "true" ]]; then
 235           cat $LOG_FILE
 236         else
 237           echo "release \"${RELEASE}-${subchart}\" deployed"
 238         fi
 239         # Add annotation last-applied-configuration if set-last-applied flag is set
 240         if [[ $SET_LAST_APPLIED == "true" ]]; then
 241           helm get manifest "${RELEASE}-${subchart}" \
 242           | kubectl apply set-last-applied --create-annotation -n onap -f - \
 243               > $LOG_FILE.log 2>&1
 244         fi
 245       fi
 246           if [[ $DELAY == "true" ]]; then
 247                 echo sleep 3m
 248                 sleep 3m
 249           fi
 250     else
 251       array=($(echo "$ALL_HELM_RELEASES" | grep "${RELEASE}-${subchart}"))
 252       n=${#array[*]}
 253       for (( i = n-1; i >= 0; i-- )); do
 254         helm del "${array[i]}" --purge
 255       done
 256     fi
 257   done
 258
 259   # report on success/failures of installs/upgrades
 260   helm ls | grep FAILED | grep $RELEASE
 261 }
 262
 263 case "${1:-"help"}" in
 264   "help")
 265     usage
 266     ;;
 267   "--help")
 268     usage
 269     ;;
 270   "-h")
 271     usage
 272     ;;
 273   *)
 274     deploy $1 $2 ${@:3}
 275     ;;
 276 esac
 277
 278 exit 0