X-Git-Url: https://git.arvados.org/arvados-formula.git/blobdiff_plain/bceb58ada62e79bf9387a352669dfb0eb722b730..82e381619cd53f5dc5093e3a412b83405fdbe5d8:/docs/README.rst
diff --git a/docs/README.rst b/docs/README.rst
index e5982c7..0fb3eda 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -44,7 +44,22 @@ Please see `How to contribute `_ you can find `a provision script `_
+to deploy a single-node, all-in-one Arvados cluster (The script uses this formula to get a cluster up and running in Saltstack's master-less mode).
+
+The `single-node` install does not include SLURM: it is intended for an `all-in-one-host` installation,
+so it uses `crunch-dispatch-local` to run containers in the same instance.
+
+The provision script can be run anywhere, so you can run it in an AWS instance and you'll get a `single-node` Arvados cluster there.
+
+The Arvados formula allows you to `install any dispatcher available `_,
+provided you configure the pillars the way you need them.
+
+Arvados currently has three dispatchers:
+
+* **crunch-dispatch-local** (for single node installations),
+* **arvados-dispatch-cloud** (for dynamic compute on AWS or Azure) and
+* **crunch-dispatch-slurm** (for SLURM integration).
Requisites
----------
@@ -56,7 +71,10 @@ We suggest you use the `postgres-formula `_ and the
`letsencrypt-formula `_ to satisfy these dependencies.
In the **test/salt/pillar/examples/** directory there are example pillar YAMLs to set up these packages, using the mentioned formulas
-as Arvados needs them.
+as Arvados needs them.a
+
+In the **test/salt/states/examples/** directory there are some example helper states to set up a few requirements for single-node
+(all-in-one) Arvados host.
Usage
-----