19215: Incorporate many details into install doc
[arvados.git] / doc / _includes / _download_installer.liquid
1 {% comment %}
2 Copyright (C) The Arvados Authors. All rights reserved.
3
4 SPDX-License-Identifier: CC-BY-SA-3.0
5 {% endcomment %}
6
7 {% include 'branchname' %}
8
9 This is a package-based installation method, however the installation script is currently distributed in source form via @git@. We recommend checking out the git tree on your local workstation, not directly on the target(s) where you want to install and run Arvados.
10
11 <notextile>
12 <pre><code>git clone https://git.arvados.org/arvados.git
13 git checkout {{ branchname }}
14 cd arvados/tools/salt-install
15 </code></pre>
16 </notextile>
17
18 The @install.sh@ and @provision.sh@ scripts will help you deploy Arvados by preparing your environment to be able to run the installer, then running it. The actual installer is located in the "arvados-formula git repository":https://git.arvados.org/arvados-formula.git/tree/refs/heads/{{ branchname }} and will be cloned during the running of the @provision.sh@ script.  The installer is built using "Saltstack":https://saltproject.io/ and @provision.sh@ performs the install using masterless mode.
19
20 h2(#copy_config). Initialize the installer
21
22 <notextile>
23 <pre><code>./installer.sh initialize ~/setup-arvados-xarv1 {{local_params_src}} {{config_examples_src}}
24 cd ~/setup-arvados-xarv1
25 </code></pre>
26 </notextile>
27
28 This creates a git repository in @~/setup-arvados-xarv1@.  The @installer.sh@ will record all the configuration changes you make, as well as using @git push@ to synchronize configuration edits across all the nodes.
29
30 Important!  All further commands must be run in the @~/setup-arvados-xarv1@