update docs
[arvados.git] / doc / install / install-crunch-dispatch.textile
1 ---
2 layout: default
3 navsection: installguide
4 title: Install the Crunch dispatcher
5 navorder: 3
6 ---
7
8 h1. Crunch setup
9
10 h4. Perl SDK dependencies
11
12 * @apt-get install libjson-perl libwww-perl libio-socket-ssl-perl libipc-system-simple-perl@
13
14 h4. Python SDK dependencies
15
16 On controller and all compute nodes:
17
18 * @apt-get install python-pip@
19 * @pip install --upgrade google-api-python-client@
20
21 h4. Repositories
22
23 Crunch scripts must be in git repositories in @/var/cache/git/*/.git@ (or whatever is configured in @services/api/config/environments/production.rb@).
24
25 h4. Importing commits
26
27 @services/api/script/import_commits.rb production@ must run periodically. Example @/var/service/arvados_import_commits/run@ script for daemontools or runit:
28
29 <pre>
30 #!/bin/sh
31 set -e
32 while sleep 60
33 do
34   cd /path/to/arvados/services/api
35   setuidgid www-data env RAILS_ENV=production /usr/local/rvm/bin/rvm 2.0.0 do bundle exec ./script/import_commits.rb 2>&1
36 done
37 </pre>
38
39 Once you have imported some commits, you should be able to create a new job:
40
41 <pre>
42 read -rd "\000" newjob <<EOF; arv job create --job "$newjob"
43 {"script_parameters":{"input":"f815ec01d5d2f11cb12874ab2ed50daa"},
44  "script_version":"master",
45  "script":"hash"}
46 EOF
47 </pre>
48
49 Without getting this error:
50
51 <pre>
52 ArgumentError: Specified script_version does not resolve to a commit
53 </pre>
54
55 h4. Running jobs
56
57 * @services/api/script/crunch-dispatch.rb@ must be running.
58 * @crunch-dispatch.rb@ needs @services/crunch/crunch-job@ in its @PATH@.
59 * @crunch-job@ needs @sdk/perl/lib@ and @warehouse-apps/libwarehouse-perl/lib@ in its @PERLLIB@
60 * @crunch-job@ needs @ARVADOS_API_HOST@ (and, if necessary in a development environment, @ARVADOS_API_HOST_INSECURE@)
61
62 Example @/var/service/arvados_crunch_dispatch/run@ script:
63
64 <pre>
65 #!/bin/sh
66 set -e
67 export PATH="$PATH":/path/to/arvados/services/crunch
68 export PERLLIB=/path/to/arvados/sdk/perl/lib:/path/to/warehouse-apps/libwarehouse-perl/lib
69 export ARVADOS_API_HOST=xyzzy.arvadosapi.com
70
71 ## Only if your SSL cert is unverifiable:
72 # export ARVADOS_API_HOST_INSECURE=yes
73
74 cd /path/to/arvados/services/api
75 RAILS_ENV=production /usr/local/rvm/bin/rvm 2.0.0 do bundle exec ./script/crunch-dispatch.rb 2>&1
76 </pre>