doc/install/salt-single-host.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Single host Arvados
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 # "Install Saltstack":#saltstack
  13 # "Single host install using the provision.sh script":#single_host
  14 # "DNS configuration":#final_steps
  15 # "Initial user and login":#initial_user
  16 # "Test the installed cluster running a simple workflow":#test_install
  17
  18 h2(#saltstack). Install Saltstack
  19
  20 If you already have a Saltstack environment you can skip this section.
  21
  22 The simplest way to get Salt up and running on a node is to use the bootstrap script they provide:
  23
  24 <notextile>
  25 <pre><code>curl -L https://bootstrap.saltstack.com -o /tmp/bootstrap_salt.sh
  26 sudo sh /tmp/bootstrap_salt.sh -XUdfP -x python3
  27 </code></pre>
  28 </notextile>
  29
  30 For more information check "Saltstack's documentation":https://docs.saltstack.com/en/latest/topics/installation/index.html
  31
  32 h2(#single_host). Single host install using the provision.sh script
  33
  34 This is a package-based installation method. The Salt scripts are available from the "tools/salt-install":https://github.com/arvados/arvados/tree/master/tools/salt-install directory in the Arvados git repository.
  35
  36 Use the @provision.sh@ script to deploy Arvados, which is implemented with the @arvados-formula@ in a Saltstack master-less setup:
  37
  38 * edit the variables at the very beginning of the file,
  39 * run the script as root
  40 * wait for it to finish
  41
  42 This will install all the main Arvados components to get you up and running. The whole installation procedure takes somewhere between 15 to 60 minutes, depending on the host and your network bandwidth. On a virtual machine with 1 core and 1 GB RAM, it takes ~25 minutes to do the initial install.
  43
  44 If everything goes OK, you'll get some final lines stating something like:
  45
  46 <notextile>
  47 <pre><code>arvados: Succeeded: 109 (changed=9)
  48 arvados: Failed:      0
  49 </code></pre>
  50 </notextile>
  51
  52 h2(#final_steps). DNS configuration
  53
  54 After the setup is done, you need to set up your DNS to be able to access the cluster.
  55
  56 The simplest way to do this is to edit your @/etc/hosts@ file (as root):
  57
  58 <notextile>
  59 <pre><code>export CLUSTER="arva2"
  60 export DOMAIN="arv.local"
  61 export HOST_IP="127.0.0.2"    # This is valid either if installing in your computer directly
  62                               # or in a Vagrant VM. If you're installing it on a remote host
  63                               # just change the IP to match that of the host.
  64 echo "${HOST_IP} api keep keep0 collections download ws workbench workbench2 ${CLUSTER}.${DOMAIN} api.${CLUSTER}.${DOMAIN} keep.${CLUSTER}.${DOMAIN} keep0.${CLUSTER}.${DOMAIN} collections.${CLUSTER}.${DOMAIN} download.${CLUSTER}.${DOMAIN} ws.${CLUSTER}.${DOMAIN} workbench.${CLUSTER}.${DOMAIN} workbench2.${CLUSTER}.${DOMAIN}" >> /etc/hosts
  65 </code></pre>
  66 </notextile>
  67
  68 h2(#initial_user). Initial user and login
  69
  70 At this point you should be able to log into the Arvados cluster.
  71
  72 If you changed nothing in the @provision.sh@ script, the initial URL will be:
  73
  74 * https://workbench.arva2.arv.local
  75
  76 or, in general, the url format will be:
  77
  78 * https://workbench.@<cluster>.<domain>@
  79
  80 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster.
  81
  82 Assuming you didn't change these values in the @provision.sh@ script, the initial credentials are:
  83
  84 * User: 'admin'
  85 * Password: 'password'
  86 * Email: 'admin@arva2.arv.local'
  87
  88 h2(#test_install). Test the installed cluster running a simple workflow
  89
  90 The @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@. If you want to run it, just change to that directory and run:
  91
  92 <notextile>
  93 <pre><code>cd /tmp/cluster_tests
  94 ./run-test.sh
  95 </code></pre>
  96 </notextile>
  97
  98 It will create a test user, upload a small workflow and run it. If everything goes OK, the output should similar to this (some output was shortened for clarity):
  99
 100 <notextile>
 101 <pre><code>Creating Arvados Standard Docker Images project
 102 Arvados project uuid is 'arva2-j7d0g-0prd8cjlk6kfl7y'
 103 {
 104  ...
 105  "uuid":"arva2-o0j2j-n4zu4cak5iifq2a",
 106  "owner_uuid":"arva2-tpzed-000000000000000",
 107  ...
 108 }
 109 Uploading arvados/jobs' docker image to the project
 110 2.1.1: Pulling from arvados/jobs
 111 8559a31e96f4: Pulling fs layer
 112 ...
 113 Status: Downloaded newer image for arvados/jobs:2.1.1
 114 docker.io/arvados/jobs:2.1.1
 115 2020-11-23 21:43:39 arvados.arv_put[32678] INFO: Creating new cache file at /home/vagrant/.cache/arvados/arv-put/c59256eda1829281424c80f588c7cc4d
 116 2020-11-23 21:43:46 arvados.arv_put[32678] INFO: Collection saved as 'Docker image arvados jobs:2.1.1 sha256:0dd50'
 117 arva2-4zz18-1u5pvbld7cvxuy2
 118 Creating initial user ('admin')
 119 Setting up user ('admin')
 120 {
 121  "items":[
 122   {
 123    ...
 124    "owner_uuid":"arva2-tpzed-000000000000000",
 125    ...
 126    "uuid":"arva2-o0j2j-1ownrdne0ok9iox"
 127   },
 128   {
 129    ...
 130    "owner_uuid":"arva2-tpzed-000000000000000",
 131    ...
 132    "uuid":"arva2-o0j2j-1zbeyhcwxc1tvb7"
 133   },
 134   {
 135    ...
 136    "email":"admin@arva2.arv.local",
 137    ...
 138    "owner_uuid":"arva2-tpzed-000000000000000",
 139    ...
 140    "username":"admin",
 141    "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
 142    ...
 143   }
 144  ],
 145  "kind":"arvados#HashList"
 146 }
 147 Activating user 'admin'
 148 {
 149  ...
 150  "email":"admin@arva2.arv.local",
 151  ...
 152  "username":"admin",
 153  "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
 154  ...
 155 }
 156 Running test CWL workflow
 157 INFO /usr/bin/cwl-runner 2.1.1, arvados-python-client 2.1.1, cwltool 3.0.20200807132242
 158 INFO Resolved 'hasher-workflow.cwl' to 'file:///tmp/cluster_tests/hasher-workflow.cwl'
 159 ...
 160 INFO Using cluster arva2 (https://arva2.arv.local:8443/)
 161 INFO Upload local files: "test.txt"
 162 INFO Uploaded to ea34d971b71d5536b4f6b7d6c69dc7f6+50 (arva2-4zz18-c8uvwqdry4r8jao)
 163 INFO Using collection cache size 256 MiB
 164 INFO [container hasher-workflow.cwl] submitted container_request arva2-xvhdp-v1bkywd58gyocwm
 165 INFO [container hasher-workflow.cwl] arva2-xvhdp-v1bkywd58gyocwm is Final
 166 INFO Overall process status is success
 167 INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
 168 {
 169     "hasher_out": {
 170         "basename": "hasher3.md5sum.txt",
 171         "class": "File",
 172         "location": "keep:d6c69a88147dde9d52a418d50ef788df+123/hasher3.md5sum.txt",
 173         "size": 95
 174     }
 175 }
 176 INFO Final process status is success
 177 </code></pre>
 178 </notextile>