From: Peter Amstutz Date: Thu, 30 Mar 2023 14:56:44 +0000 (-0400) Subject: 16379: Reorganize local.params examples X-Git-Tag: 2.6.0~4^2~1 X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/3add838714e2b62091881506b90ce915b4f68501 16379: Reorganize local.params examples Make sure the things that always need to be changed are at the top. Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- diff --git a/tools/salt-install/local.params.example.multiple_hosts b/tools/salt-install/local.params.example.multiple_hosts index ef682c3193..72f910b735 100644 --- a/tools/salt-install/local.params.example.multiple_hosts +++ b/tools/salt-install/local.params.example.multiple_hosts @@ -16,47 +16,7 @@ DOMAIN="domain_fixme_or_this_wont_work" # must be root or able to sudo DEPLOY_USER=admin -# The mapping of nodes to roles -# installer.sh will log in to each of these nodes and then provision -# it for the specified roles. -NODES=( - [controller.${CLUSTER}.${DOMAIN}]=database,api,controller,websocket,dispatcher,keepbalance - [workbench.${CLUSTER}.${DOMAIN}]=monitoring,workbench,workbench2,webshell,keepproxy,keepweb - [keep0.${CLUSTER}.${DOMAIN}]=keepstore - [shell.${CLUSTER}.${DOMAIN}]=shell -) - -# Host SSL port where you want to point your browser to access Arvados -# Defaults to 443 for regular runs, and to 8443 when called in Vagrant. -# You can point it to another port if desired -# In Vagrant, make sure it matches what you set in the Vagrantfile (8443) -CONTROLLER_EXT_SSL_PORT=443 -KEEP_EXT_SSL_PORT=443 -# Both for collections and downloads -KEEPWEB_EXT_SSL_PORT=443 -WEBSHELL_EXT_SSL_PORT=443 -WEBSOCKET_EXT_SSL_PORT=443 -WORKBENCH1_EXT_SSL_PORT=443 -WORKBENCH2_EXT_SSL_PORT=443 - -# Internal IPs for the configuration -CLUSTER_INT_CIDR=10.1.0.0/16 - -# Note the IPs in this example are shared between roles, as suggested in -# https://doc.arvados.org/main/install/salt-multi-host.html -CONTROLLER_INT_IP=10.1.1.11 -WEBSOCKET_INT_IP=10.1.1.11 -KEEP_INT_IP=10.1.1.15 -# Both for collections and downloads -KEEPWEB_INT_IP=10.1.1.15 -KEEPSTORE0_INT_IP=10.1.2.13 -WORKBENCH1_INT_IP=10.1.1.15 -WORKBENCH2_INT_IP=10.1.1.15 -WEBSHELL_INT_IP=10.1.1.15 -DATABASE_INT_IP=10.1.1.11 -SHELL_INT_IP=10.1.2.17 - -INITIAL_USER="admin" +INITIAL_USER=admin # If not specified, the initial user email will be composed as # INITIAL_USER@CLUSTER.DOMAIN @@ -113,6 +73,8 @@ LE_AWS_SECRET_ACCESS_KEY="thisistherandomstringthatisyoursecretkey" # "download" # Part of keepweb # "collections" # Part of keepweb # "keepproxy" # Keepproxy +# "prometheus" +# "grafana" # Ie., 'keep', the script will lookup for # ${CUSTOM_CERTS_DIR}/keepproxy.crt # ${CUSTOM_CERTS_DIR}/keepproxy.key @@ -130,6 +92,46 @@ MONITORING_EMAIL=${INITIAL_USER_EMAIL} # Sets the directory for Grafana dashboards # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards" +# The mapping of nodes to roles +# installer.sh will log in to each of these nodes and then provision +# it for the specified roles. +NODES=( + [controller.${CLUSTER}.${DOMAIN}]=database,api,controller,websocket,dispatcher,keepbalance + [workbench.${CLUSTER}.${DOMAIN}]=monitoring,workbench,workbench2,webshell,keepproxy,keepweb + [keep0.${CLUSTER}.${DOMAIN}]=keepstore + [shell.${CLUSTER}.${DOMAIN}]=shell +) + +# Host SSL port where you want to point your browser to access Arvados +# Defaults to 443 for regular runs, and to 8443 when called in Vagrant. +# You can point it to another port if desired +# In Vagrant, make sure it matches what you set in the Vagrantfile (8443) +CONTROLLER_EXT_SSL_PORT=443 +KEEP_EXT_SSL_PORT=443 +# Both for collections and downloads +KEEPWEB_EXT_SSL_PORT=443 +WEBSHELL_EXT_SSL_PORT=443 +WEBSOCKET_EXT_SSL_PORT=443 +WORKBENCH1_EXT_SSL_PORT=443 +WORKBENCH2_EXT_SSL_PORT=443 + +# Internal IPs for the configuration +CLUSTER_INT_CIDR=10.1.0.0/16 + +# Note the IPs in this example are shared between roles, as suggested in +# https://doc.arvados.org/main/install/salt-multi-host.html +CONTROLLER_INT_IP=10.1.1.11 +WEBSOCKET_INT_IP=10.1.1.11 +KEEP_INT_IP=10.1.1.15 +# Both for collections and downloads +KEEPWEB_INT_IP=10.1.1.15 +KEEPSTORE0_INT_IP=10.1.2.13 +WORKBENCH1_INT_IP=10.1.1.15 +WORKBENCH2_INT_IP=10.1.1.15 +WEBSHELL_INT_IP=10.1.1.15 +DATABASE_INT_IP=10.1.1.11 +SHELL_INT_IP=10.1.2.17 + # The directory to check for the config files (pillars, states) you want to use. # There are a few examples under 'config_examples'. # CONFIG_DIR="local_config_dir" diff --git a/tools/salt-install/local.params.example.single_host_multiple_hostnames b/tools/salt-install/local.params.example.single_host_multiple_hostnames index b94d687e4b..5633c6cbf0 100644 --- a/tools/salt-install/local.params.example.single_host_multiple_hostnames +++ b/tools/salt-install/local.params.example.single_host_multiple_hostnames @@ -13,29 +13,14 @@ DOMAIN="domain_fixme_or_this_wont_work" # For multi-node installs, the ssh log in for each node # must be root or able to sudo -DEPLOY_USER=root +DEPLOY_USER=admin -# The mapping of nodes to roles -# installer.sh will log in to each of these nodes and then provision -# it for the specified roles. -NODES=( - [localhost]='' -) - -# External ports used by the Arvados services -CONTROLLER_EXT_SSL_PORT=443 -KEEP_EXT_SSL_PORT=25101 -KEEPWEB_EXT_SSL_PORT=9002 -WEBSHELL_EXT_SSL_PORT=4202 -WEBSOCKET_EXT_SSL_PORT=8002 -WORKBENCH1_EXT_SSL_PORT=443 -WORKBENCH2_EXT_SSL_PORT=3001 +INITIAL_USER=admin -INITIAL_USER="admin" # If not specified, the initial user email will be composed as # INITIAL_USER@CLUSTER.DOMAIN INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work" -INITIAL_USER_PASSWORD="password" +INITIAL_USER_PASSWORD="fixmepassword" # YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS BLOB_SIGNING_KEY=fixmeblobsigningkeymushaveatleast32characters @@ -70,6 +55,22 @@ MONITORING_EMAIL=${INITIAL_USER_EMAIL} # Sets the directory for Grafana dashboards # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards" +# The mapping of nodes to roles +# installer.sh will log in to each of these nodes and then provision +# it for the specified roles. +NODES=( + [localhost]='' +) + +# External ports used by the Arvados services +CONTROLLER_EXT_SSL_PORT=443 +KEEP_EXT_SSL_PORT=25101 +KEEPWEB_EXT_SSL_PORT=9002 +WEBSHELL_EXT_SSL_PORT=4202 +WEBSOCKET_EXT_SSL_PORT=8002 +WORKBENCH1_EXT_SSL_PORT=443 +WORKBENCH2_EXT_SSL_PORT=3001 + # The directory to check for the config files (pillars, states) you want to use. # There are a few examples under 'config_examples'. # CONFIG_DIR="local_config_dir" @@ -98,3 +99,5 @@ RELEASE="production" # DOCKER_TAG="v2.4.2" # LOCALE_TAG="v0.3.4" # LETSENCRYPT_TAG="v2.1.0" +# PROMETHEUS_TAG="v5.6.5" +# GRAFANA_TAG="v3.1.3" diff --git a/tools/salt-install/local.params.example.single_host_single_hostname b/tools/salt-install/local.params.example.single_host_single_hostname index 42c1ebb72b..0c4f5c3567 100644 --- a/tools/salt-install/local.params.example.single_host_single_hostname +++ b/tools/salt-install/local.params.example.single_host_single_hostname @@ -13,39 +13,14 @@ DOMAIN="domain_fixme_or_this_wont_work" # For multi-node installs, the ssh log in for each node # must be root or able to sudo -DEPLOY_USER=root +DEPLOY_USER=admin -# The mapping of nodes to roles -# installer.sh will log in to each of these nodes and then provision -# it for the specified roles. -NODES=( - [localhost]='' -) - -# HOSTNAME_EXT must be set to the address that users will use to -# connect to the instance (e.g. what they will type into the URL bar -# of the browser to get to workbench). If you haven't given the -# instance a working DNS name, you might need to use an IP address -# here. -HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work" +INITIAL_USER=admin -# The internal IP address for the host. -IP_INT="ip_int_fixme_or_this_wont_work" - -# External ports used by the Arvados services -CONTROLLER_EXT_SSL_PORT=8800 -KEEP_EXT_SSL_PORT=8801 -KEEPWEB_EXT_SSL_PORT=8802 -WEBSHELL_EXT_SSL_PORT=8803 -WEBSOCKET_EXT_SSL_PORT=8804 -WORKBENCH1_EXT_SSL_PORT=8805 -WORKBENCH2_EXT_SSL_PORT=443 - -INITIAL_USER="admin" # If not specified, the initial user email will be composed as # INITIAL_USER@CLUSTER.DOMAIN INITIAL_USER_EMAIL="admin@cluster_fixme_or_this_wont_work.domain_fixme_or_this_wont_work" -INITIAL_USER_PASSWORD="password" +INITIAL_USER_PASSWORD="fixmepassword" # Populate these values with random strings BLOB_SIGNING_KEY=fixmeblobsigningkeymushaveatleast32characters @@ -80,6 +55,32 @@ MONITORING_EMAIL=${INITIAL_USER_EMAIL} # Sets the directory for Grafana dashboards # GRAFANA_DASHBOARDS_DIR="${SCRIPT_DIR}/local_config_dir/dashboards" +# The mapping of nodes to roles +# installer.sh will log in to each of these nodes and then provision +# it for the specified roles. +NODES=( + [localhost]='' +) + +# HOSTNAME_EXT must be set to the address that users will use to +# connect to the instance (e.g. what they will type into the URL bar +# of the browser to get to workbench). If you haven't given the +# instance a working DNS name, you might need to use an IP address +# here. +HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work" + +# The internal IP address for the host. +IP_INT="ip_int_fixme_or_this_wont_work" + +# External ports used by the Arvados services +CONTROLLER_EXT_SSL_PORT=8800 +KEEP_EXT_SSL_PORT=8801 +KEEPWEB_EXT_SSL_PORT=8802 +WEBSHELL_EXT_SSL_PORT=8803 +WEBSOCKET_EXT_SSL_PORT=8804 +WORKBENCH1_EXT_SSL_PORT=8805 +WORKBENCH2_EXT_SSL_PORT=443 + # The directory to check for the config files (pillars, states) you want to use. # There are a few examples under 'config_examples'. # CONFIG_DIR="local_config_dir" @@ -108,3 +109,5 @@ RELEASE="production" # DOCKER_TAG="v2.4.2" # LOCALE_TAG="v0.3.4" # LETSENCRYPT_TAG="v2.1.0" +# PROMETHEUS_TAG="v5.6.5" +# GRAFANA_TAG="v3.1.3"