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