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