18791: update documentation, fix single host/single hostname installer

[arvados.git] / doc / install / salt-multi-host.html.textile.liquid

diff --git a/doc/install/salt-multi-host.html.textile.liquid b/doc/install/salt-multi-host.html.textile.liquid
index ea98b8a02eeb3ed8f475c31ec2d0e06a9818b1d2..f8723a0cef21c071fe972d0307d7f4f1a1812018 100644 (file)
--- a/doc/install/salt-multi-host.html.textile.liquid
+++ b/doc/install/salt-multi-host.html.textile.liquid
@@ -20,8 +20,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 # "Run the provision.sh script":#run_provision_script
 # "Initial user and login":#initial_user
 # "Test the installed cluster running a simple workflow":#test_install
-
-
+# "After the installation":#post_install
 
 h2(#introduction). Introduction
 
@@ -101,9 +100,11 @@ The <i>multi_host</i> example includes Let's Encrypt salt code to automatically
 
 {% include 'install_custom_certificates' %}
 
+If you want to use valid certificates provided by Let's Encrypt, set the variable <i>SSL_MODE=lets-encrypt</i> and make sure that all the FQDNs that you will use for the public-facing applications (API/controller, Workbench, Keepproxy/Keepweb) are reachable.
+
 h3(#further_customization). Further customization of the installation (modifying the salt pillars and states)
 
-You will need further customization to suit your environment, which can be done editing the Saltstack pillars and states files. Pay particular attention to the <i>pillars/arvados.sls</i> file, where you will need to provide some information that can be retrieved as output of the terraform run.
+You will need further customization to suit your environment, which can be done editing the Saltstack pillars and states files. Pay particular attention to the <i>pillars/arvados.sls</i> file, where you will need to provide some information that describes your environment.
 
 Any extra <i>state</i> file you add under <i>local_config_dir/states</i> will be added to the salt run and applied to the hosts.
 
@@ -111,9 +112,9 @@ h2(#installation_order). Installation order
 
 A few Arvados nodes need to be installed in certain order. The required order is
 
-#. Database
-#. API server
-#. The other nodes can be installed in any order after the two above
+* Database
+* API server
+* The other nodes can be installed in any order after the two above
 
 h2(#run_provision_script). Run the provision.sh script
 
@@ -121,6 +122,8 @@ When you finished customizing the configuration, you are ready to copy the files
 
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
+# if you use custom certificates (not Let's Encrypt), make sure to copy those too:
+# scp -r certs user@host:
 ssh user@host sudo ./provision.sh --roles comma,separated,list,of,roles,to,apply
 </code></pre>
 </notextile>
@@ -137,42 +140,42 @@ arvados: Failed:      0
 
 The distribution of role as described above can be applied running these commands:
 
-#. Database
+h4. Database
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles database
 </code></pre>
 </notextile>
 
-#. API
+h4. API
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles api,controller,websocket,dispatcher
 </code></pre>
 </notextile>
 
-#. Keepstore/s
+h4. Keepstore(s)
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles keepstore
 </code></pre>
 </notextile>
 
-#. Workbench
+h4. Workbench
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles workbench,workbench2,webshell
 </code></pre>
 </notextile>
 
-#. Keepproxy / Keepweb
+h4. Keepproxy / Keepweb
 <notextile>
 <pre><code>scp -r provision.sh local* user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles keepproxy,keepweb
 </code></pre>
 </notextile>
 
-#. Shell (here we copy the CLI test workflow too)
+h4. Shell (here we copy the CLI test workflow too)
 <notextile>
 <pre><code>scp -r provision.sh local* tests user@host:
 ssh user@host sudo ./provision.sh --config local.params --roles shell
@@ -288,3 +291,9 @@ INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
 INFO Final process status is success
 </code></pre>
 </notextile>
+
+h2(#post_install). After the installation
+
+Once the installation is complete, it is recommended to keep a copy of your local configuration files. Committing them to version control is a good idea.
+
+Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information.