20889: Allows configurable S3 bucket name and IAM profile for Keep backend.
[arvados.git] / 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 settings
57 KEEP_AWS_REGION="${AWS_REGION}"
58 KEEP_AWS_S3_BUCKET="${CLUSTER}-nyw5e-000000000000000-volume"
59 KEEP_AWS_IAM_ROLE="${CLUSTER}-keepstore-00-iam-role"
60
61 # If you going to provide your own certificates for Arvados, the provision script can
62 # help you deploy them. In order to do that, you need to set `SSL_MODE=bring-your-own` above,
63 # and copy the required certificates under the directory specified in the next line.
64 # The certs will be copied from this directory by the provision script.
65 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
66 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
67 # directory where the  "provision.sh" script was copied in the destination host.
68 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
69 # The script expects cert/key files with these basenames (matching the role except for
70 # keepweb, which is split in both download/collections):
71 #  "controller"
72 #  "websocket"
73 #  "workbench"
74 #  "workbench2"
75 #  "webshell"
76 #  "download"         # Part of keepweb
77 #  "collections"      # Part of keepweb
78 #  "keepproxy"        # Keepproxy
79 #  "prometheus"
80 #  "grafana"
81 # Ie., 'keep', the script will lookup for
82 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
83 # ${CUSTOM_CERTS_DIR}/keepproxy.key
84
85 # Set the following to "yes" if the key files are encrypted and optionally set
86 # a custom AWS secret name for each node to retrieve the password.
87 SSL_KEY_ENCRYPTED="no"
88 SSL_KEY_AWS_SECRET_NAME="${CLUSTER}-arvados-ssl-privkey-password"
89 SSL_KEY_AWS_REGION="${AWS_REGION}"
90
91 # Customize Prometheus & Grafana web UI access credentials
92 MONITORING_USERNAME=${INITIAL_USER}
93 MONITORING_EMAIL=${INITIAL_USER_EMAIL}
94
95 # Sets the directory for Grafana dashboards
96 # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards"
97
98 # Sets the amount of data (expressed in time) Prometheus keeps on its
99 # time-series database. Default is 15 days.
100 # PROMETHEUS_DATA_RETENTION_TIME="180d"
101
102 # The mapping of nodes to roles
103 # installer.sh will log in to each of these nodes and then provision
104 # it for the specified roles.
105 NODES=(
106   [controller.${DOMAIN}]=database,controller
107   [workbench.${DOMAIN}]=monitoring,workbench,workbench2,webshell,keepproxy,keepweb,websocket,dispatcher,keepbalance
108   [keep0.${DOMAIN}]=keepstore
109   [shell.${DOMAIN}]=shell
110 )
111
112 # Host SSL port where you want to point your browser to access Arvados
113 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
114 # You can point it to another port if desired
115 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
116 CONTROLLER_EXT_SSL_PORT=443
117 KEEP_EXT_SSL_PORT=443
118 # Both for collections and downloads
119 KEEPWEB_EXT_SSL_PORT=443
120 WEBSHELL_EXT_SSL_PORT=443
121 WEBSOCKET_EXT_SSL_PORT=443
122 WORKBENCH1_EXT_SSL_PORT=443
123 WORKBENCH2_EXT_SSL_PORT=443
124
125 # Internal IPs for the configuration
126 CLUSTER_INT_CIDR=10.1.0.0/16
127
128 # Note the IPs in this example are shared between roles, as suggested in
129 # https://doc.arvados.org/main/install/salt-multi-host.html
130 CONTROLLER_INT_IP=10.1.1.11
131 DATABASE_INT_IP=${CONTROLLER_INT_IP}
132 WORKBENCH1_INT_IP=10.1.1.15
133 DISPATCHER_INT_IP=${WORKBENCH1_INT_IP}
134 KEEPBALANCE_INT_IP=${WORKBENCH1_INT_IP}
135 WEBSOCKET_INT_IP=${WORKBENCH1_INT_IP}
136 # Both for collections and downloads
137 KEEPWEB_INT_IP=${WORKBENCH1_INT_IP}
138 WORKBENCH2_INT_IP=${WORKBENCH1_INT_IP}
139 WEBSHELL_INT_IP=${WORKBENCH1_INT_IP}
140 KEEP_INT_IP=${WORKBENCH1_INT_IP}
141 KEEPSTORE0_INT_IP=10.1.2.13
142 SHELL_INT_IP=10.1.2.17
143
144 # Set this if using an external PostgreSQL service.
145 #DATABASE_EXTERNAL_SERVICE_HOST_OR_IP=
146
147 # Performance tuning parameters.  If these are not set, workers
148 # defaults on the number of cpus and queued requests defaults to 128.
149 #CONTROLLER_MAX_WORKERS=
150 #CONTROLLER_MAX_QUEUED_REQUESTS=
151
152 # The directory to check for the config files (pillars, states) you want to use.
153 # There are a few examples under 'config_examples'.
154 # CONFIG_DIR="local_config_dir"
155
156 # Extra states to apply. If you use your own subdir, change this value accordingly
157 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
158
159 # These are ARVADOS-related settings.
160 # Which release of Arvados repo you want to use
161 RELEASE="production"
162 # Which version of Arvados you want to install. Defaults to latest stable
163 # VERSION="2.1.2-1"
164
165 # This is an arvados-formula setting.
166 # If branch is set, the script will switch to it before running salt
167 # Usually not needed, only used for testing
168 # BRANCH="main"
169
170 ##########################################################
171 # Usually there's no need to modify things below this line
172
173 # Formulas versions
174 # ARVADOS_TAG="2.2.0"
175 # POSTGRES_TAG="v0.44.0"
176 # NGINX_TAG="v2.8.1"
177 # DOCKER_TAG="v2.4.2"
178 # LOCALE_TAG="v0.3.4"
179 # LETSENCRYPT_TAG="v2.1.0"
180 # PROMETHEUS_TAG="v5.6.5"
181 # GRAFANA_TAG="v3.1.3"