tools/salt-install/installer.sh

   1 #!/bin/bash
   2
   3 # Copyright (C) The Arvados Authors. All rights reserved.
   4 #
   5 # SPDX-License-Identifier: CC-BY-SA-3.0
   6
   7 #
   8 # installer.sh
   9 #
  10 # Helps manage the configuration in a git repository, and then deploy
  11 # nodes by pushing a copy of the git repository to each node and
  12 # running the provision script to do the actual installation and
  13 # configuration.
  14 #
  15
  16 set -eu
  17 set -o pipefail
  18
  19 # The parameter file
  20 declare CONFIG_FILE=local.params
  21
  22 # The salt template directory
  23 declare CONFIG_DIR=local_config_dir
  24
  25 # The 5-character Arvados cluster id
  26 # This will be populated by loadconfig()
  27 declare CLUSTER
  28
  29 # The parent domain (not including the cluster id)
  30 # This will be populated by loadconfig()
  31 declare DOMAIN
  32
  33 # A bash associative array listing each node and mapping to the roles
  34 # that should be provisioned on those nodes.
  35 # This will be populated by loadconfig()
  36 declare -A NODES
  37
  38 # A bash associative array listing each role and mapping to the nodes
  39 # that should be provisioned with this role.
  40 # This will be populated by loadconfig()
  41 declare -A ROLE2NODES
  42
  43 # The ssh user we'll use
  44 # This will be populated by loadconfig()
  45 declare DEPLOY_USER
  46
  47 # The git repository that we'll push to on all the nodes
  48 # This will be populated by loadconfig()
  49 declare GITTARGET
  50
  51 # The public host used as an SSH jump host
  52 # This will be populated by loadconfig()
  53 declare USE_SSH_JUMPHOST
  54
  55 # The temp file that will get used to disable envvar forwarding to avoid locale
  56 # issues in Debian distros.
  57 # This will be populated by loadconfig()
  58 declare SSH_CONFFILE
  59
  60 checktools() {
  61   local MISSING=''
  62   for a in git ip; do
  63     if ! which $a; then
  64       MISSING="$MISSING $a"
  65     fi
  66   done
  67   if [[ -n "$MISSING" ]]; then
  68     echo "Some tools are missing, please make sure you have the 'git' and 'iproute2' packages installed"
  69     exit 1
  70   fi
  71 }
  72
  73 cleanup() {
  74   local NODE=$1
  75   local SSH=$(ssh_cmd "$NODE")
  76   # Delete the old repository
  77   $SSH $DEPLOY_USER@$NODE rm -rf ${GITTARGET}.git ${GITTARGET}
  78 }
  79
  80 sync() {
  81   local NODE=$1
  82   local BRANCH=$2
  83
  84   # Synchronizes the configuration by creating a git repository on
  85   # each node, pushing our branch, and updating the checkout.
  86
  87   if [[ "$NODE" != localhost ]]; then
  88     SSH=$(ssh_cmd "$NODE")
  89     GIT="eval $(git_cmd $NODE)"
  90
  91     cleanup $NODE
  92
  93     # Update the git remote for the remote repository.
  94     if ! $GIT remote add $NODE $DEPLOY_USER@$NODE:${GITTARGET}.git; then
  95       $GIT remote set-url $NODE $DEPLOY_USER@$NODE:${GITTARGET}.git
  96     fi
  97
  98     # Initialize the git repository.  We're
  99     # actually going to make two repositories here because git
 100     # will complain if you try to push to a repository with a
 101     # checkout. So we're going to create a "bare" repository
 102     # and then clone a regular repository (with a checkout)
 103     # from that.
 104
 105     $SSH $DEPLOY_USER@$NODE git init --bare --shared=0600 ${GITTARGET}.git
 106     if [[ "$BRANCH" == "HEAD" ]]; then
 107       # When deploying from an individual commit instead of a branch. This can
 108       # happen when deploying from a Jenkins pipeline.
 109       $GIT push $NODE HEAD:refs/heads/HEAD
 110       $SSH $DEPLOY_USER@$NODE "umask 0077 && git clone -s ${GITTARGET}.git ${GITTARGET} && git -C ${GITTARGET} checkout remotes/origin/HEAD"
 111     else
 112       $GIT push $NODE $BRANCH
 113       $SSH $DEPLOY_USER@$NODE "umask 0077 && git clone -s ${GITTARGET}.git ${GITTARGET} && git -C ${GITTARGET} checkout ${BRANCH}"
 114     fi
 115   fi
 116 }
 117
 118 deploynode() {
 119   local NODE=$1
 120   local ROLES=$2
 121   local BRANCH=$3
 122
 123   # Deploy a node.  This runs the provision script on the node, with
 124   # the appropriate roles.
 125
 126   sync $NODE $BRANCH
 127
 128   if [[ -z "$ROLES" ]]; then
 129     echo "No roles specified for $NODE, will deploy all roles"
 130   else
 131     ROLES="--roles ${ROLES}"
 132   fi
 133
 134   logfile=deploy-${NODE}-$(date -Iseconds).log
 135   SSH=$(ssh_cmd "$NODE")
 136
 137   if [[ "$NODE" = localhost ]]; then
 138     SUDO=''
 139     if [[ $(whoami) != 'root' ]]; then
 140       SUDO=sudo
 141     fi
 142     $SUDO ./provision.sh --config ${CONFIG_FILE} ${ROLES} 2>&1 | tee $logfile
 143   else
 144     $SSH $DEPLOY_USER@$NODE "cd ${GITTARGET} && git log -n1 HEAD && DISABLED_CONTROLLER=\"$DISABLED_CONTROLLER\" sudo --preserve-env=DISABLED_CONTROLLER ./provision.sh --config ${CONFIG_FILE} ${ROLES}" 2>&1 | tee $logfile
 145     cleanup $NODE
 146   fi
 147 }
 148
 149 checkcert() {
 150   local CERTNAME=$1
 151   local CERTPATH="${CONFIG_DIR}/certs/${CERTNAME}"
 152   if [[ ! -f "${CERTPATH}.crt" || ! -e "${CERTPATH}.key" ]]; then
 153     echo "Missing ${CERTPATH}.crt or ${CERTPATH}.key files"
 154     exit 1
 155   fi
 156 }
 157
 158 loadconfig() {
 159   if ! [[ -s ${CONFIG_FILE} && -s ${CONFIG_FILE}.secrets ]]; then
 160     echo "Must be run from initialized setup dir, maybe you need to 'initialize' first?"
 161   fi
 162   source common.sh
 163   GITTARGET=arvados-deploy-config-${CLUSTER}
 164
 165   # Set up SSH so that it doesn't forward any environment variable. This is to avoid
 166   # getting "setlocale" errors on the first run, depending on the distro being used
 167   # to run the installer (like Debian).
 168   SSH_CONFFILE=$(mktemp)
 169   echo "Include config SendEnv -*" >${SSH_CONFFILE}
 170 }
 171
 172 ssh_cmd() {
 173   local NODE=$1
 174   if [ -z "${USE_SSH_JUMPHOST}" -o "${NODE}" == "${USE_SSH_JUMPHOST}" -o "${NODE}" == "localhost" ]; then
 175     echo "ssh -F ${SSH_CONFFILE}"
 176   else
 177     echo "ssh -F ${SSH_CONFFILE} -J ${DEPLOY_USER}@${USE_SSH_JUMPHOST}"
 178   fi
 179 }
 180
 181 git_cmd() {
 182   local NODE=$1
 183   echo "GIT_SSH_COMMAND=\"$(ssh_cmd ${NODE})\" git"
 184 }
 185
 186 set +u
 187 subcmd="$1"
 188 set -u
 189
 190 if [[ -n "$subcmd" ]]; then
 191   shift
 192 fi
 193 case "$subcmd" in
 194 initialize)
 195   if [[ ! -f provision.sh ]]; then
 196     echo "Must be run from arvados/tools/salt-install"
 197     exit
 198   fi
 199
 200   checktools
 201
 202   set +u
 203   SETUPDIR=$1
 204   PARAMS=$2
 205   SLS=$3
 206   TERRAFORM=$4
 207   set -u
 208
 209   err=
 210   if [[ -z "$PARAMS" || ! -f local.params.example.$PARAMS ]]; then
 211     echo "Not found: local.params.example.$PARAMS"
 212     echo "Expected one of multiple_hosts, single_host_multiple_hostnames, single_host_single_hostname"
 213     err=1
 214   fi
 215
 216   if [[ -z "$SLS" || ! -d config_examples/$SLS ]]; then
 217     echo "Not found: config_examples/$SLS"
 218     echo "Expected one of multi_host/aws, single_host/multiple_hostnames, single_host/single_hostname"
 219     err=1
 220   fi
 221
 222   if [[ -z "$SETUPDIR" || -z "$PARAMS" || -z "$SLS" ]]; then
 223     echo "installer.sh <setup dir to initialize> <params template> <config template>"
 224     err=1
 225   fi
 226
 227   if [[ -n "$err" ]]; then
 228     exit 1
 229   fi
 230
 231   echo "Initializing $SETUPDIR"
 232   git init --shared=0600 $SETUPDIR
 233   cp -r *.sh tests $SETUPDIR
 234
 235   cp local.params.example.$PARAMS $SETUPDIR/${CONFIG_FILE}
 236   cp local.params.secrets.example $SETUPDIR/${CONFIG_FILE}.secrets
 237   cp -r config_examples/$SLS $SETUPDIR/${CONFIG_DIR}
 238
 239   if [[ -n "$TERRAFORM" ]]; then
 240     mkdir $SETUPDIR/terraform
 241     cp -r $TERRAFORM/* $SETUPDIR/terraform/
 242   fi
 243
 244   cd $SETUPDIR
 245   echo '*.log' >.gitignore
 246   echo '**/.terraform' >>.gitignore
 247   echo '**/.infracost' >>.gitignore
 248
 249   if [[ -n "$TERRAFORM" ]]; then
 250     git add terraform
 251   fi
 252
 253   git add *.sh ${CONFIG_FILE} ${CONFIG_FILE}.secrets ${CONFIG_DIR} tests .gitignore
 254   git commit -m"initial commit"
 255
 256   echo
 257   echo "Setup directory $SETUPDIR initialized."
 258   if [[ -n "$TERRAFORM" ]]; then
 259     (cd $SETUPDIR/terraform/vpc && terraform init)
 260     (cd $SETUPDIR/terraform/data-storage && terraform init)
 261     (cd $SETUPDIR/terraform/services && terraform init)
 262     echo "Now go to $SETUPDIR, customize 'terraform/vpc/terraform.tfvars' as needed, then run 'installer.sh terraform'"
 263   else
 264     echo "Now go to $SETUPDIR, customize '${CONFIG_FILE}', '${CONFIG_FILE}.secrets' and '${CONFIG_DIR}' as needed, then run 'installer.sh deploy'"
 265   fi
 266   ;;
 267
 268 terraform)
 269   logfile=terraform-$(date -Iseconds).log
 270   (cd terraform/vpc && terraform apply -auto-approve) 2>&1 | tee -a $logfile
 271   (cd terraform/data-storage && terraform apply -auto-approve) 2>&1 | tee -a $logfile
 272   (cd terraform/services && \
 273     terraform apply -auto-approve) 2>&1 | \
 274     grep -v letsencrypt_iam_secret_access_key | \
 275     grep -v database_password | \
 276     tee -a $logfile
 277   (cd terraform/services && \
 278     echo -n 'letsencrypt_iam_secret_access_key = ' && \
 279     terraform output letsencrypt_iam_secret_access_key && \
 280     echo -n 'database_password = ' && \
 281     terraform output database_password) 2>&1 | tee -a $logfile
 282   ;;
 283
 284 terraform-destroy)
 285   logfile=terraform-$(date -Iseconds).log
 286   (cd terraform/services && terraform destroy) 2>&1 | tee -a $logfile
 287   (cd terraform/data-storage && terraform destroy) 2>&1 | tee -a $logfile
 288   (cd terraform/vpc && terraform destroy) 2>&1 | tee -a $logfile
 289   ;;
 290
 291 generate-tokens)
 292   for i in BLOB_SIGNING_KEY MANAGEMENT_TOKEN SYSTEM_ROOT_TOKEN ANONYMOUS_USER_TOKEN DATABASE_PASSWORD; do
 293     echo ${i}=$(
 294       tr -dc A-Za-z0-9 </dev/urandom | head -c 32
 295       echo ''
 296     )
 297   done
 298   ;;
 299
 300 deploy)
 301   set +u
 302   NODE=$1
 303   set -u
 304
 305   checktools
 306
 307   loadconfig
 308
 309   if grep -rni 'fixme' ${CONFIG_FILE} ${CONFIG_FILE}.secrets ${CONFIG_DIR}; then
 310     echo
 311     echo "Some parameters still need to be updated.  Please fix them and then re-run deploy."
 312     exit 1
 313   fi
 314
 315   if [[ -z "${DATABASE_POSTGRESQL_VERSION:-}" ]]; then
 316     echo
 317     echo "Please configure DATABASE_POSTGRESQL_VERSION in local.params: It should match the version of the PostgreSQL service you're going to use."
 318     exit 1
 319   fi
 320
 321   if [[ ${SSL_MODE} == "bring-your-own" ]]; then
 322     if [[ ! -z "${ROLE2NODES['balancer']:-}" ]]; then
 323       checkcert balancer
 324     fi
 325     if [[ ! -z "${ROLE2NODES['controller']:-}" ]]; then
 326       checkcert controller
 327     fi
 328     if [[ ! -z "${ROLE2NODES['keepproxy']:-}" ]]; then
 329       checkcert keepproxy
 330     fi
 331     if [[ ! -z "${ROLE2NODES['keepweb']:-}" ]]; then
 332       checkcert collections
 333       checkcert download
 334     fi
 335     if [[ ! -z "${ROLE2NODES['monitoring']:-}" ]]; then
 336       checkcert grafana
 337       checkcert prometheus
 338     fi
 339     if [[ ! -z "${ROLE2NODES['webshell']:-}" ]]; then
 340       checkcert webshell
 341     fi
 342     if [[ ! -z "${ROLE2NODES['websocket']:-}" ]]; then
 343       checkcert websocket
 344     fi
 345     if [[ ! -z "${ROLE2NODES['workbench']:-}" ]]; then
 346       checkcert workbench
 347     fi
 348     if [[ ! -z "${ROLE2NODES['workbench2']:-}" ]]; then
 349       checkcert workbench2
 350     fi
 351   fi
 352
 353   BRANCH=$(git rev-parse --abbrev-ref HEAD)
 354
 355   set -x
 356
 357   git add -A
 358   if ! git diff --cached --exit-code --quiet; then
 359     git commit -m"prepare for deploy"
 360   fi
 361
 362   # Used for rolling updates to disable individual nodes at the
 363   # load balancer.
 364   export DISABLED_CONTROLLER=""
 365   if [[ -z "$NODE" ]]; then
 366     for NODE in "${!NODES[@]}"; do
 367       # First, just confirm we can ssh to each node.
 368       $(ssh_cmd "$NODE") $DEPLOY_USER@$NODE true
 369     done
 370
 371     for NODE in "${!NODES[@]}"; do
 372       # Do 'database' role first,
 373       if [[ "${NODES[$NODE]}" =~ database ]]; then
 374         deploynode $NODE "${NODES[$NODE]}" $BRANCH
 375         unset NODES[$NODE]
 376       fi
 377     done
 378
 379     BALANCER=${ROLE2NODES['balancer']:-}
 380
 381     # Check if there are multiple controllers, they'll be comma-separated
 382     # in ROLE2NODES
 383     if [[ ${ROLE2NODES['controller']} =~ , ]]; then
 384       # If we have multiple controllers then there must be
 385       # load balancer. We want to do a rolling update, take
 386       # down each node at the load balancer before updating
 387       # it.
 388
 389       for NODE in "${!NODES[@]}"; do
 390         if [[ "${NODES[$NODE]}" =~ controller ]]; then
 391           export DISABLED_CONTROLLER=$NODE
 392
 393           # Update balancer that the node is disabled
 394           deploynode $BALANCER "${NODES[$BALANCER]}" $BRANCH
 395
 396           # Now update the node itself
 397           deploynode $NODE "${NODES[$NODE]}" $BRANCH
 398           unset NODES[$NODE]
 399         fi
 400       done
 401     else
 402       # Only one controller, check if it wasn't already taken care of.
 403       NODE=${ROLE2NODES['controller']}
 404       if [[ ! -z "${NODES[$NODE]:-}" ]]; then
 405         deploynode $NODE "${NODES[$NODE]}" $BRANCH
 406         unset NODES[$NODE]
 407       fi
 408     fi
 409
 410     if [[ -n "$BALANCER" ]]; then
 411       # Deploy balancer. In the rolling update case, this
 412       # will re-enable all the controllers at the balancer.
 413       export DISABLED_CONTROLLER=""
 414       deploynode $BALANCER "${NODES[$BALANCER]}" $BRANCH
 415       unset NODES[$BALANCER]
 416     fi
 417
 418     for NODE in "${!NODES[@]}"; do
 419       # Everything else (we removed the nodes that we
 420       # already deployed from the list)
 421       deploynode $NODE "${NODES[$NODE]}" $BRANCH
 422     done
 423   else
 424     # Just deploy the node that was supplied on the command line.
 425     deploynode $NODE "${NODES[$NODE]}" $BRANCH
 426   fi
 427
 428   set +x
 429   echo
 430   echo "Completed deploy, run 'installer.sh diagnostics' to verify the install"
 431
 432   ;;
 433
 434 diagnostics)
 435   loadconfig
 436
 437   set +u
 438   declare LOCATION=$1
 439   set -u
 440
 441   if ! which arvados-client; then
 442     echo "arvados-client not found, install 'arvados-client' package with 'apt-get' or 'yum'"
 443     exit 1
 444   fi
 445
 446   if [[ -z "$LOCATION" ]]; then
 447     echo "Need to provide '-internal-client' or '-external-client'"
 448     echo
 449     echo "-internal-client    You are running this on the same private network as the Arvados cluster (e.g. on one of the Arvados nodes)"
 450     echo "-external-client    You are running this outside the private network of the Arvados cluster (e.g. your workstation)"
 451     exit 1
 452   fi
 453
 454   export ARVADOS_API_HOST="${DOMAIN}:${CONTROLLER_EXT_SSL_PORT}"
 455   export ARVADOS_API_TOKEN="$SYSTEM_ROOT_TOKEN"
 456
 457   arvados-client diagnostics $LOCATION
 458   ;;
 459
 460 diagnostics-internal)
 461   loadconfig
 462   set -u
 463
 464   if [ -z "${ROLE2NODES['shell']:-}" ]; then
 465     echo "No node with 'shell' role was found, cannot run diagnostics-internal"
 466     exit 1
 467   fi
 468
 469   # Pick the first shell node for test running
 470   declare TESTNODE=$(echo ${ROLE2NODES['shell']} | cut -d\, -f1)
 471   declare SSH=$(ssh_cmd "$TESTNODE")
 472
 473   # Run diagnostics
 474   echo "Running diagnostics in $TESTNODE..."
 475   $SSH $DEPLOY_USER@$TESTNODE bash <<EOF
 476   export ARVADOS_API_HOST="${DOMAIN}:${CONTROLLER_EXT_SSL_PORT}"
 477   export ARVADOS_API_TOKEN="$SYSTEM_ROOT_TOKEN"
 478   sudo --preserve-env=ARVADOS_API_HOST,ARVADOS_API_TOKEN arvados-client diagnostics -internal-client
 479 EOF
 480
 481   ;;
 482
 483 *)
 484   echo "Arvados installer"
 485   echo ""
 486   echo "initialize             initialize the setup directory for configuration"
 487   echo "terraform              create cloud resources using terraform"
 488   echo "terraform-destroy      destroy cloud resources created by terraform"
 489   echo "generate-tokens        generate random values for tokens"
 490   echo "deploy                 deploy the configuration from the setup directory"
 491   echo "diagnostics            check your install running diagnostics locally"
 492   echo "diagnostics-internal   check your install running diagnostics on a shell node"
 493   ;;
 494 esac