18658: add missing state to deploy custom certs in multi-host env
[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 fail
44 # to communicate and can silently drop traffic. You can try to use the Letsencrypt
45 # salt formula (https://github.com/saltstack-formulas/letsencrypt-formula) to try to
46 # automatically obtain and install SSL certificates for your instances or set this
47 # variable to "no", provide and upload your own certificates to the instances and
48 # modify the 'nginx_*' salt pillars accordingly (see CUSTOM_CERTS_DIR below)
49 USE_LETSENCRYPT="no"
50
51 # If you going to provide your own certificates for Arvados, the provision script can
52 # help you deploy them. In order to do that, you need to set `USE_LETSENCRYPT=no` above,
53 # and copy the required certificates under the directory specified in the next line.
54 # The certs will be copied from this directory by the provision script.
55 # Plese set it to the FULL PATH to the certs dir if you're going to use a different dir
56 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs"
57 # The script expects cert/key files with these basenames (matching the role except for
58 # keepweb, which is split in both downoad/collections):
59 #  "controller"
60 #  "websocket"
61 #  "workbench"
62 #  "workbench2"
63 #  "webshell"
64 #  "download"         # Part of keepweb
65 #  "collections"      # Part of keepweb
66 #  "keepproxy"
67 # Ie., 'keepproxy', the script will lookup for
68 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
69 # ${CUSTOM_CERTS_DIR}/keepproxy.key
70
71 # The directory to check for the config files (pillars, states) you want to use.
72 # There are a few examples under 'config_examples'.
73 # CONFIG_DIR="local_config_dir"
74 # Extra states to apply. If you use your own subdir, change this value accordingly
75 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
76
77 # These are ARVADOS-related settings.
78 # Which release of Arvados repo you want to use
79 RELEASE="production"
80 # Which version of Arvados you want to install. Defaults to latest stable
81 # VERSION="2.1.2-1"
82
83 # This is an arvados-formula setting.
84 # If branch is set, the script will switch to it before running salt
85 # Usually not needed, only used for testing
86 # BRANCH="main"
87
88 ##########################################################
89 # Usually there's no need to modify things below this line
90
91 # Formulas versions
92 # ARVADOS_TAG="2.2.0"
93 # POSTGRES_TAG="v0.41.6"
94 # NGINX_TAG="temp-fix-missing-statements-in-pillar"
95 # DOCKER_TAG="v2.0.7"
96 # LOCALE_TAG="v0.3.4"
97 # LETSENCRYPT_TAG="v2.1.0"