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.$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=admin
  18
  19 INITIAL_USER=admin
  20
  21 # If not specified, the initial user email will be composed as
  22 # INITIAL_USER@DOMAIN
  23 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
  24
  25 # Use a public node as a jump host for SSH sessions. This allows running the
  26 # installer from the outside of the cluster's local network and still reach
  27 # the internal servers for configuration deployment.
  28 # Comment out to disable.
  29 USE_SSH_JUMPHOST="controller.${DOMAIN}"
  30
  31 AWS_REGION="fixme_or_this_wont_work"
  32
  33 # SSL CERTIFICATES
  34 # Arvados requires SSL certificates to work correctly. This installer supports these options:
  35 # * self-signed: let the installer create self-signed certificate(s)
  36 # * bring-your-own: supply your own certificate(s) in the `certs` directory
  37 # * lets-encrypt: automatically obtain and install SSL certificates for your hostname(s)
  38 #
  39 # See https://doc.arvados.org/intall/salt-multi-host.html for more information.
  40 SSL_MODE="lets-encrypt"
  41 USE_LETSENCRYPT_ROUTE53="yes"
  42 # For collections, we need to obtain a wildcard certificate for
  43 # '*.collections.<cluster>.<domain>'. This is only possible through a DNS-01 challenge.
  44 # For that reason, you'll need to provide AWS credentials with permissions to manage
  45 # RRs in the route53 zone for the cluster.
  46 # WARNING!: If AWS credentials files already exist in the hosts, they won't be replaced.
  47 LE_AWS_REGION="${AWS_REGION}"
  48
  49 # Compute node configurations
  50 COMPUTE_AMI="ami_id_fixme_or_this_wont_work"
  51 COMPUTE_SG="security_group_fixme_or_this_wont_work"
  52 COMPUTE_SUBNET="subnet_fixme_or_this_wont_work"
  53 COMPUTE_AWS_REGION="${AWS_REGION}"
  54 COMPUTE_USER="${DEPLOY_USER}"
  55
  56 # Keep S3 backend region
  57 KEEP_AWS_REGION="${AWS_REGION}"
  58
  59 # If you going to provide your own certificates for Arvados, the provision script can
  60 # help you deploy them. In order to do that, you need to set `SSL_MODE=bring-your-own` above,
  61 # and copy the required certificates under the directory specified in the next line.
  62 # The certs will be copied from this directory by the provision script.
  63 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
  64 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
  65 # directory where the  "provision.sh" script was copied in the destination host.
  66 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
  67 # The script expects cert/key files with these basenames (matching the role except for
  68 # keepweb, which is split in both download/collections):
  69 #  "controller"
  70 #  "websocket"
  71 #  "workbench"
  72 #  "workbench2"
  73 #  "webshell"
  74 #  "download"         # Part of keepweb
  75 #  "collections"      # Part of keepweb
  76 #  "keepproxy"        # Keepproxy
  77 #  "prometheus"
  78 #  "grafana"
  79 # Ie., 'keep', the script will lookup for
  80 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
  81 # ${CUSTOM_CERTS_DIR}/keepproxy.key
  82
  83 # Set the following to "yes" if the key files are encrypted and optionally set
  84 # a custom AWS secret name for each node to retrieve the password.
  85 SSL_KEY_ENCRYPTED="no"
  86 SSL_KEY_AWS_SECRET_NAME="${CLUSTER}-arvados-ssl-privkey-password"
  87 SSL_KEY_AWS_REGION="${AWS_REGION}"
  88
  89 # Customize Prometheus & Grafana web UI access credentials
  90 MONITORING_USERNAME=${INITIAL_USER}
  91 MONITORING_EMAIL=${INITIAL_USER_EMAIL}
  92
  93 # Sets the directory for Grafana dashboards
  94 # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards"
  95
  96 # Sets the amount of data (expressed in time) Prometheus keeps on its
  97 # time-series database. Default is 15 days.
  98 # PROMETHEUS_DATA_RETENTION_TIME="180d"
  99
 100 # The mapping of nodes to roles
 101 # installer.sh will log in to each of these nodes and then provision
 102 # it for the specified roles.
 103 NODES=(
 104   [controller.${DOMAIN}]=database,controller
 105   [workbench.${DOMAIN}]=monitoring,workbench,workbench2,webshell,keepproxy,keepweb,websocket,dispatcher,keepbalance
 106   [keep0.${DOMAIN}]=keepstore
 107   [shell.${DOMAIN}]=shell
 108 )
 109
 110 # Host SSL port where you want to point your browser to access Arvados
 111 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
 112 # You can point it to another port if desired
 113 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
 114 CONTROLLER_EXT_SSL_PORT=443
 115 KEEP_EXT_SSL_PORT=443
 116 # Both for collections and downloads
 117 KEEPWEB_EXT_SSL_PORT=443
 118 WEBSHELL_EXT_SSL_PORT=443
 119 WEBSOCKET_EXT_SSL_PORT=443
 120 WORKBENCH1_EXT_SSL_PORT=443
 121 WORKBENCH2_EXT_SSL_PORT=443
 122
 123 # Internal IPs for the configuration
 124 CLUSTER_INT_CIDR=10.1.0.0/16
 125
 126 # Note the IPs in this example are shared between roles, as suggested in
 127 # https://doc.arvados.org/main/install/salt-multi-host.html
 128 CONTROLLER_INT_IP=10.1.1.11
 129 DATABASE_INT_IP=${CONTROLLER_INT_IP}
 130 WORKBENCH1_INT_IP=10.1.1.15
 131 DISPATCHER_INT_IP=${WORKBENCH1_INT_IP}
 132 KEEPBALANCE_INT_IP=${WORKBENCH1_INT_IP}
 133 WEBSOCKET_INT_IP=${WORKBENCH1_INT_IP}
 134 # Both for collections and downloads
 135 KEEPWEB_INT_IP=${WORKBENCH1_INT_IP}
 136 WORKBENCH2_INT_IP=${WORKBENCH1_INT_IP}
 137 WEBSHELL_INT_IP=${WORKBENCH1_INT_IP}
 138 KEEP_INT_IP=${WORKBENCH1_INT_IP}
 139 KEEPSTORE0_INT_IP=10.1.2.13
 140 SHELL_INT_IP=10.1.2.17
 141
 142 # Set this if using an external PostgreSQL service.
 143 #DATABASE_EXTERNAL_SERVICE_HOST_OR_IP=
 144
 145 # Performance tuning parameters.  If these are not set, workers
 146 # defaults on the number of cpus and queued requests defaults to 128.
 147 #CONTROLLER_MAX_WORKERS=
 148 #CONTROLLER_MAX_QUEUED_REQUESTS=
 149
 150 # The directory to check for the config files (pillars, states) you want to use.
 151 # There are a few examples under 'config_examples'.
 152 # CONFIG_DIR="local_config_dir"
 153
 154 # Extra states to apply. If you use your own subdir, change this value accordingly
 155 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
 156
 157 # These are ARVADOS-related settings.
 158 # Which release of Arvados repo you want to use
 159 RELEASE="production"
 160 # Which version of Arvados you want to install. Defaults to latest stable
 161 # VERSION="2.1.2-1"
 162
 163 # This is an arvados-formula setting.
 164 # If branch is set, the script will switch to it before running salt
 165 # Usually not needed, only used for testing
 166 # BRANCH="main"
 167
 168 ##########################################################
 169 # Usually there's no need to modify things below this line
 170
 171 # Formulas versions
 172 # ARVADOS_TAG="2.2.0"
 173 # POSTGRES_TAG="v0.44.0"
 174 # NGINX_TAG="v2.8.1"
 175 # DOCKER_TAG="v2.4.2"
 176 # LOCALE_TAG="v0.3.4"
 177 # LETSENCRYPT_TAG="v2.1.0"
 178 # PROMETHEUS_TAG="v5.6.5"
 179 # GRAFANA_TAG="v3.1.3"