Merge branch '17705-adc-arch-doc'
[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 FIVE ALPHANUMERIC CHARACTERS name you want to give your cluster
9 CLUSTER="cluster_fixme_or_this_wont_work"
10
11 # The domainname you want tou give to your cluster's hosts
12 DOMAIN="domain_fixme_or_this_wont_work"
13
14 # Host SSL port where you want to point your browser to access Arvados
15 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
16 # You can point it to another port if desired
17 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
18 CONTROLLER_EXT_SSL_PORT=443
19 KEEP_EXT_SSL_PORT=443
20 # Both for collections and downloads
21 KEEPWEB_EXT_SSL_PORT=443
22 WEBSHELL_EXT_SSL_PORT=443
23 WEBSOCKET_EXT_SSL_PORT=443
24 WORKBENCH1_EXT_SSL_PORT=443
25 WORKBENCH2_EXT_SSL_PORT=443
26
27 # Internal IPs for the configuration
28 CLUSTER_INT_CIDR=10.0.0.0/16
29
30 # Note the IPs in this example are shared between roles, as suggested in
31 # https://doc.arvados.org/main/install/salt-multi-host.html
32 CONTROLLER_INT_IP=10.0.0.1
33 WEBSOCKET_INT_IP=10.0.0.1
34 KEEP_INT_IP=10.0.0.2
35 # Both for collections and downloads
36 KEEPWEB_INT_IP=10.0.0.2
37 KEEPSTORE0_INT_IP=10.0.0.3
38 KEEPSTORE1_INT_IP=10.0.0.4
39 WORKBENCH1_INT_IP=10.0.0.5
40 WORKBENCH2_INT_IP=10.0.0.5
41 WEBSHELL_INT_IP=10.0.0.5
42 DATABASE_INT_IP=10.0.0.6
43 SHELL_INT_IP=10.0.0.7
44
45 INITIAL_USER="admin"
46 INITIAL_USER_PASSWORD="password"
47
48 # If not specified, the initial user email will be composed as
49 # INITIAL_USER@CLUSTER.DOMAIN
50 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
51 INITIAL_USER_PASSWORD="password"
52
53 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
54 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
55 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
56 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
57 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
58 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
59 DATABASE_PASSWORD=please_set_this_to_some_secure_value
60
61 # SSL CERTIFICATES
62 # Arvados REQUIRES valid SSL to work correctly. Otherwise, some components will fail
63 # to communicate and can silently drop traffic. You can try to use the Letsencrypt
64 # salt formula (https://github.com/saltstack-formulas/letsencrypt-formula) to try to
65 # automatically obtain and install SSL certificates for your instances or set this
66 # variable to "no", provide and upload your own certificates to the instances and
67 # modify the 'nginx_*' salt pillars accordingly
68 USE_LETSENCRYPT="yes"
69 USE_LETSENCRYPT_IAM_USER="yes"
70 # For collections, we need to obtain a wildcard certificate for
71 # '*.collections.<cluster>.<domain>'. This is only possible through a DNS-01 challenge.
72 # For that reason, you'll need to provide AWS credentials with permissions to manage
73 # RRs in the route53 zone for the cluster.
74 # WARNING!: If AWS credentials files already exist in the hosts, they won't be replaced.
75 LE_AWS_REGION="us-east-1"
76 LE_AWS_ACCESS_KEY_ID="AKIABCDEFGHIJKLMNOPQ"
77 LE_AWS_SECRET_ACCESS_KEY="thisistherandomstringthatisyoursecretkey"
78
79 # The directory to check for the config files (pillars, states) you want to use.
80 # There are a few examples under 'config_examples'.
81 # CONFIG_DIR="local_config_dir"
82 # Extra states to apply. If you use your own subdir, change this value accordingly
83 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
84
85 # These are ARVADOS-related settings.
86 # Which release of Arvados repo you want to use
87 RELEASE="production"
88 # Which version of Arvados you want to install. Defaults to latest stable
89 # VERSION="2.1.2-1"
90
91 # This is an arvados-formula setting.
92 # If branch is set, the script will switch to it before running salt
93 # Usually not needed, only used for testing
94 # BRANCH="main"
95
96 ##########################################################
97 # Usually there's no need to modify things below this line
98
99 # Formulas versions
100 # ARVADOS_TAG="2.2.0"
101 # POSTGRES_TAG="v0.41.6"
102 # NGINX_TAG="temp-fix-missing-statements-in-pillar"
103 # DOCKER_TAG="v1.0.0"
104 # LOCALE_TAG="v0.3.4"
105 # LETSENCRYPT_TAG="v2.1.0"