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://github.com/arvados/arvados.git
  13 cd arvados
  14 git checkout {{ branchname }}
  15 cd tools/salt-install
  16 </code></pre>
  17 </notextile>
  18
  19 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.
  20
  21 h2(#copy_config). Initialize the installer
  22
  23 Replace "xarv1" with the cluster id you selected earlier.
  24
  25 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 if you have multiple nodes.
  26
  27 Important!  Once you have initialized the installer directory, all further commands must be run with @~/setup-arvados-${CLUSTER}@ as the current working directory.
  28
  29 h3. Using Terraform (AWS specific)
  30
  31 If you are going to use Terraform to set up the infrastructure on AWS, you first need to install the "Terraform CLI":https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli and the "AWS CLI":https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html tool.  Then you can initialize the installer.
  32
  33 <notextile>
  34 <pre><code>CLUSTER=xarv1
  35 ./installer.sh initialize ~/setup-arvados-${CLUSTER} {{local_params_src}} {{config_examples_src}} {{terraform_src}}
  36 cd ~/setup-arvados-${CLUSTER}
  37 </code></pre>
  38 </notextile>
  39
  40 h3. Without Terraform
  41
  42 <notextile>
  43 <pre><code>CLUSTER=xarv1
  44 ./installer.sh initialize ~/setup-arvados-${CLUSTER} {{local_params_src}} {{config_examples_src}}
  45 cd ~/setup-arvados-${CLUSTER}
  46 </code></pre>
  47 </notextile>