#!/bin/bash -x # Copyright (C) The Arvados Authors. All rights reserved. # # SPDX-License-Identifier: CC-BY-SA-3.0 # If you want to test arvados in a single host, you can run this script, which # will install it using salt masterless # This script is run by the Vagrant file when you run it with # # vagrant up set -o pipefail # capture the directory that the script is running from SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" usage() { echo >&2 echo >&2 "Usage: ${0} [-h] [-h]" echo >&2 echo >&2 "${0} options:" echo >&2 " -d, --debug Run salt installation in debug mode" echo >&2 " -p , --ssl-port SSL port to use for the web applications" echo >&2 " -c , --config Path to the local.params config file" echo >&2 " -t, --test Test installation running a CWL workflow" echo >&2 " -r, --roles List of Arvados roles to apply to the host, comma separated" echo >&2 " Possible values are:" echo >&2 " api" echo >&2 " controller" echo >&2 " keepstore" echo >&2 " websocket" echo >&2 " keepweb" echo >&2 " workbench2" echo >&2 " keepproxy" echo >&2 " shell" echo >&2 " workbench" echo >&2 " dispatcher" echo >&2 " Defaults to applying them all" echo >&2 " -h, --help Display this help and exit" echo >&2 " -v, --vagrant Run in vagrant and use the /vagrant shared dir" echo >&2 } arguments() { # NOTE: This requires GNU getopt (part of the util-linux package on Debian-based distros). TEMP=$(getopt -o c:dhp:r:tv \ --long config:,debug,help,ssl-port:,roles:,test,vagrant \ -n "${0}" -- "${@}") if [ ${?} != 0 ] ; then echo "GNU getopt missing? Use -h for help"; exit 1 ; fi # Note the quotes around `$TEMP': they are essential! eval set -- "$TEMP" while [ ${#} -ge 1 ]; do case ${1} in -c | --config) CONFIG_FILE=${2} shift 2 ;; -d | --debug) LOG_LEVEL="debug" shift ;; -p | --ssl-port) CONTROLLER_EXT_SSL_PORT=${2} shift 2 ;; -r | --roles) for i in ${2//,/ } do # Verify the role exists if [[ ! "database,api,controller,keepstore,websocket,keepweb,workbench2,keepproxy,shell,workbench,dispatcher" == *"$i"* ]]; then echo "The role '${i}' is not a valid role" usage exit 1 fi ROLES="${ROLES} ${i}" done shift 2 ;; -t | --test) TEST="yes" shift ;; -v | --vagrant) VAGRANT="yes" shift ;; --) shift break ;; *) usage exit 1 ;; esac done } CONFIG="${SCRIPT_DIR}/local.params" CONFIG_DIR="config_examples/single_host/multiple_hostnames" LOG_LEVEL="info" CONTROLLER_EXT_SSL_PORT=443 TESTS_DIR="tests" CLUSTER="" DOMAIN="" # Hostnames/IPs used for single-host deploys HOSTNAME_EXT="" HOSTNAME_INT="127.0.1.1" # Initial user setup INITIAL_USER="" INITIAL_USER_EMAIL="" INITIAL_USER_PASSWORD="" CONTROLLER_EXT_SSL_PORT=8000 KEEP_EXT_SSL_PORT=25101 # Both for collections and downloads KEEPWEB_EXT_SSL_PORT=9002 WEBSHELL_EXT_SSL_PORT=4202 WEBSOCKET_EXT_SSL_PORT=8002 WORKBENCH1_EXT_SSL_PORT=443 WORKBENCH2_EXT_SSL_PORT=3001 RELEASE="production" VERSION="latest" ARVADOS_TAG="v1.1.4" POSTGRES_TAG="v0.41.3" NGINX_TAG="v2.4.0" DOCKER_TAG="v1.0.0" LOCALE_TAG="v0.3.4" # Salt's dir ## states S_DIR="/srv/salt" ## formulas F_DIR="/srv/formulas" ##pillars P_DIR="/srv/pillars" arguments ${@} if [ -s ${CONFIG_FILE} ]; then source ${CONFIG_FILE} else echo >&2 "Please create a '${CONFIG_FILE}' file with initial values, as described in FIXME_URL_TO_DESCR" exit 1 fi if ! grep -E '^[[:alnum:]]{5}$' <<<${CLUSTER} ; then echo >&2 "ERROR: must be exactly 5 alphanumeric characters long" echo >&2 "Fix the cluster name in the 'local.params' file and re-run the provision script" exit 1 fi apt-get update apt-get install -y curl git jq if which salt-call; then echo "Salt already installed" else curl -L https://bootstrap.saltstack.com -o /tmp/bootstrap_salt.sh sh /tmp/bootstrap_salt.sh -XdfP -x python3 /bin/systemctl stop salt-minion.service /bin/systemctl disable salt-minion.service fi # Set salt to masterless mode cat > /etc/salt/minion << EOFSM file_client: local file_roots: base: - ${S_DIR} - ${F_DIR}/* pillar_roots: base: - ${P_DIR} EOFSM mkdir -p ${S_DIR} ${F_DIR} ${P_DIR} # Get the formula and dependencies cd ${F_DIR} || exit 1 git clone --branch "${ARVADOS_TAG}" https://github.com/arvados/arvados-formula.git git clone --branch "${DOCKER_TAG}" https://github.com/saltstack-formulas/docker-formula.git git clone --branch "${LOCALE_TAG}" https://github.com/saltstack-formulas/locale-formula.git git clone --branch "${NGINX_TAG}" https://github.com/saltstack-formulas/nginx-formula.git git clone --branch "${POSTGRES_TAG}" https://github.com/saltstack-formulas/postgres-formula.git if [ "x${BRANCH}" != "x" ]; then cd ${F_DIR}/arvados-formula || exit 1 git checkout -t origin/"${BRANCH}" cd - fi if [ "x${VAGRANT}" = "xyes" ]; then SOURCE_PILLARS_DIR="/vagrant/${CONFIG_DIR}/pillars" SOURCE_TESTS_DIR="/vagrant/${TESTS_DIR}" else SOURCE_PILLARS_DIR="${SCRIPT_DIR}/${CONFIG_DIR}/pillars" SOURCE_TESTS_DIR="${SCRIPT_DIR}/${TESTS_DIR}" fi SOURCE_STATES_DIR="${EXTRA_STATES_DIR}" # Replace variables (cluster, domain, etc) in the pillars, states and tests # to ease deployment for newcomers for f in "${SOURCE_PILLARS_DIR}"/*; do sed "s/__ANONYMOUS_USER_TOKEN__/${ANONYMOUS_USER_TOKEN}/g; s/__BLOB_SIGNING_KEY__/${BLOB_SIGNING_KEY}/g; s/__CONTROLLER_EXT_SSL_PORT__/${CONTROLLER_EXT_SSL_PORT}/g; s/__CLUSTER__/${CLUSTER}/g; s/__DOMAIN__/${DOMAIN}/g; s/__HOSTNAME_EXT__/${HOSTNAME_EXT}/g; s/__HOSTNAME_INT__/${HOSTNAME_INT}/g; s/__INITIAL_USER_EMAIL__/${INITIAL_USER_EMAIL}/g; s/__INITIAL_USER_PASSWORD__/${INITIAL_USER_PASSWORD}/g; s/__INITIAL_USER__/${INITIAL_USER}/g; s/__KEEPWEB_EXT_SSL_PORT__/${KEEPWEB_EXT_SSL_PORT}/g; s/__KEEP_EXT_SSL_PORT__/${KEEP_EXT_SSL_PORT}/g; s/__MANAGEMENT_TOKEN__/${MANAGEMENT_TOKEN}/g; s/__RELEASE__/${RELEASE}/g; s/__SYSTEM_ROOT_TOKEN__/${SYSTEM_ROOT_TOKEN}/g; s/__VERSION__/${VERSION}/g; s/__WEBSHELL_EXT_SSL_PORT__/${WEBSHELL_EXT_SSL_PORT}/g; s/__WEBSOCKET_EXT_SSL_PORT__/${WEBSOCKET_EXT_SSL_PORT}/g; s/__WORKBENCH1_EXT_SSL_PORT__/${WORKBENCH1_EXT_SSL_PORT}/g; s/__WORKBENCH2_EXT_SSL_PORT__/${WORKBENCH2_EXT_SSL_PORT}/g; s/__WORKBENCH_SECRET_KEY__/${WORKBENCH_SECRET_KEY}/g" \ "${f}" > "${P_DIR}"/$(basename "${f}") done mkdir -p /tmp/cluster_tests # Replace cluster and domain name in the test files for f in "${SOURCE_TESTS_DIR}"/*; do sed "s/__CLUSTER__/${CLUSTER}/g; s/__CONTROLLER_EXT_SSL_PORT__/${CONTROLLER_EXT_SSL_PORT}/g; s/__DOMAIN__/${DOMAIN}/g; s/__HOSTNAME_INT__/${HOSTNAME_INT}/g; s/__INITIAL_USER_EMAIL__/${INITIAL_USER_EMAIL}/g; s/__INITIAL_USER_PASSWORD__/${INITIAL_USER_PASSWORD}/g s/__INITIAL_USER__/${INITIAL_USER}/g; s/__SYSTEM_ROOT_TOKEN__/${SYSTEM_ROOT_TOKEN}/g" \ "${f}" > "/tmp/cluster_tests"/$(basename "${f}") done chmod 755 /tmp/cluster_tests/run-test.sh # Replace helper state files that differ from the formula's examples if [ -d "${SOURCE_STATES_DIR}" ]; then mkdir -p "${F_DIR}"/extra/extra for f in "${SOURCE_STATES_DIR}"/*; do sed "s/__ANONYMOUS_USER_TOKEN__/${ANONYMOUS_USER_TOKEN}/g; s/__CLUSTER__/${CLUSTER}/g; s/__BLOB_SIGNING_KEY__/${BLOB_SIGNING_KEY}/g; s/__CONTROLLER_EXT_SSL_PORT__/${CONTROLLER_EXT_SSL_PORT}/g; s/__DOMAIN__/${DOMAIN}/g; s/__HOSTNAME_EXT__/${HOSTNAME_EXT}/g; s/__HOSTNAME_INT__/${HOSTNAME_INT}/g; s/__INITIAL_USER_EMAIL__/${INITIAL_USER_EMAIL}/g; s/__INITIAL_USER_PASSWORD__/${INITIAL_USER_PASSWORD}/g; s/__INITIAL_USER__/${INITIAL_USER}/g; s/__KEEPWEB_EXT_SSL_PORT__/${KEEPWEB_EXT_SSL_PORT}/g; s/__KEEP_EXT_SSL_PORT__/${KEEP_EXT_SSL_PORT}/g; s/__MANAGEMENT_TOKEN__/${MANAGEMENT_TOKEN}/g; s/__RELEASE__/${RELEASE}/g; s/__SYSTEM_ROOT_TOKEN__/${SYSTEM_ROOT_TOKEN}/g; s/__VERSION__/${VERSION}/g; s/__WEBSHELL_EXT_SSL_PORT__/${WEBSHELL_EXT_SSL_PORT}/g; s/__WEBSOCKET_EXT_SSL_PORT__/${WEBSOCKET_EXT_SSL_PORT}/g; s/__WORKBENCH1_EXT_SSL_PORT__/${WORKBENCH1_EXT_SSL_PORT}/g; s/__WORKBENCH2_EXT_SSL_PORT__/${WORKBENCH2_EXT_SSL_PORT}/g; s/__WORKBENCH_SECRET_KEY__/${WORKBENCH_SECRET_KEY}/g" \ "${f}" > "${F_DIR}/extra/extra"/$(basename "${f}") done fi # Now, we build the SALT states/pillars trees # As we need to separate both states and pillars in case we want specific # roles, we iterate on both at the same time # States cat > ${S_DIR}/top.sls << EOFTSLS base: '*': - locale EOFTSLS # Pillars cat > ${P_DIR}/top.sls << EOFPSLS base: '*': - locale - arvados EOFPSLS # States, extra states if [ -d "${F_DIR}"/extra/extra ]; then for f in "${F_DIR}"/extra/extra/*.sls; do echo " - extra.$(basename ${f} | sed 's/.sls$//g')" >> ${S_DIR}/top.sls done fi # If we want specific roles for a node, just add the desired states # and its dependencies if [ -z "${ROLES}" ]; then # States echo " - nginx.passenger" >> ${S_DIR}/top.sls echo " - postgres" >> ${S_DIR}/top.sls echo " - docker" >> ${S_DIR}/top.sls echo " - arvados" >> ${S_DIR}/top.sls # Pillars echo " - docker" >> ${P_DIR}/top.sls echo " - nginx_api_configuration" >> ${P_DIR}/top.sls echo " - nginx_controller_configuration" >> ${P_DIR}/top.sls echo " - nginx_keepproxy_configuration" >> ${P_DIR}/top.sls echo " - nginx_keepweb_configuration" >> ${P_DIR}/top.sls echo " - nginx_passenger" >> ${P_DIR}/top.sls echo " - nginx_websocket_configuration" >> ${P_DIR}/top.sls echo " - nginx_webshell_configuration" >> ${P_DIR}/top.sls echo " - nginx_workbench2_configuration" >> ${P_DIR}/top.sls echo " - nginx_workbench_configuration" >> ${P_DIR}/top.sls echo " - postgresql" >> ${P_DIR}/top.sls else # If we add individual roles, make sure we add the repo first echo " - arvados.repo" >> ${S_DIR}/top.sls for R in ${ROLES}; do case "${R}" in "database") # States echo " - postgres" >> ${S_DIR}/top.sls # Pillars echo ' - postgresql' >> ${P_DIR}/top.sls ;; "api") # States # FIXME: https://dev.arvados.org/issues/17352 grep -q "postgres.client" ${S_DIR}/top.sls || echo " - postgres.client" >> ${S_DIR}/top.sls grep -q "nginx.passenger" ${S_DIR}/top.sls || echo " - nginx.passenger" >> ${S_DIR}/top.sls grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls # Pillars grep -q "docker" ${P_DIR}/top.sls || echo " - docker" >> ${P_DIR}/top.sls grep -q "postgresql" ${P_DIR}/top.sls || echo " - postgresql" >> ${P_DIR}/top.sls grep -q "nginx_passenger" ${P_DIR}/top.sls || echo " - nginx_passenger" >> ${P_DIR}/top.sls grep -q "nginx_${R}_configuration" ${P_DIR}/top.sls || echo " - nginx_${R}_configuration" >> ${P_DIR}/top.sls ;; "controller" | "websocket" | "workbench" | "workbench2" | "keepweb" | "keepproxy") # States grep -q "nginx.passenger" ${S_DIR}/top.sls || echo " - nginx.passenger" >> ${S_DIR}/top.sls grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls # Pillars grep -q "nginx_passenger" ${P_DIR}/top.sls || echo " - nginx_passenger" >> ${P_DIR}/top.sls grep -q "nginx_${R}_configuration" ${P_DIR}/top.sls || echo " - nginx_${R}_configuration" >> ${P_DIR}/top.sls ;; "shell") # States grep -q "docker" ${S_DIR}/top.sls || echo " - docker" >> ${S_DIR}/top.sls grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls # Pillars grep -q "" ${P_DIR}/top.sls || echo " - docker" >> ${P_DIR}/top.sls grep -q "nginx_webshell_configuration" ${P_DIR}/top.sls || echo " - nginx_webshell_configuration" >> ${P_DIR}/top.sls ;; "dispatcher") # States grep -q "docker" ${S_DIR}/top.sls || echo " - docker" >> ${S_DIR}/top.sls grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls # Pillars # ATM, no specific pillar needed ;; "keepstore") # States grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls # Pillars # ATM, no specific pillar needed ;; *) echo "Unknown role ${R}" exit 1 ;; esac done fi # FIXME! #16992 Temporary fix for psql call in arvados-api-server if [ -e /root/.psqlrc ]; then if ! ( grep 'pset pager off' /root/.psqlrc ); then RESTORE_PSQL="yes" cp /root/.psqlrc /root/.psqlrc.provision.backup fi else DELETE_PSQL="yes" fi echo '\pset pager off' >> /root/.psqlrc # END FIXME! #16992 Temporary fix for psql call in arvados-api-server # Now run the install salt-call --local state.apply -l ${LOG_LEVEL} # FIXME! #16992 Temporary fix for psql call in arvados-api-server if [ "x${DELETE_PSQL}" = "xyes" ]; then echo "Removing .psql file" rm /root/.psqlrc fi if [ "x${RESTORE_PSQL}" = "xyes" ]; then echo "Restoring .psql file" mv -v /root/.psqlrc.provision.backup /root/.psqlrc fi # END FIXME! #16992 Temporary fix for psql call in arvados-api-server # Leave a copy of the Arvados CA so the user can copy it where it's required echo "Copying the Arvados CA certificate to the installer dir, so you can import it" # If running in a vagrant VM, also add default user to docker group if [ "x${VAGRANT}" = "xyes" ]; then cp /etc/ssl/certs/arvados-snakeoil-ca.pem /vagrant/${CLUSTER}.${DOMAIN}-arvados-snakeoil-ca.pem echo "Adding the vagrant user to the docker group" usermod -a -G docker vagrant else cp /etc/ssl/certs/arvados-snakeoil-ca.pem ${SCRIPT_DIR}/${CLUSTER}.${DOMAIN}-arvados-snakeoil-ca.pem fi # Test that the installation finished correctly if [ "x${TEST}" = "xyes" ]; then cd /tmp/cluster_tests ./run-test.sh fi