Documentation tweaks for the Salt installer.
[arvados.git] / tools / salt-install / local.params.example.single_host_single_hostname
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 # Set this value when installing a cluster in a single host with a single hostname
15 # to access all the instances. Not used in the other examples.
16 # When using virtualization (ie AWS), this should be
17 # the EXTERNAL/PUBLIC hostname for the instance.
18 # If empty, ${CLUSTER}.${DOMAIN} will be used
19 HOSTNAME_EXT=""
20 # The internal hostname for the host. In the example files, only used in the
21 # single_host/single_hostname example
22 HOSTNAME_INT="127.0.1.1"
23 # Host SSL port where you want to point your browser to access Arvados
24 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
25 # You can point it to another port if desired
26 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
27 CONTROLLER_EXT_SSL_PORT=9443
28 KEEP_EXT_SSL_PORT=35101
29 # Both for collections and downloads
30 KEEPWEB_EXT_SSL_PORT=11002
31 WEBSHELL_EXT_SSL_PORT=14202
32 WEBSOCKET_EXT_SSL_PORT=18002
33 WORKBENCH1_EXT_SSL_PORT=9444
34 WORKBENCH2_EXT_SSL_PORT=9445
35
36 INITIAL_USER="admin"
37
38 # If not specified, the initial user email will be composed as
39 # INITIAL_USER@CLUSTER.DOMAIN
40 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
41 INITIAL_USER_PASSWORD="password"
42
43 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
44 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
45 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
46 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
47 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
48 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
49 DATABASE_PASSWORD=please_set_this_to_some_secure_value
50
51 # SSL CERTIFICATES
52 # Arvados REQUIRES valid SSL to work correctly. Otherwise, some components will
53 # fail to communicate and can silently drop traffic. Set USE_LETSENCRYPT="yes"
54 # to use the Let's Encrypt salt formula
55 # (https://github.com/saltstack-formulas/letsencrypt-formula) to automatically
56 # obtain and install SSL certificates for your hostname(s).
57 #
58 # Alternatively, set this variable to "no" and provide and upload your own
59 # certificates to the instances and modify the 'nginx_*' salt pillars
60 # accordingly
61 USE_LETSENCRYPT="no"
62
63 # The directory to check for the config files (pillars, states) you want to use.
64 # There are a few examples under 'config_examples'.
65 # CONFIG_DIR="local_config_dir"
66 # Extra states to apply. If you use your own subdir, change this value accordingly
67 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
68
69 # These are ARVADOS-related settings.
70 # Which release of Arvados repo you want to use
71 RELEASE="production"
72 # Which version of Arvados you want to install. Defaults to latest stable
73 # VERSION="2.1.2-1"
74
75 # This is an arvados-formula setting.
76 # If branch is set, the script will switch to it before running salt
77 # Usually not needed, only used for testing
78 # BRANCH="main"
79
80 ##########################################################
81 # Usually there's no need to modify things below this line
82
83 # Formulas versions
84 # ARVADOS_TAG="2.2.0"
85 # POSTGRES_TAG="v0.41.6"
86 # NGINX_TAG="temp-fix-missing-statements-in-pillar"
87 # DOCKER_TAG="v2.0.7"
88 # LOCALE_TAG="v0.3.4"
89 # LETSENCRYPT_TAG="v2.1.0"