tools/salt-install/local.params.example.multiple_hosts

   1 ##########################################################
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: CC-BY-SA-3.0
   5
   6 # These are the basic parameters to configure the installation
   7
   8 # The FIVE ALPHANUMERIC CHARACTERS name you want to give your cluster
   9 CLUSTER="cluster_fixme_or_this_wont_work"
  10
  11 # The domainname you want tou give to your cluster's hosts
  12 DOMAIN="domain_fixme_or_this_wont_work"
  13
  14 # Host SSL port where you want to point your browser to access Arvados
  15 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
  16 # You can point it to another port if desired
  17 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
  18 CONTROLLER_EXT_SSL_PORT=443
  19 KEEP_EXT_SSL_PORT=443
  20 # Both for collections and downloads
  21 KEEPWEB_EXT_SSL_PORT=443
  22 WEBSHELL_EXT_SSL_PORT=443
  23 WEBSOCKET_EXT_SSL_PORT=443
  24 WORKBENCH1_EXT_SSL_PORT=443
  25 WORKBENCH2_EXT_SSL_PORT=443
  26
  27 # Internal IPs for the configuration
  28 CLUSTER_INT_CIDR=10.0.0.0/16
  29
  30 # Note the IPs in this example are shared between roles, as suggested in
  31 # https://doc.arvados.org/main/install/salt-multi-host.html
  32 CONTROLLER_INT_IP=10.0.0.1
  33 WEBSOCKET_INT_IP=10.0.0.1
  34 KEEP_INT_IP=10.0.0.2
  35 # Both for collections and downloads
  36 KEEPWEB_INT_IP=10.0.0.2
  37 KEEPSTORE0_INT_IP=10.0.0.3
  38 KEEPSTORE1_INT_IP=10.0.0.4
  39 WORKBENCH1_INT_IP=10.0.0.5
  40 WORKBENCH2_INT_IP=10.0.0.5
  41 WEBSHELL_INT_IP=10.0.0.5
  42 DATABASE_INT_IP=10.0.0.6
  43 SHELL_INT_IP=10.0.0.7
  44
  45 INITIAL_USER="admin"
  46
  47 # If not specified, the initial user email will be composed as
  48 # INITIAL_USER@CLUSTER.DOMAIN
  49 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
  50 INITIAL_USER_PASSWORD="password"
  51
  52 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
  53 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
  54 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
  55 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
  56 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
  57 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
  58 DATABASE_PASSWORD=please_set_this_to_some_secure_value
  59
  60 # SSL CERTIFICATES
  61 # Arvados REQUIRES valid SSL to work correctly. Otherwise, some components will fail
  62 # to communicate and can silently drop traffic. You can try to use the Letsencrypt
  63 # salt formula (https://github.com/saltstack-formulas/letsencrypt-formula) to try to
  64 # automatically obtain and install SSL certificates for your instances or set this
  65 # variable to "no", provide and upload your own certificates to the instances and
  66 # modify the 'nginx_*' salt pillars accordingly (see CUSTOM_CERTS_DIR below)
  67 USE_LETSENCRYPT="yes"
  68 USE_LETSENCRYPT_IAM_USER="yes"
  69 # For collections, we need to obtain a wildcard certificate for
  70 # '*.collections.<cluster>.<domain>'. This is only possible through a DNS-01 challenge.
  71 # For that reason, you'll need to provide AWS credentials with permissions to manage
  72 # RRs in the route53 zone for the cluster.
  73 # WARNING!: If AWS credentials files already exist in the hosts, they won't be replaced.
  74 LE_AWS_REGION="us-east-1"
  75 LE_AWS_ACCESS_KEY_ID="AKIABCDEFGHIJKLMNOPQ"
  76 LE_AWS_SECRET_ACCESS_KEY="thisistherandomstringthatisyoursecretkey"
  77
  78 # If you going to provide your own certificates for Arvados, the provision script can
  79 # help you deploy them. In order to do that, you need to set `USE_LETSENCRYPT=no` above,
  80 # and copy the required certificates under the directory specified in the next line.
  81 # The certs will be copied from this directory by the provision script.
  82 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
  83 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
  84 # directory where the  "provision.sh" script was copied in the destination host.
  85 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs"
  86 # The script expects cert/key files with these basenames (matching the role except for
  87 # keepweb, which is split in both download/collections):
  88 #  "controller"
  89 #  "websocket"
  90 #  "workbench"
  91 #  "workbench2"
  92 #  "webshell"
  93 #  "download"         # Part of keepweb
  94 #  "collections"      # Part of keepweb
  95 #  "keepproxy"        # Keepproxy
  96 # Ie., 'keep', the script will lookup for
  97 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
  98 # ${CUSTOM_CERTS_DIR}/keepproxy.key
  99
 100 # The directory to check for the config files (pillars, states) you want to use.
 101 # There are a few examples under 'config_examples'.
 102 # CONFIG_DIR="local_config_dir"
 103 # Extra states to apply. If you use your own subdir, change this value accordingly
 104 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
 105
 106 # These are ARVADOS-related settings.
 107 # Which release of Arvados repo you want to use
 108 RELEASE="production"
 109 # Which version of Arvados you want to install. Defaults to latest stable
 110 # VERSION="2.1.2-1"
 111
 112 # This is an arvados-formula setting.
 113 # If branch is set, the script will switch to it before running salt
 114 # Usually not needed, only used for testing
 115 # BRANCH="main"
 116
 117 ##########################################################
 118 # Usually there's no need to modify things below this line
 119
 120 # Formulas versions
 121 # ARVADOS_TAG="2.2.0"
 122 # POSTGRES_TAG="v0.41.6"
 123 # NGINX_TAG="temp-fix-missing-statements-in-pillar"
 124 # DOCKER_TAG="v2.0.7"
 125 # LOCALE_TAG="v0.3.4"
 126 # LETSENCRYPT_TAG="v2.1.0"