18785: edit documentation, addressing review comments

Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <jbertoli@curii.com>

diff --git a/doc/_includes/_install_custom_certificates.liquid b/doc/_includes/_install_custom_certificates.liquid
index 3c6486505c5cb66fce08a419b270bc51b5522fc8..a6d809d151dce9c41e9b05bc55fec944901ba292 100644 (file)
--- a/doc/_includes/_install_custom_certificates.liquid
+++ b/doc/_includes/_install_custom_certificates.liquid
@@ -6,7 +6,15 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 
 If you plan to use custom certificates, please set the variable <i>SSL_MODE=bring-your-own</i> and copy your certificates to the directory specified with the variable @CUSTOM_CERTS_DIR@ (usually "./certs") in the remote directory where you copied the @provision.sh@ script. From this dir, the provision script will install the certificates required for the role you're installing.
 
 
 If you plan to use custom certificates, please set the variable <i>SSL_MODE=bring-your-own</i> and copy your certificates to the directory specified with the variable @CUSTOM_CERTS_DIR@ (usually "./certs") in the remote directory where you copied the @provision.sh@ script. From this dir, the provision script will install the certificates required for the role you're installing.
 

-The script expects cert/key files with these basenames (matching the role except for <i>keepweb</i>, which is split in both <i>download / collections</i>):
+When using custom certificates in a single-host / single-hostname setup, the certificate and its key need to be copied to a file named after <i>${HOSTNAME_EXT}</i>. Ie., for "HOSTNAME_EXT='my-arvados.example.net', the script will lookup for
+<notextile>
+<pre><code>
+# ${CUSTOM_CERTS_DIR}/my-arvados.example.net.crt
+# ${CUSTOM_CERTS_DIR}/my-arvados.example.net.key
+</code></pre>
+</notextile>
+
+For a setup with multiple hostnames, the script expects cert/key files with these basenames (matching the role except for <i>keepweb</i>, which is split in both <i>download / collections</i>):

 
 * "controller"
 * "websocket"
 
 * "controller"
 * "websocket"

diff --git a/doc/install/salt-single-host.html.textile.liquid b/doc/install/salt-single-host.html.textile.liquid
index 6d08672e4656e0f1ca7d772af3de6c703da59df6..3610741b41a0638e0a1f05560723ce43c614d206 100644 (file)
--- a/doc/install/salt-single-host.html.textile.liquid
+++ b/doc/install/salt-single-host.html.textile.liquid
@@ -13,7 +13,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 # "Prerequisites":#prerequisites
 # "Single host install using the provision.sh script":#single_host
 # "Choose the desired configuration":#choose_configuration
 # "Prerequisites":#prerequisites
 # "Single host install using the provision.sh script":#single_host
 # "Choose the desired configuration":#choose_configuration

-## "Single host / single hostname":#single_host_single_hostnames
+## "Single host / single hostname":#single_host_single_hostname

 ## "Single host / multiple hostnames (Alternative configuration)":#single_host_multiple_hostnames
 ## "Further customization of the installation (modifying the salt pillars and states)":#further_customization
 # "Run the provision.sh script":#run_provision_script
 ## "Single host / multiple hostnames (Alternative configuration)":#single_host_multiple_hostnames
 ## "Further customization of the installation (modifying the salt pillars and states)":#further_customization
 # "Run the provision.sh script":#run_provision_script


@@ -78,7 +78,7 @@ Arvados' single host installation can be done in two fashions:
 
 Once you decide which of these choices you prefer, copy one the two example configuration files and directory, and edit them to suit your needs.
 
 
 Once you decide which of these choices you prefer, copy one the two example configuration files and directory, and edit them to suit your needs.
 

-h3(#single_host_single_hostnames). Single host / single hostname
+h3(#single_host_single_hostname). Single host / single hostname

 <notextile>
 <pre><code>cp local.params.example.single_host_single_hostname local.params
 cp -r config_examples/single_host/single_hostname local_config_dir
 <notextile>
 <pre><code>cp local.params.example.single_host_single_hostname local.params
 cp -r config_examples/single_host/single_hostname local_config_dir