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