Bug #7342

[Documentation] Install guide explains a few different deployment options

Added by Brett Smith almost 4 years ago. Updated over 3 years ago.

Assigned To:
Target version:
Start date:
Due date:
% Done:


Estimated time:
Story points:


Right now the Install Guide prerequisites page starts with a table of seven different nodes you must have to run an Arvados cluster. This is a good recommendation, but it gives some readers the impression that that number is more set in stone than it actually is. This story expands the documentation to better differentiate what services are required, and what their hardware requirements are.

New installation prerequisites

Update the table at the top of the prerequisites to spell out three tiers of requirements: required nodes, required services, and optional services.

Required nodes:
  • at least one compute node
  • at least two Keepstore nodes
Required services: these services are required for an Arvados cluster to run. Each row can be deployed on a dedicated node, or they can be deployed on the same node.
  • SSO server
  • API server, Websockets, Git servers, and Crunch dispatcher
  • Workbench
  • SLURM controller
Optional services: these services make Arvados more usable, but are not strictly required to run a cluster.
  • Keepproxy: Sends data to and from Keepstores on behalf of clients outside the cluster's network. Required for Workbench's file upload functionality. Can be deployed separately, or together with other required services listed above.
  • Shell server: Provides a convenient location on the network for users to SSH in and run Arvados CLI client tools. You can omit this if your users can install Python and Ruby client tools on their own workstations. Should be deployed on a dedicated node as a security precaution.

Supporting changes

  • Separate the SLURM controller installation guide from the Crunch dispatcher installation guide.
    • On the compute node install guide, update the link to SLURM installation instructions to this new page.
  • The Crunch dispatcher installation guide should note that the dispatcher needs to be able to talk to the SLURM controller, and document the process. (I believe it's the same as the exsiting steps; the only difference is that the Crunch dispatcher won't be the host listed as the SLURM controller in the configuration.)
  • At the beginning of the shell node install guide, note that a dedicated shell node is optional, but you must have the Python and Ruby SDKs installed on some machine in order to continue with the installation. Anybody who deploys without a dedicated shell node should at least install those SDKs on a machine near the cluster, and use them to continue with the installation as directed.


#1 Updated by Brett Smith almost 4 years ago

  • Target version set to Arvados Future Sprints

#2 Updated by Peter Grandi over 3 years ago

The git service installation docs don't mention that at the end one ought to do the "Create standard objects" section.

Also available in: Atom PDF