From: Peter Amstutz Date: Mon, 17 Oct 2022 20:12:15 +0000 (-0400) Subject: 19215: Formatting fixes X-Git-Tag: 2.5.0~21^2~22 X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/feb45077eb3b766df63d048d492aaf7aca3d2be2?ds=sidebyside 19215: Formatting fixes Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid index d4c33434e2..ab101e7688 100644 --- a/doc/install/salt-multi-host.html.textile.liquid +++ b/doc/install/salt-multi-host.html.textile.liquid @@ -37,11 +37,11 @@ h2(#prerequisites). Prerequisites and planning h3. Cluster ID and base domain -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. +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 the base domain for the cluster. This will be referred to as ${DOMAIN} +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". +For example, if CLUSTER is @xarv1@ and DOMAIN is @example.com@, then @controller.${CLUSTER}.${DOMAIN}@" means @controller.xargv1.example.com@. h3. Virtual Private Cloud (AWS specific) @@ -308,7 +308,7 @@ h2(#initial_user). Initial user and login At this point you should be able to log into the Arvados cluster. The initial URL will be -https://workbench.${CLUSTER}.${DOMAIN} +https://workbench.@${CLUSTER}.${DOMAIN}@ If you did *not* "configure a different authentication provider":#authentication you will be using the "Test" provider, and the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster. It uses the values of @INITIAL_USER@ and @INITIAL_USER_PASSWORD@ the @local.params@ file. diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid index d9afc53c15..646b7536b7 100644 --- a/doc/install/salt-single-host.html.textile.liquid +++ b/doc/install/salt-single-host.html.textile.liquid @@ -39,16 +39,16 @@ h2(#prerequisites). Prerequisites and planning h3. Cluster ID and base domain -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. +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. * 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} +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". +For example, if CLUSTER is @xarv1@ and DOMAIN is @example.com@, then @controller.${CLUSTER}.${DOMAIN}@" means @controller.xargv1.example.com@. h3. Machine specification @@ -223,7 +223,7 @@ https://${HOSTNAME_EXT} For the multi-hostname install, it will be: -https://workbench.${CLUSTER}.${DOMAIN} +https://workbench.@${CLUSTER}.${DOMAIN}@ If you did *not* "configure a different authentication provider":#authentication you will be using the "Test" provider, and the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster. It uses the values of @INITIAL_USER@ and @INITIAL_USER_PASSWORD@ the @local.params@ file.