16379: Reorganize local.params examples
[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 Arvados cluster ID, needs to be 5 lowercase alphanumeric characters.
9 CLUSTER="cluster_fixme_or_this_wont_work"
10
11 # The domainname for your cluster's hosts
12 DOMAIN="domain_fixme_or_this_wont_work"
13
14 # For multi-node installs, the ssh log in for each node
15 # must be root or able to sudo
16 DEPLOY_USER=admin
17
18 INITIAL_USER=admin
19
20 # If not specified, the initial user email will be composed as
21 # INITIAL_USER@CLUSTER.DOMAIN
22 INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work"
23 INITIAL_USER_PASSWORD="fixmepassword"
24
25 # Populate these values with random strings
26 BLOB_SIGNING_KEY=fixmeblobsigningkeymushaveatleast32characters
27 MANAGEMENT_TOKEN=fixmemanagementtokenmushaveatleast32characters
28 SYSTEM_ROOT_TOKEN=fixmesystemroottokenmushaveatleast32characters
29 ANONYMOUS_USER_TOKEN=fixmeanonymoususertokenmushaveatleast32characters
30 WORKBENCH_SECRET_KEY=fixmeworkbenchsecretkeymushaveatleast32characters
31 DATABASE_PASSWORD=fixmeplease_set_this_to_some_secure_value
32
33 # SSL CERTIFICATES
34 # Arvados requires SSL certificates to work correctly. This installer supports these options:
35 # * self-signed: let the installer create self-signed certificate(s)
36 # * bring-your-own: supply your own certificate(s) in the `certs` directory
37 # * lets-encrypt: automatically obtain and install SSL certificates for your hostname(s)
38 #
39 # See https://doc.arvados.org/intall/salt-single-host.html#certificates for more information.
40 SSL_MODE="self-signed"
41
42 # CUSTOM_CERTS_DIR is only used when SSL_MODE is set to "bring-your-own".
43 # See https://doc.arvados.org/intall/salt-single-host.html#bring-your-own for more information.
44 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
45
46 # Set the following to "yes" if the key files are encrypted and optionally set
47 # a custom AWS secret name for each node to retrieve the password.
48 SSL_KEY_ENCRYPTED="no"
49 SSL_KEY_AWS_SECRET_NAME="${CLUSTER}-arvados-ssl-privkey-password"
50
51 # Customize Prometheus & Grafana web UI access credentials
52 MONITORING_USERNAME=${INITIAL_USER}
53 MONITORING_PASSWORD=${INITIAL_USER_PASSWORD}
54 MONITORING_EMAIL=${INITIAL_USER_EMAIL}
55 # Sets the directory for Grafana dashboards
56 # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards"
57
58 # The mapping of nodes to roles
59 # installer.sh will log in to each of these nodes and then provision
60 # it for the specified roles.
61 NODES=(
62   [localhost]=''
63 )
64
65 # HOSTNAME_EXT must be set to the address that users will use to
66 # connect to the instance (e.g. what they will type into the URL bar
67 # of the browser to get to workbench).  If you haven't given the
68 # instance a working DNS name, you might need to use an IP address
69 # here.
70 HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work"
71
72 # The internal IP address for the host.
73 IP_INT="ip_int_fixme_or_this_wont_work"
74
75 # External ports used by the Arvados services
76 CONTROLLER_EXT_SSL_PORT=8800
77 KEEP_EXT_SSL_PORT=8801
78 KEEPWEB_EXT_SSL_PORT=8802
79 WEBSHELL_EXT_SSL_PORT=8803
80 WEBSOCKET_EXT_SSL_PORT=8804
81 WORKBENCH1_EXT_SSL_PORT=8805
82 WORKBENCH2_EXT_SSL_PORT=443
83
84 # The directory to check for the config files (pillars, states) you want to use.
85 # There are a few examples under 'config_examples'.
86 # CONFIG_DIR="local_config_dir"
87
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.44.0"
108 # NGINX_TAG="v2.8.1"
109 # DOCKER_TAG="v2.4.2"
110 # LOCALE_TAG="v0.3.4"
111 # LETSENCRYPT_TAG="v2.1.0"
112 # PROMETHEUS_TAG="v5.6.5"
113 # GRAFANA_TAG="v3.1.3"