Merge branch '17583-federated-token-reqs'. Closes #17583
[arvados.git] / tools / salt-install / local.params.example.single_host_multiple_hostnames
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=25101
20 # Both for collections and downloads
21 KEEPWEB_EXT_SSL_PORT=9002
22 WEBSHELL_EXT_SSL_PORT=4202
23 WEBSOCKET_EXT_SSL_PORT=8002
24 WORKBENCH1_EXT_SSL_PORT=443
25 WORKBENCH2_EXT_SSL_PORT=3001
26
27 INITIAL_USER="admin"
28
29 # If not specified, the initial user email will be composed as
30 # INITIAL_USER@CLUSTER.DOMAIN
31 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
32 INITIAL_USER_PASSWORD="password"
33
34 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
35 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
36 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
37 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
38 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
39 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
40 DATABASE_PASSWORD=please_set_this_to_some_secure_value
41
42 # SSL CERTIFICATES
43 # Arvados REQUIRES valid SSL to work correctly. Otherwise, some components will
44 # fail to communicate and can silently drop traffic. Set USE_LETSENCRYPT="yes"
45 # to use the Let's Encrypt salt formula
46 # (https://github.com/saltstack-formulas/letsencrypt-formula) to automatically
47 # obtain and install SSL certificates for your hostname(s).
48 #
49 # Alternatively, set this variable to "no" and provide and upload your own
50 # certificates to the instances and modify the 'nginx_*' salt pillars
51 # accordingly
52 USE_LETSENCRYPT="no"
53
54 # If you going to provide your own certificates for Arvados, the provision script can
55 # help you deploy them. In order to do that, you need to set `USE_LETSENCRYPT=no` above,
56 # and copy the required certificates under the directory specified in the next line.
57 # The certs will be copied from this directory by the provision script.
58 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
59 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
60 # directory where the  "provision.sh" script was copied in the destination host.
61 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs"
62 # The script expects cert/key files with these basenames (matching the role except for
63 # keepweb, which is split in both download/collections):
64 #  "controller"
65 #  "websocket"
66 #  "workbench"
67 #  "workbench2"
68 #  "webshell"
69 #  "download"         # Part of keepweb
70 #  "collections"      # Part of keepweb
71 #  "keepproxy"
72 # Ie., 'keepproxy', the script will lookup for
73 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
74 # ${CUSTOM_CERTS_DIR}/keepproxy.key
75
76 # The directory to check for the config files (pillars, states) you want to use.
77 # There are a few examples under 'config_examples'.
78 # CONFIG_DIR="local_config_dir"
79 # Extra states to apply. If you use your own subdir, change this value accordingly
80 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
81
82 # These are ARVADOS-related settings.
83 # Which release of Arvados repo you want to use
84 RELEASE="production"
85 # Which version of Arvados you want to install. Defaults to latest stable
86 # VERSION="2.1.2-1"
87
88 # This is an arvados-formula setting.
89 # If branch is set, the script will switch to it before running salt
90 # Usually not needed, only used for testing
91 # BRANCH="main"
92
93 ##########################################################
94 # Usually there's no need to modify things below this line
95
96 # Formulas versions
97 # ARVADOS_TAG="2.2.0"
98 # POSTGRES_TAG="v0.41.6"
99 # NGINX_TAG="temp-fix-missing-statements-in-pillar"
100 # DOCKER_TAG="v2.0.7"
101 # LOCALE_TAG="v0.3.4"
102 # LETSENCRYPT_TAG="v2.1.0"