16522: Merge branch 'master' into 16522-python3-arvados-fuse

[arvados.git] / doc / install / install-dispatch-cloud.html.textile.liquid

diff --git a/doc/install/install-dispatch-cloud.html.textile.liquid b/doc/install/install-dispatch-cloud.html.textile.liquid
index af75b877928e96d0542e276430f18d2bc3edae1a..7bff6a4a246511a15e332284095f435219aca378 100644 (file)
--- a/doc/install/install-dispatch-cloud.html.textile.liquid
+++ b/doc/install/install-dispatch-cloud.html.textile.liquid
@@ -9,6 +9,10 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
+{% include 'notebox_begin_warning' %}
+arvados-dispatch-cloud is only relevant for cloud installations. Skip this section if you are installing a on premise cluster that will spool jobs to Slurm.
+{% include 'notebox_end' %}
+
 # "Introduction":#introduction
 # "Create compute node VM image":#create-image
 # "Update config.yml":#update-config
@@ -23,9 +27,18 @@ The cloud dispatch service is for running containers on cloud VMs. It works with
 
 The cloud dispatch service can run on any node that can connect to the Arvados API service, the cloud provider's API, and the SSH service on cloud VMs.  It is not resource-intensive, so you can run it on the API server node.
 
-h2(#create-image). Create compute node VM image
+h2(#create-image). Create compute node VM image and configure resolver
+
+Set up a VM following the steps "to set up a compute node":crunch2-slurm/install-compute-node.html
+
+Compute nodes must be able to resolve the hostnames of the API server and any keepstore servers to your internal IP addresses.  You can do this by running an internal DNS resolver and configuring the compute VMs to use that resolver, or by hardcoding the services in the @/etc/hosts@ file.  For example:
+
+<notextile><pre><code>10.20.30.40     <span class="userinput">ClusterID.example.com</span>
+10.20.30.41     <span class="userinput">keep1.ClusterID.example.com</span>
+10.20.30.42     <span class="userinput">keep2.ClusterID.example.com</span>
+</code></pre></notextile>
 
-Create a VM image following the steps "to set up a compute node":crunch2-slurm/install-compute-node.html
+Once the VM is fully configured, create a reusable VM image from it and make note of the image id.
 
 h2(#update-config). Update config.yml
 
@@ -60,7 +73,7 @@ You can delete the key files after you have copied the private key to your confi
 
 h3. Configure CloudVMs
 
-Add or update the following portions of your cluster configuration file, @/etc/arvados/config.yml@. Refer to "config.defaults.yml":{{site.baseurl}}/admin/config.html for information about additional configuration options.
+Add or update the following portions of your cluster configuration file, @config.yml@. Refer to "config.defaults.yml":{{site.baseurl}}/admin/config.html for information about additional configuration options.
 
 <notextile>
 <pre><code>    Services:
@@ -166,17 +179,18 @@ $ az account list
 
 You will need to create a "service principal" to use as a delegated authority for API access.
 
-<pre>
-$ az ad app create --display-name "Arvados Dispatch Cloud (ClusterID)" --homepage "https://arvados.org" --identifier-uris "https://ClusterID.example.com" --end-date 2299-12-31 --password <Your_Password>
-$ az ad sp create "<appId>"
+<notextile><pre><code>$ az ad app create --display-name "Arvados Dispatch Cloud (<span class="userinput">ClusterID</span>)" --homepage "https://arvados.org" --identifier-uris "https://<span class="userinput">ClusterID.example.com</span>" --end-date 2299-12-31 --password <span class="userinput">Your_Password</span>
+$ az ad sp create "<span class="userinput">appId</span>"
 (appId is part of the response of the previous command)
-$ az role assignment create --assignee "<objectId>" --role Owner --scope /subscriptions/{subscriptionId}/
+$ az role assignment create --assignee "<span class="userinput">objectId</span>" --role Owner --scope /subscriptions/{subscriptionId}/
 (objectId is part of the response of the previous command)
-</pre>
+</code></pre></notextile>
+
+Now update your @config.yml@ file:
 
 @ClientID@ is the 'appId' value.
 
-@ClientSecret@ is what was provided as <Your_Password>.
+@ClientSecret@ is what was provided as <span class="userinput">Your_Password</span>.
 
 h3. Test your configuration