18624: documentation: describe the arvados-dispatch-cloud requirements

       for compute nodes.

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward@curii.com>

diff --git a/doc/install/crunch2-cloud/install-compute-node.html.textile.liquid b/doc/install/crunch2-cloud/install-compute-node.html.textile.liquid
index a56519fb1bad4c090d01763fafd6a7acaf3209c4..0db4708c02ecc8846a3457a9003aebed07287c6d 100644 (file)
--- a/doc/install/crunch2-cloud/install-compute-node.html.textile.liquid
+++ b/doc/install/crunch2-cloud/install-compute-node.html.textile.liquid
@@ -15,6 +15,7 @@ SPDX-License-Identifier: CC-BY-SA-3.0
 
 # "Introduction":#introduction
 # "Create an SSH keypair":#sshkeypair
+# "Compute image requirements":#requirements
 # "The build script":#building
 # "Singularity mksquashfs configuration":#singularity_mksquashfs_configuration
 # "Build an AWS image":#aws
@@ -59,7 +60,18 @@ foktmqOY8MyctzFgXBpGTxPliGjqo8OkrOyQP2g+FL7v+Km31Xs61P8=
 
 {% include 'singularity_mksquashfs_configuration' %}
 
-The desired amount of memory to make available for @mksquashfs@ can be configured in an argument to the build script, see the next section. It defaults to @256M@.
+The desired amount of memory to make available for @mksquashfs@ can be configured in an argument to "the build script":#building. It defaults to @256M@.
+
+h2(#requirements). Compute image requirements
+
+Arvados comes with a build script to automate the creation of a suitable compute node image (see "The build script":#building below). It is provided as a convenience. It is also possible to create a compoute node image via other means. These are the requirements:
+
+* for AWS: the ssh public key for @arvados-dispatch-cloud@ (the one that corresponds with @Containers/DispatchPrivateKey@ in the Arvados config file) needs to go into ~/.ssh/authorized_keys for the ssh user you want @arvados-dispatch-cloud@ to use (cf. @CloudVMs/DriverParameters/AdminUsername@ in the Arvados config file) and that user needs to be able to sudo without password prompt, unless you use `root` in which case sudo is not used.
+* for Azure: @arvados-dispatch-cloud@ automatically extracts the ssh public key from the value of @Containers/DispatchPrivateKey@ and uses an API call to create the user specified in @CloudVMs/DriverParameters/AdminUsername@ with that ssh public key and password-less sudo enabled.
+* SSH needs to be running and reachable by @arvados-dispatch-cloud@ on port 22 (or a custom port, see @CloudVMS/SSHPort@ to in the Arvados config file)
+* the @python3-arvados-fuse@ package needs to be installed
+* @Docker@ or @Singularity@ needs to be installed and running (cf. @Containers/RuntimeEngine@ in the Arvados config file).
+* all available scratch space should be made available under `/tmp`.
 
 h2(#building). The build script