18785: remove comment addressing review suggestions
[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 HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work"
19 # The internal hostname for the host. In the example files, only used in the
20 # single_host/single_hostname example
21 IP_INT="127.0.1.1"
22 # Host SSL port where you want to point your browser to access Arvados
23 # Defaults to 443 for regular runs, and to 8443 when called in Vagrant.
24 # You can point it to another port if desired
25 # In Vagrant, make sure it matches what you set in the Vagrantfile (8443)
26 CONTROLLER_EXT_SSL_PORT=9443
27 KEEP_EXT_SSL_PORT=35101
28 # Both for collections and downloads
29 KEEPWEB_EXT_SSL_PORT=11002
30 WEBSHELL_EXT_SSL_PORT=14202
31 WEBSOCKET_EXT_SSL_PORT=18002
32 WORKBENCH1_EXT_SSL_PORT=9444
33 WORKBENCH2_EXT_SSL_PORT=9445
34
35 INITIAL_USER="admin"
36
37 # If not specified, the initial user email will be composed as
38 # INITIAL_USER@CLUSTER.DOMAIN
39 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
40 INITIAL_USER_PASSWORD="password"
41
42 # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS
43 BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters
44 MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters
45 SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters
46 ANONYMOUS_USER_TOKEN=anonymoususertokenmushaveatleast32characters
47 WORKBENCH_SECRET_KEY=workbenchsecretkeymushaveatleast32characters
48 DATABASE_PASSWORD=please_set_this_to_some_secure_value
49
50 # SSL CERTIFICATES
51 # Arvados requires SSL certificates to work correctly. This installer supports these options:
52 # * self-signed: let the installer create self-signed certificate(s)
53 # * bring-your-own: supply your own certificate(s) in the `certs` directory
54 #
55 # See https://doc.arvados.org/intall/salt-single-host.html#certificates for more information.
56 SSL_MODE="self-signed"
57
58 # If you want to use letsencrypt, set SSL_MODE="lets-encrypt"
59 # A single certificate for the external hostname of the host will be retrieved, using
60 # "standalone" mode of LE.
61
62 # If you going to provide your own certificates for Arvados, the provision script can
63 # help you deploy them. In order to do that, you need to set `SSL_MODE=bring-your-own` above,
64 # and copy the required certificates under the directory specified in the next line.
65 # The certs will be copied from this directory by the provision script.
66 # Please set it to the FULL PATH to the certs dir if you're going to use a different dir
67 # Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the
68 # directory where the  "provision.sh" script was copied in the destination host.
69 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs"
70 # The script expects cert/key files with these basenames (matching the role except for
71 # keepweb, which is split in both download/collections):
72 #  "controller"
73 #  "websocket"
74 #  "workbench"
75 #  "workbench2"
76 #  "webshell"
77 #  "download"         # Part of keepweb
78 #  "collections"      # Part of keepweb
79 #  "keepproxy"        # Keepproxy
80 # Ie., 'keep', the script will lookup for
81 # ${CUSTOM_CERTS_DIR}/keepproxy.crt
82 # ${CUSTOM_CERTS_DIR}/keepproxy.key
83
84 # The certs will be copied from this directory by the provision script.
85 # The directory to check for the config files (pillars, states) you want to use.
86 # There are a few examples under 'config_examples'.
87 # CONFIG_DIR="local_config_dir"
88 # Extra states to apply. If you use your own subdir, change this value accordingly
89 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
90
91 # These are ARVADOS-related settings.
92 # Which release of Arvados repo you want to use
93 RELEASE="production"
94 # Which version of Arvados you want to install. Defaults to latest stable
95 # VERSION="2.1.2-1"
96
97 # This is an arvados-formula setting.
98 # If branch is set, the script will switch to it before running salt
99 # Usually not needed, only used for testing
100 # BRANCH="main"
101
102 ##########################################################
103 # Usually there's no need to modify things below this line
104
105 # Formulas versions
106 # ARVADOS_TAG="2.2.0"
107 # POSTGRES_TAG="v0.43.0"
108 # NGINX_TAG="v2.8.0"
109 # DOCKER_TAG="v2.0.7"
110 # LOCALE_TAG="v0.3.4"
111 # LETSENCRYPT_TAG="v2.1.0"