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 Arvados cluster ID, needs to be 5 lowercase alphanumeric characters.
   9 CLUSTER="cluster_fixme_or_this_wont_work"
  10
  11 # The domain name you want to give to your cluster's hosts
  12 # the end result hostnames will be $SERVICE.$CLUSTER.$DOMAIN
  13 DOMAIN="domain_fixme_or_this_wont_work"
  14
  15 # For multi-node installs, the ssh log in for each node
  16 # must be root or able to sudo
  17 DEPLOY_USER=root
  18
  19 # The mapping of nodes to roles
  20 # installer.sh will log in to each of these nodes and then provision
  21 # it for the specified roles.
  22 declare -A NODES
  23 NODES=(
  24   [controller.${CLUSTER}.$DOMAIN]=api,controller,websocket,dispatcher,keepbalance
  25   [keep0.${CLUSTER}.$DOMAIN]=keepstore
  26   [keep1.${CLUSTER}.$DOMAIN]=keepstore
  27   [keep.${CLUSTER}.$DOMAIN]=keepproxy,keepweb
  28   [workbench.${CLUSTER}.$DOMAIN]=workbench,workbench2,webshell
  29   [shell.${CLUSTER}.$DOMAIN]=shell
  30 )
  31
  32 # Host SSL port where you want to point your browser to access Arvados
  33 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
  34 # You can point it to another port if desired
  35 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
  36 CONTROLLER_EXT_SSL_PORT=443
  37 KEEP_EXT_SSL_PORT=443
  38 # Both for collections and downloads
  39 KEEPWEB_EXT_SSL_PORT=443
  40 WEBSHELL_EXT_SSL_PORT=443
  41 WEBSOCKET_EXT_SSL_PORT=443
  42 WORKBENCH1_EXT_SSL_PORT=443
  43 WORKBENCH2_EXT_SSL_PORT=443
  44
  45 # Internal IPs for the configuration
  46 CLUSTER_INT_CIDR=10.0.0.0/16
  47
  48 # Note the IPs in this example are shared between roles, as suggested in
  49 # https://doc.arvados.org/main/install/salt-multi-host.html
  50 CONTROLLER_INT_IP=10.0.0.1
  51 WEBSOCKET_INT_IP=10.0.0.1
  52 KEEP_INT_IP=10.0.0.2
  53 # Both for collections and downloads
  54 KEEPWEB_INT_IP=10.0.0.2
  55 KEEPSTORE0_INT_IP=10.0.0.3
  56 KEEPSTORE1_INT_IP=10.0.0.4
  57 WORKBENCH1_INT_IP=10.0.0.5
  58 WORKBENCH2_INT_IP=10.0.0.5
  59 WEBSHELL_INT_IP=10.0.0.5
  60 DATABASE_INT_IP=10.0.0.6
  61 SHELL_INT_IP=10.0.0.7
  62
  63 INITIAL_USER="admin"
  64
  65 # If not specified, the initial user email will be composed as
  66 # INITIAL_USER@CLUSTER.DOMAIN
  67 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
  68 INITIAL_USER_PASSWORD="password"
  69
  70 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
  71 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
  72 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
  73 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
  74 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
  75 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
  76 DATABASE_PASSWORD=please_set_this_to_some_secure_value
  77
  78 # SSL CERTIFICATES
  79 # Arvados requires SSL certificates to work correctly. This installer supports these options:
  80 # * self-signed: let the installer create self-signed certificate(s)
  81 # * bring-your-own: supply your own certificate(s) in the `certs` directory
  82 # * lets-encrypt: automatically obtain and install SSL certificates for your hostname(s)
  83 #
  84 # See https://doc.arvados.org/intall/salt-multi-host.html for more information.
  85 SSL_MODE="lets-encrypt"
  86 USE_LETSENCRYPT_ROUTE53="yes"
  87 # For collections, we need to obtain a wildcard certificate for
  88 # '*.collections.<cluster>.<domain>'. This is only possible through a DNS-01 challenge.
  89 # For that reason, you'll need to provide AWS credentials with permissions to manage
  90 # RRs in the route53 zone for the cluster.
  91 # WARNING!: If AWS credentials files already exist in the hosts, they won't be replaced.
  92 LE_AWS_REGION="us-east-1"
  93 LE_AWS_ACCESS_KEY_ID="AKIABCDEFGHIJKLMNOPQ"
  94 LE_AWS_SECRET_ACCESS_KEY="thisistherandomstringthatisyoursecretkey"
  95
  96 # If you going to provide your own certificates for Arvados, the provision script can
  97 # help you deploy them. In order to do that, you need to set `SSL_MODE=bring-your-own` above,
  98 # and copy the required certificates under the directory specified in the next line.
  99 # The certs will be copied from this directory by the provision script.
 100 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
 101 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
 102 # directory where the  "provision.sh" script was copied in the destination host.
 103 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
 104 # The script expects cert/key files with these basenames (matching the role except for
 105 # keepweb, which is split in both download/collections):
 106 #  "controller"
 107 #  "websocket"
 108 #  "workbench"
 109 #  "workbench2"
 110 #  "webshell"
 111 #  "download"         # Part of keepweb
 112 #  "collections"      # Part of keepweb
 113 #  "keepproxy"        # Keepproxy
 114 # Ie., 'keep', the script will lookup for
 115 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
 116 # ${CUSTOM_CERTS_DIR}/keepproxy.key
 117
 118 # The directory to check for the config files (pillars, states) you want to use.
 119 # There are a few examples under 'config_examples'.
 120 # CONFIG_DIR="local_config_dir"
 121 # Extra states to apply. If you use your own subdir, change this value accordingly
 122 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
 123
 124 # These are ARVADOS-related settings.
 125 # Which release of Arvados repo you want to use
 126 RELEASE="production"
 127 # Which version of Arvados you want to install. Defaults to latest stable
 128 # VERSION="2.1.2-1"
 129
 130 # This is an arvados-formula setting.
 131 # If branch is set, the script will switch to it before running salt
 132 # Usually not needed, only used for testing
 133 # BRANCH="main"
 134
 135 ##########################################################
 136 # Usually there's no need to modify things below this line
 137
 138 # Formulas versions
 139 # ARVADOS_TAG="2.2.0"
 140 # POSTGRES_TAG="v0.44.0"
 141 # NGINX_TAG="v2.8.1"
 142 # DOCKER_TAG="v2.4.2"
 143 # LOCALE_TAG="v0.3.4"
 144 # LETSENCRYPT_TAG="v2.1.0"