18874: Merge branch 'main' from arvados-workbench2.git
[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
24 # SSL CERTIFICATES
25 # Arvados requires SSL certificates to work correctly. This installer supports these options:
26 # * self-signed: let the installer create self-signed certificate(s)
27 # * bring-your-own: supply your own certificate(s) in the `certs` directory
28 # * lets-encrypt: automatically obtain and install SSL certificates for your hostname(s)
29 #
30 # See https://doc.arvados.org/intall/salt-single-host.html#certificates for more information.
31 SSL_MODE="self-signed"
32
33 # CUSTOM_CERTS_DIR is only used when SSL_MODE is set to "bring-your-own".
34 # See https://doc.arvados.org/intall/salt-single-host.html#bring-your-own for more information.
35 # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/local_config_dir/certs"
36
37 # Set the following to "yes" if the key files are encrypted and optionally set
38 # a custom AWS secret name for each node to retrieve the password.
39 SSL_KEY_ENCRYPTED="no"
40 SSL_KEY_AWS_SECRET_NAME="${CLUSTER}-arvados-ssl-privkey-password"
41
42 # Customize Prometheus & Grafana web UI access credentials
43 MONITORING_USERNAME=${INITIAL_USER}
44 MONITORING_PASSWORD=${INITIAL_USER_PASSWORD}
45 MONITORING_EMAIL=${INITIAL_USER_EMAIL}
46 # Sets the directory for Grafana dashboards
47 # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards"
48
49 # The mapping of nodes to roles
50 # installer.sh will log in to each of these nodes and then provision
51 # it for the specified roles.
52 NODES=(
53   [localhost]=''
54 )
55
56 # HOSTNAME_EXT must be set to the address that users will use to
57 # connect to the instance (e.g. what they will type into the URL bar
58 # of the browser to get to workbench).  If you haven't given the
59 # instance a working DNS name, you might need to use an IP address
60 # here.
61 HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work"
62
63 # The internal IP address for the host.
64 IP_INT="ip_int_fixme_or_this_wont_work"
65
66 # External ports used by the Arvados services
67 CONTROLLER_EXT_SSL_PORT=8800
68 KEEP_EXT_SSL_PORT=8801
69 KEEPWEB_EXT_SSL_PORT=8802
70 WEBSHELL_EXT_SSL_PORT=8803
71 WEBSOCKET_EXT_SSL_PORT=8804
72 WORKBENCH1_EXT_SSL_PORT=8805
73 WORKBENCH2_EXT_SSL_PORT=443
74
75 CLUSTER_INT_CIDR=""
76 CONTROLLER_INT_IP=""
77 DATABASE_INT_IP=""
78 WORKBENCH1_INT_IP=""
79 DISPATCHER_INT_IP=""
80 KEEPBALANCE_INT_IP=""
81 WEBSOCKET_INT_IP=""
82 KEEPWEB_INT_IP=""
83 WORKBENCH2_INT_IP=""
84 WEBSHELL_INT_IP=""
85 KEEP_INT_IP=""
86 KEEPSTORE0_INT_IP=""
87 SHELL_INT_IP=""
88
89 DATABASE_NAME="${CLUSTER}_arvados"
90 DATABASE_USER="${CLUSTER}_arvados"
91 # Set these if using an external PostgreSQL service.
92 #DATABASE_EXTERNAL_SERVICE_HOST_OR_IP=
93 #DATABASE_POSTGRESQL_VERSION=
94
95 # The directory to check for the config files (pillars, states) you want to use.
96 # There are a few examples under 'config_examples'.
97 # CONFIG_DIR="local_config_dir"
98
99 # Extra states to apply. If you use your own subdir, change this value accordingly
100 # EXTRA_STATES_DIR="${CONFIG_DIR}/states"
101
102 # These are ARVADOS-related settings.
103 # Which release of Arvados repo you want to use
104 RELEASE="production"
105 # Which version of Arvados you want to install. Defaults to latest stable
106 # VERSION="2.1.2-1"
107
108 # This is an arvados-formula setting.
109 # If branch is set, the script will switch to it before running salt
110 # Usually not needed, only used for testing
111 # BRANCH="main"
112
113 ##########################################################
114 # Usually there's no need to modify things below this line
115
116 # Formulas versions
117 # ARVADOS_TAG="2.2.0"
118 # POSTGRES_TAG="v0.44.0"
119 # NGINX_TAG="v2.8.1"
120 # DOCKER_TAG="v2.4.2"
121 # LOCALE_TAG="v0.3.4"
122 # LETSENCRYPT_TAG="v2.1.0"
123 # PROMETHEUS_TAG="v5.6.5"
124 # GRAFANA_TAG="v3.1.3"