Choose a 5-character cluster identifier that will represent the cluster. Here are "guidelines on choosing a cluster identifier":../architecture/federation.html#cluster_id . Only lowercase letters and digits 0-9 are allowed. Examples will use @xarv1@ or ${CLUSTER}, you should substitute the cluster id you have selected.
-Determine if you will use a single hostname, or multiple hostnames. A single hostname is simpler (and can even be used without a hostname at all, just a bare IP address), however multiple hostnames may make it easier to migrate to a multi-host production configuration in the future.
+Determine if you will use a single hostname, or multiple hostnames.
-Determine if you are using multiple hostnames, determine the base domain for the cluster. This will be referred to as ${DOMAIN}
+* Single hostname is simpler to set up and can even be used without a hostname at all, just a bare IP address.
+* Multiple hostnames is more similar to the recommended production configuration may make it easier to migrate to a multi-host production configuration in the future, but is more complicated as it requires adding a number of DNS entries.
+
+If you are using multiple hostnames, determine the base domain for the cluster. This will be referred to as ${DOMAIN}
For example, if CLUSTER is "xarv1" and DOMAIN is "example.com", then "controller.${CLUSTER}.${DOMAIN}" means "controller.xargv1.example.com".
-h3. Dedicated machine
+h3. Machine specification
You will need a dedicated (virtual) machine for your Arvados server with at least 2 cores and 8 GiB of RAM (4+ cores / 16+ GiB recommended) running a supported Linux distribution:
h3(#DNS). DNS hostnames for each service
-If you are using the multi-hostname configuration, you will need a DNS entry for each service. If you are using a single hostname for all services (they will be distingushed by listening port), you can skip this section.
+If you are using a single hostname for all services (they will be distingushed by listening port), you can skip this section.
+
+If you are using the multi-hostname configuration, you will need a DNS entry for each service. If you are using "bring-your-own" TLS certificates, your certificate will need to include all of these hostnames.
In the default configuration these are:
# @webshell.${CLUSTER}.${DOMAIN}@
# @shell.${CLUSTER}.${DOMAIN}@
+This is described in more detail in "DNS entries and TLS certificates":install-manual-prerequisites.html#dnstls.
+
h3. Additional prerequisites
# Passwordless @sudo@ access on the account where you are doing the install
# Port 443 reachable by clients
# For the single-host install, ports 8800-8805 also need to be reachable from your client (configurable in @local.params@, see below)
# When using "Let's Encrypt":#lets-encrypt port 80 needs to be reachable from everywhere on the internet
-# When using "bring your own certificate":#bring-your-own)an SSL certificate matching the hostname in use
+# When using "bring your own certificate":#bring-your-own you need TLS certificate(s) covering the hostname(s) used by Arvados
h2(#download). Download the installer
h2(#initial_user). Initial user and login
-At this point you should be able to log into the Arvados cluster. The initial URL for the single hostname install will be:
+At this point you should be able to log into the Arvados cluster. The initial URL for the single hostname install will use the hostname or IP address you put in @HOSTNAME_EXT@:
-https://@HOSTNAME_EXT@
+https://${HOSTNAME_EXT}
For the multi-hostname install, it will be:
projects / arvados.git / blobdiff