From ab34e19c37f3d0e4486c6eed65b9a112db6938b4 Mon Sep 17 00:00:00 2001 From: Ward Vandewege Date: Tue, 1 Mar 2022 14:22:52 -0500 Subject: [PATCH] 18785: update defaults and comments in local.params files. Arvados-DCO-1.1-Signed-off-by: Ward Vandewege --- .../salt-single-host.html.textile.liquid | 2 +- ...ams.example.single_host_multiple_hostnames | 31 +++----------- ...params.example.single_host_single_hostname | 41 ++++++++----------- 3 files changed, 24 insertions(+), 50 deletions(-) diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid index 6a0d17a31e..2aa188d0f0 100644 --- a/doc/install/salt-single-host.html.textile.liquid +++ b/doc/install/salt-single-host.html.textile.liquid @@ -47,7 +47,7 @@ Prerequisites: * git * a dedicated (virtual) machine for your Arvados server with at least 2 cores and 8 GiB of RAM, running a "supported Arvados distribution":{{site.baseurl}}/install/install-manual-prerequisites.html#supportedlinux * at least one DNS hostname that resolves to the IP address of your Arvados server -* ports 443, 9443-9445, 11002, 14202, 18002, 35101 need to be reachable from your client (configurable, see below) +* ports 443, 8800-8805 need to be reachable from your client (configurable, see below) * port 80 needs to be reachable from everywhere on the internet (only when using "Let's Encrypt":#lets-encrypt) * one or more SSL certificates matching the hostname(s) in use (only when using "bring your own certificate(s)":#bring-your-own) 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 a77cb24575..77015248c1 100644 --- a/tools/salt-install/local.params.example.single_host_multiple_hostnames +++ b/tools/salt-install/local.params.example.single_host_multiple_hostnames @@ -11,13 +11,9 @@ CLUSTER="cluster_fixme_or_this_wont_work" # The domainname you want tou give to your cluster's hosts DOMAIN="domain_fixme_or_this_wont_work" -# 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) +# External ports used by the Arvados services CONTROLLER_EXT_SSL_PORT=443 KEEP_EXT_SSL_PORT=25101 -# Both for collections and downloads KEEPWEB_EXT_SSL_PORT=9002 WEBSHELL_EXT_SSL_PORT=4202 WEBSOCKET_EXT_SSL_PORT=8002 @@ -25,7 +21,6 @@ WORKBENCH1_EXT_SSL_PORT=443 WORKBENCH2_EXT_SSL_PORT=3001 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" @@ -43,35 +38,19 @@ DATABASE_PASSWORD=please_set_this_to_some_secure_value # Arvados requires SSL certificates to work correctly. This installer supports these options: # * self-signed: let the installer create self-signed certificate(s) # * bring-your-own: supply your own certificate(s) in the `certs` directory +# * lets-encrypt: automatically obtain and install SSL certificates for your hostname(s) # # See https://doc.arvados.org/intall/salt-single-host.html#certificates for more information. SSL_MODE="self-signed" -# If you going to provide your own certificates for Arvados, the provision script can -# help you deploy them. In order to do that, you need to set `SSL_MODE=bring-your-own` above, -# and copy the required certificates under the directory specified in the next line. -# The certs will be copied from this directory by the provision script. -# Please set it to the FULL PATH to the certs dir if you're going to use a different dir -# Default is "${SCRIPT_DIR}/certs", where the variable "SCRIPT_DIR" has the path to the -# directory where the "provision.sh" script was copied in the destination host. +# CUSTOM_CERTS_DIR is only used when SSL_MODE is set to "bring-your-own". +# See https://doc.arvados.org/intall/salt-single-host.html#bring-your-own for more information. # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs" -# The script expects cert/key files with these basenames (matching the role except for -# keepweb, which is split in both download/collections): -# "controller" -# "websocket" -# "workbench" -# "workbench2" -# "webshell" -# "download" # Part of keepweb -# "collections" # Part of keepweb -# "keepproxy" -# Ie., 'keepproxy', the script will lookup for -# ${CUSTOM_CERTS_DIR}/keepproxy.crt -# ${CUSTOM_CERTS_DIR}/keepproxy.key # 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" + # Extra states to apply. If you use your own subdir, change this value accordingly # EXTRA_STATES_DIR="${CONFIG_DIR}/states" 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 87d23af7d4..4c129c9c85 100644 --- a/tools/salt-install/local.params.example.single_host_single_hostname +++ b/tools/salt-install/local.params.example.single_host_single_hostname @@ -5,41 +5,36 @@ # These are the basic parameters to configure the installation -# The FIVE ALPHANUMERIC CHARACTERS name you want to give your cluster +# The Arvados cluster ID, needs to be five alphanumeric characters. CLUSTER="cluster_fixme_or_this_wont_work" -# The domainname you want tou give to your cluster's hosts +# The domainname for your cluster's hosts DOMAIN="domain_fixme_or_this_wont_work" -# Set this value when installing a cluster in a single host with a single hostname -# to access all the instances. Not used in the other examples. -# When using virtualization (ie AWS), this should be -# the EXTERNAL/PUBLIC hostname for the instance. +# Set this value when installing a cluster in a single host with a single +# hostname to access all the instances. HOSTNAME_EXT should be set to the +# external hostname for the instance. HOSTNAME_EXT="hostname_ext_fixme_or_this_wont_work" -# The internal hostname for the host. In the example files, only used in the -# single_host/single_hostname example + +# The internal IP address for the host. IP_INT="ip_int_fixme_or_this_wont_work" -# 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=9443 -KEEP_EXT_SSL_PORT=35101 -# Both for collections and downloads -KEEPWEB_EXT_SSL_PORT=11002 -WEBSHELL_EXT_SSL_PORT=14202 -WEBSOCKET_EXT_SSL_PORT=18002 -WORKBENCH1_EXT_SSL_PORT=443 -WORKBENCH2_EXT_SSL_PORT=9445 -INITIAL_USER="admin" +# 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" -# YOU SHOULD CHANGE THESE TO SOME RANDOM STRINGS +# Populate these values with random strings BLOB_SIGNING_KEY=blobsigningkeymushaveatleast32characters MANAGEMENT_TOKEN=managementtokenmushaveatleast32characters SYSTEM_ROOT_TOKEN=systemroottokenmushaveatleast32characters @@ -56,7 +51,7 @@ DATABASE_PASSWORD=please_set_this_to_some_secure_value # See https://doc.arvados.org/intall/salt-single-host.html#certificates for more information. SSL_MODE="self-signed" -# Only used when SSL_MODE is set to "bring-your-own". +# CUSTOM_CERTS_DIR is only used when SSL_MODE is set to "bring-your-own". # See https://doc.arvados.org/intall/salt-single-host.html#bring-your-own for more information. # CUSTOM_CERTS_DIR="${SCRIPT_DIR}/certs" -- 2.30.2