3 # Copyright (C) The Arvados Authors. All rights reserved.
5 # SPDX-License-Identifier: CC-BY-SA-3.0
7 # If you want to test arvados in a single host, you can run this script, which
8 # will install it using salt masterless
9 # This script is run by the Vagrant file when you run it with
15 # capture the directory that the script is running from
16 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
20 echo >&2 "Usage: ${0} [-h] [-h]"
22 echo >&2 "${0} options:"
23 echo >&2 " -d, --debug Run salt installation in debug mode"
24 echo >&2 " -c <local.params>, --config <local.params> Path to the local.params config file"
25 echo >&2 " -t, --test Test installation running a CWL workflow"
26 echo >&2 " -r, --roles List of Arvados roles to apply to the host, comma separated"
27 echo >&2 " Possible values are:"
29 echo >&2 " controller"
30 echo >&2 " dispatcher"
32 echo >&2 " keepbalance"
39 echo >&2 " workbench2"
40 echo >&2 " Defaults to applying them all"
41 echo >&2 " -h, --help Display this help and exit"
42 echo >&2 " --dump-config <dest_dir> Dumps the pillars and states to a directory"
43 echo >&2 " This parameter does not perform any installation at all. It's"
44 echo >&2 " intended to give you a parsed set of configuration files so"
45 echo >&2 " you can inspect them or use them in you Saltstack infrastructure."
47 echo >&2 " - parses the pillar and states templates,"
48 echo >&2 " - downloads the helper formulas with their desired versions,"
49 echo >&2 " - prepares the 'top.sls' files both for pillars and states"
50 echo >&2 " for the selected role(s)"
51 echo >&2 " - writes the resulting files into <dest_dir>"
52 echo >&2 " -v, --vagrant Run in vagrant and use the /vagrant shared dir"
53 echo >&2 " --development Run in dev mode, using snakeoil certs"
58 # NOTE: This requires GNU getopt (part of the util-linux package on Debian-based distros).
59 if ! which getopt > /dev/null; then
60 echo >&2 "GNU getopt is required to run this script. Please install it and re-reun it"
64 TEMP=$(getopt -o c:dhp:r:tv \
65 --long config:,debug,development,dump-config:,help,roles:,test,vagrant \
69 then echo "Please check the parameters you entered and re-run again"
72 # Note the quotes around `$TEMP': they are essential!
75 while [ ${#} -ge 1 ]; do
87 if [[ ${2} = /* ]]; then
88 DUMP_SALT_CONFIG_DIR=${2}
90 DUMP_SALT_CONFIG_DIR=${PWD}/${2}
93 S_DIR="${DUMP_SALT_CONFIG_DIR}/salt"
95 F_DIR="${DUMP_SALT_CONFIG_DIR}/formulas"
97 P_DIR="${DUMP_SALT_CONFIG_DIR}/pillars"
99 T_DIR="${DUMP_SALT_CONFIG_DIR}/tests"
110 # Verify the role exists
111 if [[ ! "database,api,controller,keepstore,websocket,keepweb,workbench2,webshell,keepbalance,keepproxy,shell,workbench,dispatcher" == *"$i"* ]]; then
112 echo "The role '${i}' is not a valid role"
116 ROLES="${ROLES} ${i}"
144 mkdir -p /srv/salt/certs
145 chmod 700 /srv/salt/certs
147 if [ -f ${cert_dir}/${cert_name}.crt ]; then
148 cp -v ${cert_dir}/${cert_name}.crt /srv/salt/certs/arvados-${cert_name}.pem
149 chmod 600 /srv/salt/certs/arvados-${cert_name}.pem
151 echo "${cert_dir}/${cert_name}.crt does not exist. Exiting"
154 if [ -f ${cert_dir}/${cert_name}.key ]; then
155 cp -v ${cert_dir}/${cert_name}.key /srv/salt/certs/arvados-${cert_name}.key
156 chmod 600 /srv/salt/certs/arvados-${cert_name}.key
158 echo "${cert_dir}/${cert_name}.key does not exist. Exiting"
164 CONFIG_FILE="${SCRIPT_DIR}/local.params"
165 CONFIG_DIR="local_config_dir"
168 CONTROLLER_EXT_SSL_PORT=443
171 NGINX_INSTALL_SOURCE="install_from_repo"
176 # Hostnames/IPs used for single-host deploys
181 INITIAL_USER_EMAIL=""
182 INITIAL_USER_PASSWORD=""
184 CONTROLLER_EXT_SSL_PORT=8000
185 KEEP_EXT_SSL_PORT=25101
186 # Both for collections and downloads
187 KEEPWEB_EXT_SSL_PORT=9002
188 WEBSHELL_EXT_SSL_PORT=4202
189 WEBSOCKET_EXT_SSL_PORT=8002
190 WORKBENCH1_EXT_SSL_PORT=443
191 WORKBENCH2_EXT_SSL_PORT=3001
193 SSL_MODE="self-signed"
194 USE_LETSENCRYPT_ROUTE53="no"
195 CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
197 ## These are ARVADOS-related parameters
198 # For a stable release, change RELEASE "production" and VERSION to the
199 # package version (including the iteration, e.g. X.Y.Z-1) of the
201 # The "local.params.example.*" files already set "RELEASE=production"
202 # to deploy production-ready packages
203 RELEASE="development"
206 # These are arvados-formula-related parameters
207 # An arvados-formula tag. For a stable release, this should be a
208 # branch name (e.g. X.Y-dev) or tag for the release.
209 # ARVADOS_TAG="2.2.0"
212 # We pin the salt version to avoid potential incompatibilities when a new
213 # stable version is released.
216 # Other formula versions we depend on
217 #POSTGRES_TAG="v0.44.0"
218 #POSTGRES_URL="https://github.com/saltstack-formulas/postgres-formula.git"
219 POSTGRES_TAG="0.45.0-bugfix327"
220 POSTGRES_URL="https://github.com/arvados/postgres-formula.git"
224 LETSENCRYPT_TAG="v2.1.0"
225 LOGROTATE_TAG="v0.14.0"
228 DUMP_SALT_CONFIG_DIR=""
232 F_DIR="/srv/formulas"
236 T_DIR="/tmp/cluster_tests"
242 if [ -s ${CONFIG_FILE} ]; then
243 source ${CONFIG_FILE}
245 echo >&2 "You don't seem to have a config file with initial values."
246 echo >&2 "Please create a '${CONFIG_FILE}' file as described in"
247 echo >&2 " * https://doc.arvados.org/install/salt-single-host.html#single_host, or"
248 echo >&2 " * https://doc.arvados.org/install/salt-multi-host.html#multi_host_multi_hostnames"
252 if [ ! -d ${CONFIG_DIR} ]; then
253 echo >&2 "You don't seem to have a config directory with pillars and states."
254 echo >&2 "Please create a '${CONFIG_DIR}' directory (as configured in your '${CONFIG_FILE}'). Please see"
255 echo >&2 " * https://doc.arvados.org/install/salt-single-host.html#single_host, or"
256 echo >&2 " * https://doc.arvados.org/install/salt-multi-host.html#multi_host_multi_hostnames"
260 if grep -rni 'fixme' ${CONFIG_FILE} ${CONFIG_DIR} ; then
261 echo >&2 "The config file ${CONFIG_FILE} has some parameters that need to be modified."
262 echo >&2 "Please, fix them and re-run the provision script."
266 if ! grep -qE '^[[:alnum:]]{5}$' <<<${CLUSTER} ; then
267 echo >&2 "ERROR: <CLUSTER> must be exactly 5 lowercase alphanumeric characters long"
268 echo >&2 "Fix the cluster name in the 'local.params' file and re-run the provision script"
272 # Only used in single_host/single_name deploys
273 if [ ! -z "${HOSTNAME_EXT}" ] ; then
274 # We need to add some extra control vars to manage a single certificate vs. multiple
275 USE_SINGLE_HOSTNAME="yes"
276 # Make sure that the value configured as IP_INT is a real IP on the system.
277 # If we don't error out early here when there is a mismatch, the formula will
278 # fail with hard to interpret nginx errors later on.
279 ip addr list |grep "${IP_INT}/" >/dev/null
280 if [[ $? -ne 0 ]]; then
281 echo "Unable to find the IP_INT address '${IP_INT}' on the system, please correct the value in local.params. Exiting..."
285 USE_SINGLE_HOSTNAME="no"
286 # We set this variable, anyway, so sed lines do not fail and we don't need to add more
288 HOSTNAME_EXT="${CLUSTER}.${DOMAIN}"
291 if [ "${DUMP_CONFIG}" = "yes" ]; then
292 echo "The provision installer will just dump a config under ${DUMP_SALT_CONFIG_DIR} and exit"
294 # Install a few dependency packages
295 # First, let's figure out the OS we're working on
296 OS_ID=$(grep ^ID= /etc/os-release |cut -f 2 -d= |cut -f 2 -d \")
297 echo "Detected distro: ${OS_ID}"
301 echo "WARNING! Disabling SELinux, see https://dev.arvados.org/issues/18019"
302 sed -i 's/SELINUX=enforcing/SELINUX=permissive/g' /etc/sysconfig/selinux
303 setenforce permissive
304 yum install -y curl git jq
307 # Wait 2 minutes for any apt locks to clear
308 # This option is supported from apt 1.9.1 and ignored in older apt versions.
309 # Cf. https://blog.sinjakli.co.uk/2021/10/25/waiting-for-apt-locks-without-the-hacky-bash-scripts/
310 DEBIAN_FRONTEND=noninteractive apt -o DPkg::Lock::Timeout=120 update
311 DEBIAN_FRONTEND=noninteractive apt install -y curl git jq
315 if which salt-call; then
316 echo "Salt already installed"
318 curl -L https://bootstrap.saltstack.com -o /tmp/bootstrap_salt.sh
319 sh /tmp/bootstrap_salt.sh -XdfP -x python3 stable ${SALT_VERSION}
320 /bin/systemctl stop salt-minion.service
321 /bin/systemctl disable salt-minion.service
324 # Set salt to masterless mode
325 cat > /etc/salt/minion << EOFSM
340 mkdir -p ${S_DIR} ${F_DIR} ${P_DIR} ${T_DIR}
342 # Get the formula and dependencies
343 cd ${F_DIR} || exit 1
344 echo "Cloning formulas"
345 test -d docker && ( cd docker && git fetch ) \
346 || git clone --quiet https://github.com/saltstack-formulas/docker-formula.git ${F_DIR}/docker
347 ( cd docker && git checkout --quiet tags/"${DOCKER_TAG}" )
350 test -d locale && ( cd locale && git fetch ) \
351 || git clone --quiet https://github.com/saltstack-formulas/locale-formula.git ${F_DIR}/locale
352 ( cd locale && git checkout --quiet tags/"${LOCALE_TAG}" )
355 test -d nginx && ( cd nginx && git fetch ) \
356 || git clone --quiet https://github.com/saltstack-formulas/nginx-formula.git ${F_DIR}/nginx
357 ( cd nginx && git checkout --quiet tags/"${NGINX_TAG}" )
360 test -d postgres && ( cd postgres && git fetch ) \
361 || git clone --quiet ${POSTGRES_URL} ${F_DIR}/postgres
362 ( cd postgres && git checkout --quiet tags/"${POSTGRES_TAG}" )
364 echo "...letsencrypt"
365 test -d letsencrypt && ( cd letsencrypt && git fetch ) \
366 || git clone --quiet https://github.com/saltstack-formulas/letsencrypt-formula.git ${F_DIR}/letsencrypt
367 ( cd letsencrypt && git checkout --quiet tags/"${LETSENCRYPT_TAG}" )
370 test -d logrotate && ( cd logrotate && git fetch ) \
371 || git clone --quiet https://github.com/saltstack-formulas/logrotate-formula.git ${F_DIR}/logrotate
372 ( cd logrotate && git checkout --quiet tags/"${LOGROTATE_TAG}" )
375 test -d arvados || git clone --quiet https://git.arvados.org/arvados-formula.git ${F_DIR}/arvados
377 # If we want to try a specific branch of the formula
378 if [ "x${BRANCH}" != "x" ]; then
379 ( cd ${F_DIR}/arvados && git checkout --quiet -t origin/"${BRANCH}" -b "${BRANCH}" )
380 elif [ "x${ARVADOS_TAG}" != "x" ]; then
381 ( cd ${F_DIR}/arvados && git checkout --quiet tags/"${ARVADOS_TAG}" -b "${ARVADOS_TAG}" )
384 if [ "x${VAGRANT}" = "xyes" ]; then
385 EXTRA_STATES_DIR="/home/vagrant/${CONFIG_DIR}/states"
386 SOURCE_PILLARS_DIR="/home/vagrant/${CONFIG_DIR}/pillars"
387 SOURCE_TESTS_DIR="/home/vagrant/${TESTS_DIR}"
389 EXTRA_STATES_DIR="${SCRIPT_DIR}/${CONFIG_DIR}/states"
390 SOURCE_PILLARS_DIR="${SCRIPT_DIR}/${CONFIG_DIR}/pillars"
391 SOURCE_TESTS_DIR="${SCRIPT_DIR}/${TESTS_DIR}"
394 SOURCE_STATES_DIR="${EXTRA_STATES_DIR}"
396 echo "Writing pillars and states"
398 # Replace variables (cluster, domain, etc) in the pillars, states and tests
399 # to ease deployment for newcomers
400 if [ ! -d "${SOURCE_PILLARS_DIR}" ]; then
401 echo "${SOURCE_PILLARS_DIR} does not exist or is not a directory. Exiting."
404 for f in $(ls "${SOURCE_PILLARS_DIR}"/*); do
405 sed "s#__ANONYMOUS_USER_TOKEN__#${ANONYMOUS_USER_TOKEN}#g;
406 s#__BLOB_SIGNING_KEY__#${BLOB_SIGNING_KEY}#g;
407 s#__CONTROLLER_EXT_SSL_PORT__#${CONTROLLER_EXT_SSL_PORT}#g;
408 s#__CLUSTER__#${CLUSTER}#g;
409 s#__DOMAIN__#${DOMAIN}#g;
410 s#__HOSTNAME_EXT__#${HOSTNAME_EXT}#g;
411 s#__IP_INT__#${IP_INT}#g;
412 s#__INITIAL_USER_EMAIL__#${INITIAL_USER_EMAIL}#g;
413 s#__INITIAL_USER_PASSWORD__#${INITIAL_USER_PASSWORD}#g;
414 s#__INITIAL_USER__#${INITIAL_USER}#g;
415 s#__LE_AWS_REGION__#${LE_AWS_REGION}#g;
416 s#__LE_AWS_SECRET_ACCESS_KEY__#${LE_AWS_SECRET_ACCESS_KEY}#g;
417 s#__LE_AWS_ACCESS_KEY_ID__#${LE_AWS_ACCESS_KEY_ID}#g;
418 s#__DATABASE_PASSWORD__#${DATABASE_PASSWORD}#g;
419 s#__KEEPWEB_EXT_SSL_PORT__#${KEEPWEB_EXT_SSL_PORT}#g;
420 s#__KEEP_EXT_SSL_PORT__#${KEEP_EXT_SSL_PORT}#g;
421 s#__MANAGEMENT_TOKEN__#${MANAGEMENT_TOKEN}#g;
422 s#__RELEASE__#${RELEASE}#g;
423 s#__SYSTEM_ROOT_TOKEN__#${SYSTEM_ROOT_TOKEN}#g;
424 s#__VERSION__#${VERSION}#g;
425 s#__WEBSHELL_EXT_SSL_PORT__#${WEBSHELL_EXT_SSL_PORT}#g;
426 s#__WEBSOCKET_EXT_SSL_PORT__#${WEBSOCKET_EXT_SSL_PORT}#g;
427 s#__WORKBENCH1_EXT_SSL_PORT__#${WORKBENCH1_EXT_SSL_PORT}#g;
428 s#__WORKBENCH2_EXT_SSL_PORT__#${WORKBENCH2_EXT_SSL_PORT}#g;
429 s#__CLUSTER_INT_CIDR__#${CLUSTER_INT_CIDR}#g;
430 s#__CONTROLLER_INT_IP__#${CONTROLLER_INT_IP}#g;
431 s#__WEBSOCKET_INT_IP__#${WEBSOCKET_INT_IP}#g;
432 s#__KEEP_INT_IP__#${KEEP_INT_IP}#g;
433 s#__KEEPSTORE0_INT_IP__#${KEEPSTORE0_INT_IP}#g;
434 s#__KEEPSTORE1_INT_IP__#${KEEPSTORE1_INT_IP}#g;
435 s#__KEEPWEB_INT_IP__#${KEEPWEB_INT_IP}#g;
436 s#__WEBSHELL_INT_IP__#${WEBSHELL_INT_IP}#g;
437 s#__SHELL_INT_IP__#${SHELL_INT_IP}#g;
438 s#__WORKBENCH1_INT_IP__#${WORKBENCH1_INT_IP}#g;
439 s#__WORKBENCH2_INT_IP__#${WORKBENCH2_INT_IP}#g;
440 s#__DATABASE_INT_IP__#${DATABASE_INT_IP}#g;
441 s#__WORKBENCH_SECRET_KEY__#${WORKBENCH_SECRET_KEY}#g" \
442 "${f}" > "${P_DIR}"/$(basename "${f}")
445 if [ ! -d "${SOURCE_TESTS_DIR}" ]; then
446 echo "WARNING: The tests directory was not copied to \"${SOURCE_TESTS_DIR}\"."
447 if [ "x${TEST}" = "xyes" ]; then
448 echo "WARNING: Disabling tests for this installation."
453 # Replace cluster and domain name in the test files
454 for f in $(ls "${SOURCE_TESTS_DIR}"/*); do
455 FILTERS="s#__CLUSTER__#${CLUSTER}#g;
456 s#__CONTROLLER_EXT_SSL_PORT__#${CONTROLLER_EXT_SSL_PORT}#g;
457 s#__DOMAIN__#${DOMAIN}#g;
458 s#__IP_INT__#${IP_INT}#g;
459 s#__INITIAL_USER_EMAIL__#${INITIAL_USER_EMAIL}#g;
460 s#__INITIAL_USER_PASSWORD__#${INITIAL_USER_PASSWORD}#g
461 s#__INITIAL_USER__#${INITIAL_USER}#g;
462 s#__DATABASE_PASSWORD__#${DATABASE_PASSWORD}#g;
463 s#__SYSTEM_ROOT_TOKEN__#${SYSTEM_ROOT_TOKEN}#g"
464 if [ "$USE_SINGLE_HOSTNAME" = "yes" ]; then
465 FILTERS="s#__CLUSTER__.__DOMAIN__#${HOSTNAME_EXT}#g;
469 "${f}" > ${T_DIR}/$(basename "${f}")
471 chmod 755 ${T_DIR}/run-test.sh
474 # Replace helper state files that differ from the formula's examples
475 if [ -d "${SOURCE_STATES_DIR}" ]; then
476 mkdir -p "${F_DIR}"/extra/extra
478 for f in $(ls "${SOURCE_STATES_DIR}"/*); do
479 sed "s#__ANONYMOUS_USER_TOKEN__#${ANONYMOUS_USER_TOKEN}#g;
480 s#__CLUSTER__#${CLUSTER}#g;
481 s#__BLOB_SIGNING_KEY__#${BLOB_SIGNING_KEY}#g;
482 s#__CONTROLLER_EXT_SSL_PORT__#${CONTROLLER_EXT_SSL_PORT}#g;
483 s#__DOMAIN__#${DOMAIN}#g;
484 s#__HOSTNAME_EXT__#${HOSTNAME_EXT}#g;
485 s#__IP_INT__#${IP_INT}#g;
486 s#__INITIAL_USER_EMAIL__#${INITIAL_USER_EMAIL}#g;
487 s#__INITIAL_USER_PASSWORD__#${INITIAL_USER_PASSWORD}#g;
488 s#__INITIAL_USER__#${INITIAL_USER}#g;
489 s#__DATABASE_PASSWORD__#${DATABASE_PASSWORD}#g;
490 s#__KEEPWEB_EXT_SSL_PORT__#${KEEPWEB_EXT_SSL_PORT}#g;
491 s#__KEEP_EXT_SSL_PORT__#${KEEP_EXT_SSL_PORT}#g;
492 s#__MANAGEMENT_TOKEN__#${MANAGEMENT_TOKEN}#g;
493 s#__RELEASE__#${RELEASE}#g;
494 s#__SYSTEM_ROOT_TOKEN__#${SYSTEM_ROOT_TOKEN}#g;
495 s#__VERSION__#${VERSION}#g;
496 s#__CLUSTER_INT_CIDR__#${CLUSTER_INT_CIDR}#g;
497 s#__CONTROLLER_INT_IP__#${CONTROLLER_INT_IP}#g;
498 s#__WEBSOCKET_INT_IP__#${WEBSOCKET_INT_IP}#g;
499 s#__KEEP_INT_IP__#${KEEP_INT_IP}#g;
500 s#__KEEPSTORE0_INT_IP__#${KEEPSTORE0_INT_IP}#g;
501 s#__KEEPSTORE1_INT_IP__#${KEEPSTORE1_INT_IP}#g;
502 s#__KEEPWEB_INT_IP__#${KEEPWEB_INT_IP}#g;
503 s#__WEBSHELL_INT_IP__#${WEBSHELL_INT_IP}#g;
504 s#__WORKBENCH1_INT_IP__#${WORKBENCH1_INT_IP}#g;
505 s#__WORKBENCH2_INT_IP__#${WORKBENCH2_INT_IP}#g;
506 s#__DATABASE_INT_IP__#${DATABASE_INT_IP}#g;
507 s#__WEBSHELL_EXT_SSL_PORT__#${WEBSHELL_EXT_SSL_PORT}#g;
508 s#__SHELL_INT_IP__#${SHELL_INT_IP}#g;
509 s#__WEBSOCKET_EXT_SSL_PORT__#${WEBSOCKET_EXT_SSL_PORT}#g;
510 s#__WORKBENCH1_EXT_SSL_PORT__#${WORKBENCH1_EXT_SSL_PORT}#g;
511 s#__WORKBENCH2_EXT_SSL_PORT__#${WORKBENCH2_EXT_SSL_PORT}#g;
512 s#__WORKBENCH_SECRET_KEY__#${WORKBENCH_SECRET_KEY}#g" \
513 "${f}" > "${F_DIR}/extra/extra"/$(basename "${f}")
517 # Now, we build the SALT states/pillars trees
518 # As we need to separate both states and pillars in case we want specific
519 # roles, we iterate on both at the same time
522 cat > ${S_DIR}/top.sls << EOFTSLS
529 cat > ${P_DIR}/top.sls << EOFPSLS
536 # States, extra states
537 if [ -d "${F_DIR}"/extra/extra ]; then
538 SKIP_SNAKE_OIL="snakeoil_certs"
540 if [[ "$DEV_MODE" = "yes" || "${SSL_MODE}" == "self-signed" ]] ; then
541 # In dev mode, we create some snake oil certs that we'll
542 # use as CUSTOM_CERTS, so we don't skip the states file.
543 # Same when using self-signed certificates.
544 SKIP_SNAKE_OIL="dont_add_snakeoil_certs"
546 for f in $(ls "${F_DIR}"/extra/extra/*.sls | egrep -v "${SKIP_SNAKE_OIL}|shell_"); do
547 echo " - extra.$(basename ${f} | sed 's/.sls$//g')" >> ${S_DIR}/top.sls
549 # Use byo or self-signed certificates
550 if [ "${SSL_MODE}" != "lets-encrypt" ]; then
551 mkdir -p "${F_DIR}"/extra/extra/files
555 # If we want specific roles for a node, just add the desired states
556 # and its dependencies
557 if [ -z "${ROLES}" ]; then
559 echo " - nginx.passenger" >> ${S_DIR}/top.sls
560 if [ "${SSL_MODE}" = "lets-encrypt" ]; then
561 if [ "${USE_LETSENCRYPT_ROUTE53}" = "yes" ]; then
562 grep -q "aws_credentials" ${S_DIR}/top.sls || echo " - extra.aws_credentials" >> ${S_DIR}/top.sls
564 grep -q "letsencrypt" ${S_DIR}/top.sls || echo " - letsencrypt" >> ${S_DIR}/top.sls
566 mkdir -p /srv/salt/certs
567 chmod 700 /srv/salt/certs
568 if [ "${SSL_MODE}" = "bring-your-own" ]; then
569 # Copy certs to formula extra/files
570 cp -rv ${CUSTOM_CERTS_DIR}/* /srv/salt/certs/
571 chmod 600 /srv/salt/certs/*
572 # We add the custom_certs state
573 grep -q "custom_certs" ${S_DIR}/top.sls || echo " - extra.custom_certs" >> ${S_DIR}/top.sls
575 # In self-signed mode, the certificate files will be created and put in the
576 # destination directory by the snakeoil_certs.sls state file
579 echo " - postgres" >> ${S_DIR}/top.sls
580 echo " - logrotate" >> ${S_DIR}/top.sls
581 echo " - docker.software" >> ${S_DIR}/top.sls
582 echo " - arvados" >> ${S_DIR}/top.sls
583 echo " - extra.shell_sudo_passwordless" >> ${S_DIR}/top.sls
584 echo " - extra.shell_cron_add_login_sync" >> ${S_DIR}/top.sls
585 echo " - extra.passenger_rvm" >> ${S_DIR}/top.sls
588 echo " - docker" >> ${P_DIR}/top.sls
589 echo " - nginx_api_configuration" >> ${P_DIR}/top.sls
590 echo " - logrotate_api" >> ${P_DIR}/top.sls
591 echo " - nginx_controller_configuration" >> ${P_DIR}/top.sls
592 echo " - nginx_keepproxy_configuration" >> ${P_DIR}/top.sls
593 echo " - nginx_keepweb_configuration" >> ${P_DIR}/top.sls
594 echo " - nginx_passenger" >> ${P_DIR}/top.sls
595 echo " - nginx_websocket_configuration" >> ${P_DIR}/top.sls
596 echo " - nginx_webshell_configuration" >> ${P_DIR}/top.sls
597 echo " - nginx_workbench2_configuration" >> ${P_DIR}/top.sls
598 echo " - nginx_workbench_configuration" >> ${P_DIR}/top.sls
599 echo " - logrotate_wb1" >> ${P_DIR}/top.sls
600 echo " - postgresql" >> ${P_DIR}/top.sls
602 # We need to tweak the Nginx's pillar depending whether we want plan nginx or nginx+passenger
603 NGINX_INSTALL_SOURCE="install_from_phusionpassenger"
604 sed -i "s/__NGINX_INSTALL_SOURCE__/${NGINX_INSTALL_SOURCE}/g" ${P_DIR}/nginx_passenger.sls
606 if [ "${SSL_MODE}" = "lets-encrypt" ]; then
607 if [ "${USE_LETSENCRYPT_ROUTE53}" = "yes" ]; then
608 grep -q "aws_credentials" ${P_DIR}/top.sls || echo " - aws_credentials" >> ${P_DIR}/top.sls
610 grep -q "letsencrypt" ${P_DIR}/top.sls || echo " - letsencrypt" >> ${P_DIR}/top.sls
612 hosts=("controller" "websocket" "workbench" "workbench2" "webshell" "keepproxy")
613 if [ ${USE_SINGLE_HOSTNAME} = "no" ]; then
614 hosts+=("download" "collections")
619 for c in "${hosts[@]}"; do
620 # Are we in a single-host-single-hostname env?
621 if [ "${USE_SINGLE_HOSTNAME}" = "yes" ]; then
622 # Are we in a single-host-single-hostname env?
623 CERT_NAME=${HOSTNAME_EXT}
625 # We are in a multiple-hostnames env
626 CERT_NAME=${c}.${CLUSTER}.${DOMAIN}
629 # As the pillar differs whether we use LE or custom certs, we need to do a final edition on them
630 sed -i "s/__CERT_REQUIRES__/cmd: create-initial-cert-${CERT_NAME}*/g;
631 s#__CERT_PEM__#/etc/letsencrypt/live/${CERT_NAME}/fullchain.pem#g;
632 s#__CERT_KEY__#/etc/letsencrypt/live/${CERT_NAME}/privkey.pem#g" \
633 ${P_DIR}/nginx_${c}_configuration.sls
636 # Use custom certs (either dev mode or prod)
637 grep -q "extra_custom_certs" ${P_DIR}/top.sls || echo " - extra_custom_certs" >> ${P_DIR}/top.sls
638 # And add the certs in the custom_certs pillar
639 echo "extra_custom_certs_dir: /srv/salt/certs" > ${P_DIR}/extra_custom_certs.sls
640 echo "extra_custom_certs:" >> ${P_DIR}/extra_custom_certs.sls
642 for c in controller websocket workbench workbench2 webshell keepweb keepproxy; do
643 # Are we in a single-host-single-hostname env?
644 if [ "${USE_SINGLE_HOSTNAME}" = "yes" ]; then
645 # Are we in a single-host-single-hostname env?
646 CERT_NAME=${HOSTNAME_EXT}
648 # We are in a multiple-hostnames env
652 if [[ "$SSL_MODE" == "bring-your-own" ]]; then
653 copy_custom_cert ${CUSTOM_CERTS_DIR} ${CERT_NAME}
656 grep -q ${CERT_NAME} ${P_DIR}/extra_custom_certs.sls || echo " - ${CERT_NAME}" >> ${P_DIR}/extra_custom_certs.sls
658 # As the pillar differs whether we use LE or custom certs, we need to do a final edition on them
659 sed -i "s/__CERT_REQUIRES__/file: extra_custom_certs_file_copy_arvados-${CERT_NAME}.pem/g;
660 s#__CERT_PEM__#/etc/nginx/ssl/arvados-${CERT_NAME}.pem#g;
661 s#__CERT_KEY__#/etc/nginx/ssl/arvados-${CERT_NAME}.key#g" \
662 ${P_DIR}/nginx_${c}_configuration.sls
666 # If we add individual roles, make sure we add the repo first
667 echo " - arvados.repo" >> ${S_DIR}/top.sls
668 # We add the extra_custom_certs state
669 grep -q "extra.custom_certs" ${S_DIR}/top.sls || echo " - extra.custom_certs" >> ${S_DIR}/top.sls
671 # And we add the basic part for the certs pillar
672 if [ "${SSL_MODE}" != "lets-encrypt" ]; then
673 # And add the certs in the custom_certs pillar
674 echo "extra_custom_certs_dir: /srv/salt/certs" > ${P_DIR}/extra_custom_certs.sls
675 echo "extra_custom_certs:" >> ${P_DIR}/extra_custom_certs.sls
676 grep -q "extra_custom_certs" ${P_DIR}/top.sls || echo " - extra_custom_certs" >> ${P_DIR}/top.sls
679 for R in ${ROLES}; do
683 echo " - postgres" >> ${S_DIR}/top.sls
685 echo ' - postgresql' >> ${P_DIR}/top.sls
689 grep -q " - logrotate" ${S_DIR}/top.sls || echo " - logrotate" >> ${S_DIR}/top.sls
690 if grep -q " - nginx.*$" ${S_DIR}/top.sls; then
691 sed -i s/"^ - nginx.*$"/" - nginx.passenger"/g ${S_DIR}/top.sls
693 echo " - nginx.passenger" >> ${S_DIR}/top.sls
695 echo " - extra.passenger_rvm" >> ${S_DIR}/top.sls
696 ### If we don't install and run LE before arvados-api-server, it fails and breaks everything
697 ### after it. So we add this here as we are, after all, sharing the host for api and controller
698 if [ "${SSL_MODE}" = "lets-encrypt" ]; then
699 if [ "${USE_LETSENCRYPT_ROUTE53}" = "yes" ]; then
700 grep -q "aws_credentials" ${S_DIR}/top.sls || echo " - aws_credentials" >> ${S_DIR}/top.sls
702 grep -q "letsencrypt" ${S_DIR}/top.sls || echo " - letsencrypt" >> ${S_DIR}/top.sls
705 if [ "${SSL_MODE}" = "bring-your-own" ]; then
706 copy_custom_cert ${CUSTOM_CERTS_DIR} controller
708 grep -q controller ${P_DIR}/extra_custom_certs.sls || echo " - controller" >> ${P_DIR}/extra_custom_certs.sls
710 grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls
712 grep -q "logrotate_api" ${P_DIR}/top.sls || echo " - logrotate_api" >> ${P_DIR}/top.sls
713 grep -q "aws_credentials" ${P_DIR}/top.sls || echo " - aws_credentials" >> ${P_DIR}/top.sls
714 grep -q "postgresql" ${P_DIR}/top.sls || echo " - postgresql" >> ${P_DIR}/top.sls
715 grep -q "nginx_passenger" ${P_DIR}/top.sls || echo " - nginx_passenger" >> ${P_DIR}/top.sls
716 grep -q "nginx_${R}_configuration" ${P_DIR}/top.sls || echo " - nginx_${R}_configuration" >> ${P_DIR}/top.sls
718 # We need to tweak the Nginx's pillar depending whether we want plain nginx or nginx+passenger
719 NGINX_INSTALL_SOURCE="install_from_phusionpassenger"
720 sed -i "s/__NGINX_INSTALL_SOURCE__/${NGINX_INSTALL_SOURCE}/g" ${P_DIR}/nginx_passenger.sls
722 "controller" | "websocket" | "workbench" | "workbench2" | "webshell" | "keepweb" | "keepproxy")
724 if [ "${R}" = "workbench" ]; then
725 grep -q " - logrotate" ${S_DIR}/top.sls || echo " - logrotate" >> ${S_DIR}/top.sls
726 NGINX_INSTALL_SOURCE="install_from_phusionpassenger"
727 if grep -q " - nginx$" ${S_DIR}/top.sls; then
728 sed -i s/"^ - nginx.*$"/" - nginx.passenger"/g ${S_DIR}/top.sls
730 echo " - nginx.passenger" >> ${S_DIR}/top.sls
733 grep -q "nginx" ${S_DIR}/top.sls || echo " - nginx" >> ${S_DIR}/top.sls
735 if [ "${SSL_MODE}" = "lets-encrypt" ]; then
736 if [ "x${USE_LETSENCRYPT_ROUTE53}" = "xyes" ]; then
737 grep -q "aws_credentials" ${S_DIR}/top.sls || echo " - aws_credentials" >> ${S_DIR}/top.sls
739 grep -q "letsencrypt" ${S_DIR}/top.sls || echo " - letsencrypt" >> ${S_DIR}/top.sls
741 # Use custom certs, special case for keepweb
742 if [ ${R} = "keepweb" ]; then
743 if [ "${SSL_MODE}" = "bring-your-own" ]; then
744 copy_custom_cert ${CUSTOM_CERTS_DIR} download
745 copy_custom_cert ${CUSTOM_CERTS_DIR} collections
748 if [ "${SSL_MODE}" = "bring-your-own" ]; then
749 copy_custom_cert ${CUSTOM_CERTS_DIR} ${R}
753 # webshell role is just a nginx vhost, so it has no state
754 if [ "${R}" != "webshell" ]; then
755 grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls
758 if [ "${R}" = "workbench" ]; then
759 grep -q "logrotate_wb1" ${P_DIR}/top.sls || echo " - logrotate_wb1" >> ${P_DIR}/top.sls
761 grep -q "nginx_passenger" ${P_DIR}/top.sls || echo " - nginx_passenger" >> ${P_DIR}/top.sls
762 grep -q "nginx_${R}_configuration" ${P_DIR}/top.sls || echo " - nginx_${R}_configuration" >> ${P_DIR}/top.sls
763 # Special case for keepweb
764 if [ ${R} = "keepweb" ]; then
765 grep -q "nginx_download_configuration" ${P_DIR}/top.sls || echo " - nginx_download_configuration" >> ${P_DIR}/top.sls
766 grep -q "nginx_collections_configuration" ${P_DIR}/top.sls || echo " - nginx_collections_configuration" >> ${P_DIR}/top.sls
769 if [ "${SSL_MODE}" = "lets-encrypt" ]; then
770 if [ "${USE_LETSENCRYPT_ROUTE53}" = "yes" ]; then
771 grep -q "aws_credentials" ${P_DIR}/top.sls || echo " - aws_credentials" >> ${P_DIR}/top.sls
773 grep -q "letsencrypt" ${P_DIR}/top.sls || echo " - letsencrypt" >> ${P_DIR}/top.sls
774 grep -q "letsencrypt_${R}_configuration" ${P_DIR}/top.sls || echo " - letsencrypt_${R}_configuration" >> ${P_DIR}/top.sls
776 # As the pillar differ whether we use LE or custom certs, we need to do a final edition on them
777 # Special case for keepweb
778 if [ ${R} = "keepweb" ]; then
779 for kwsub in download collections; do
780 sed -i "s/__CERT_REQUIRES__/cmd: create-initial-cert-${kwsub}.${CLUSTER}.${DOMAIN}*/g;
781 s#__CERT_PEM__#/etc/letsencrypt/live/${kwsub}.${CLUSTER}.${DOMAIN}/fullchain.pem#g;
782 s#__CERT_KEY__#/etc/letsencrypt/live/${kwsub}.${CLUSTER}.${DOMAIN}/privkey.pem#g" \
783 ${P_DIR}/nginx_${kwsub}_configuration.sls
786 sed -i "s/__CERT_REQUIRES__/cmd: create-initial-cert-${R}.${CLUSTER}.${DOMAIN}*/g;
787 s#__CERT_PEM__#/etc/letsencrypt/live/${R}.${CLUSTER}.${DOMAIN}/fullchain.pem#g;
788 s#__CERT_KEY__#/etc/letsencrypt/live/${R}.${CLUSTER}.${DOMAIN}/privkey.pem#g" \
789 ${P_DIR}/nginx_${R}_configuration.sls
792 # As the pillar differ whether we use LE or custom certs, we need to do a final edition on them
793 # Special case for keepweb
794 if [ ${R} = "keepweb" ]; then
795 for kwsub in download collections; do
796 sed -i "s/__CERT_REQUIRES__/file: extra_custom_certs_file_copy_arvados-${kwsub}.pem/g;
797 s#__CERT_PEM__#/etc/nginx/ssl/arvados-${kwsub}.pem#g;
798 s#__CERT_KEY__#/etc/nginx/ssl/arvados-${kwsub}.key#g" \
799 ${P_DIR}/nginx_${kwsub}_configuration.sls
800 grep -q ${kwsub} ${P_DIR}/extra_custom_certs.sls || echo " - ${kwsub}" >> ${P_DIR}/extra_custom_certs.sls
803 sed -i "s/__CERT_REQUIRES__/file: extra_custom_certs_file_copy_arvados-${R}.pem/g;
804 s#__CERT_PEM__#/etc/nginx/ssl/arvados-${R}.pem#g;
805 s#__CERT_KEY__#/etc/nginx/ssl/arvados-${R}.key#g" \
806 ${P_DIR}/nginx_${R}_configuration.sls
807 grep -q ${R} ${P_DIR}/extra_custom_certs.sls || echo " - ${R}" >> ${P_DIR}/extra_custom_certs.sls
810 # We need to tweak the Nginx's pillar depending whether we want plain nginx or nginx+passenger
811 sed -i "s/__NGINX_INSTALL_SOURCE__/${NGINX_INSTALL_SOURCE}/g" ${P_DIR}/nginx_passenger.sls
815 echo " - extra.shell_sudo_passwordless" >> ${S_DIR}/top.sls
816 echo " - extra.shell_cron_add_login_sync" >> ${S_DIR}/top.sls
817 grep -q "docker" ${S_DIR}/top.sls || echo " - docker.software" >> ${S_DIR}/top.sls
818 grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls
820 grep -q "docker" ${P_DIR}/top.sls || echo " - docker" >> ${P_DIR}/top.sls
822 "dispatcher" | "keepbalance" | "keepstore")
824 grep -q "arvados.${R}" ${S_DIR}/top.sls || echo " - arvados.${R}" >> ${S_DIR}/top.sls
826 # ATM, no specific pillar needed
829 echo "Unknown role ${R}"
836 if [ "${DUMP_CONFIG}" = "yes" ]; then
837 # We won't run the rest of the script because we're just dumping the config
841 # Now run the install
842 salt-call --state-output=mixed --local state.apply -l ${LOG_LEVEL}
844 # Finally, make sure that /etc/hosts is not overwritten on reboot
845 if [ -d /etc/cloud/cloud.cfg.d ]; then
846 # TODO: will this work on CentOS?
847 sed -i 's/^manage_etc_hosts: true/#manage_etc_hosts: true/g' /etc/cloud/cloud.cfg.d/*
850 # Leave a copy of the Arvados CA so the user can copy it where it's required
851 if [ "${SSL_MODE}" = "self-signed" ]; then
852 echo "Copying the Arvados CA certificate '${CLUSTER}.${DOMAIN}-arvados-snakeoil-ca.crt' to the installer dir, so you can import it"
853 if [ "x${VAGRANT}" = "xyes" ]; then
854 cp /etc/ssl/certs/arvados-snakeoil-ca.pem /vagrant/${CLUSTER}.${DOMAIN}-arvados-snakeoil-ca.pem
856 cp /etc/ssl/certs/arvados-snakeoil-ca.pem ${SCRIPT_DIR}/${CLUSTER}.${DOMAIN}-arvados-snakeoil-ca.crt
860 if [ "x${VAGRANT}" = "xyes" ]; then
861 # If running in a vagrant VM, also add default user to docker group
862 echo "Adding the vagrant user to the docker group"
863 usermod -a -G docker vagrant
866 # Test that the installation finished correctly
867 if [ "x${TEST}" = "xyes" ]; then
869 # If we use RVM, we need to run this with it, or most ruby commands will fail
871 if [ -x /usr/local/rvm/bin/rvm-exec ]; then
872 RVM_EXEC="/usr/local/rvm/bin/rvm-exec"
874 ${RVM_EXEC} ./run-test.sh