Merge branch 'master' into 5493-getting-started-modal
[arvados.git] / docker / arvdock
1 #!/bin/bash
2
3 DOCKER=`which docker.io`
4
5 if [[ "$DOCKER" == "" ]]; then
6     DOCKER=`which docker`
7 fi
8
9 CURL=`which curl`
10
11 COMPUTE_COUNTER=0
12
13 function usage {
14     echo >&2
15     echo >&2 "usage: $0 (start|stop|restart|reset|test) [options]"
16     echo >&2
17     echo >&2 "start    run new or restart stopped arvados containers"
18     echo >&2 "stop     stop arvados containers"
19     echo >&2 "restart  stop and then start arvados containers"
20     echo >&2 "reset    stop and delete containers WARNING: this will delete the data inside Arvados!"
21     echo >&2 "test     run tests"
22     echo >&2
23     echo >&2 "$0 options:"
24     echo >&2 "  -d[port], --doc[=port]        Documentation server (default port 9898)"
25     echo >&2 "  -w[port], --workbench[=port]  Workbench server (default port 9899)"
26     echo >&2 "  -s[port], --sso[=port]        SSO server (default port 9901)"
27     echo >&2 "  -a[port], --api[=port]        API server (default port 9900)"
28     echo >&2 "  -c, --compute                 Compute nodes (starts 2)"
29     echo >&2 "  -v, --vm                      Shell server"
30     echo >&2 "  -n, --nameserver              Nameserver"
31     echo >&2 "  -k, --keep                    Keep servers"
32     echo >&2 "  -p, --keepproxy               Keepproxy server"
33     echo >&2 "  -h, --help                    Display this help and exit"
34     echo >&2
35     echo >&2 "  If no options are given, the action is applied to all servers."
36     echo >&2
37     echo >&2 "$0 test [testname] [testname] ..."
38     echo >&2 "  By default, all tests are run."
39 }
40
41 function ip_address {
42     local container=$1
43     echo `$DOCKER inspect $container  |grep IPAddress |cut -f4 -d\"`
44 }
45
46 function start_container {
47     local args="-d -i -t"
48     if [[ "$1" != '' ]]; then
49       local port="$1"
50       args="$args -p $port"
51     fi
52     if [[ "$2" != '' ]]; then
53       local name="$2"
54       if [[ "$name" == "api_server" ]]; then
55         args="$args --dns=172.17.42.1 --dns-search=compute.dev.arvados --hostname api -P --name $name"
56       elif [[ "$name" == "compute" ]]; then
57         name=$name$COMPUTE_COUNTER
58         # We need --privileged because we run docker-inside-docker on the compute nodes
59         args="$args --dns=172.17.42.1 --dns-search=compute.dev.arvados --hostname compute$COMPUTE_COUNTER -P --privileged --name $name"
60         let COMPUTE_COUNTER=$(($COMPUTE_COUNTER + 1))
61       else
62         args="$args --dns=172.17.42.1 --dns-search=dev.arvados --hostname ${name#_server} --name $name"
63       fi
64     fi
65     if [[ "$3" != '' ]]; then
66       local volume="$3"
67       args="$args --volumes-from $volume"
68     fi
69     if [[ "$4" != '' ]]; then
70       local link="$4"
71       args="$args --link $link"
72     fi
73     local image=$5
74
75     `$DOCKER ps |grep -P "$name[^/]" -q`
76     if [[ "$?" == "0" ]]; then
77       echo "You have a running container with name $name -- skipping."
78       return
79     fi
80
81     echo "Starting container: $name"
82     `$DOCKER ps --all |grep -P "$name[^/]" -q`
83     if [[ "$?" == "0" ]]; then
84         echo "  $DOCKER start $name"
85         container=`$DOCKER start $name`
86     else
87         echo "  $DOCKER run $args $image"
88         container=`$DOCKER run $args $image`
89     fi
90
91     if [ "$?" != "0" -o "$container" = "" ]; then
92       echo "Unable to start container"
93       exit 1
94     else
95       echo "Started container: $container"
96     fi
97
98 }
99
100 # Create a Docker data volume
101 function make_keep_volumes () {
102     `$DOCKER ps --all |grep -P "keep_data[^/]" -q`
103     if [[ "$?" == "0" ]]; then
104       return
105     fi
106     docker create -v /keep-data --name keep_data arvados/keep
107 }
108
109 function do_start {
110     local start_doc=false
111     local start_sso=false
112     local start_api=false
113     local start_compute=false
114     local start_workbench=false
115     local start_vm=false
116     local start_nameserver=false
117     local start_keep=false
118     local start_keepproxy=false
119     local
120
121     # NOTE: This requires GNU getopt (part of the util-linux package on Debian-based distros).
122     local TEMP=`getopt -o d::s::a::cw::nkpvh \
123                   --long doc::,sso::,api::,compute,workbench::,nameserver,keep,keepproxy,vm,help \
124                   -n "$0" -- "$@"`
125
126     if [ $? != 0 ] ; then echo "Use -h for help"; exit 1 ; fi
127
128     # Note the quotes around `$TEMP': they are essential!
129     eval set -- "$TEMP"
130
131     while [ $# -ge 1 ]
132     do
133         case $1 in
134             -d | --doc)
135                 case "$2" in
136                     "") start_doc=9898; shift 2 ;;
137                     *)  start_doc=$2; shift 2 ;;
138                 esac
139                 ;;
140             -s | --sso)
141                 case "$2" in
142                     "") start_sso=9901; shift 2 ;;
143                     *)  start_sso=$2; shift 2 ;;
144                 esac
145                 ;;
146             -a | --api)
147                 case "$2" in
148                     "") start_api=9900; shift 2 ;;
149                     *)  start_api=$2; shift 2 ;;
150                 esac
151                 ;;
152             -c | --compute)
153                 start_compute=2
154                 shift
155                 ;;
156             -w | --workbench)
157                 case "$2" in
158                     "") start_workbench=9899; shift 2 ;;
159                     *)  start_workbench=$2; shift 2 ;;
160                 esac
161                 ;;
162             -v | --vm)
163                 start_vm=true
164                 shift
165                 ;;
166             -n | --nameserver)
167                 start_nameserver=true
168                 shift
169                 ;;
170             -k | --keep)
171                 start_keep=true
172                 shift
173                 ;;
174             -p | --keepproxy)
175                 start_keepproxy=true
176                 shift
177                 ;;
178             --)
179                 shift
180                 break
181                 ;;
182             *)
183                 usage
184                 exit 1
185                 ;;
186         esac
187     done
188
189     # If no options were selected, then start all servers.
190     if [[ $start_doc == false &&
191           $start_sso == false &&
192           $start_api == false &&
193           $start_compute == false &&
194           $start_workbench == false &&
195           $start_vm == false &&
196           $start_nameserver == false &&
197           $start_keep == false &&
198           $start_keepproxy == false ]]
199     then
200         start_doc=9898
201         #the sso server is currently not used by default so don't start it unless explicitly requested
202         #start_sso=9901
203         start_api=9900
204         start_compute=2
205         start_workbench=9899
206         start_vm=true
207         start_nameserver=true
208         start_keep=true
209         start_keepproxy=true
210     fi
211
212     if [[ $start_nameserver != false ]]
213     then
214       # We rely on skydock and skydns for dns discovery between the slurm controller and compute nodes,
215       # so make sure they are running
216       $DOCKER ps | grep skydns >/dev/null
217       if [[ "$?" != "0" ]]; then
218         echo "Starting crosbymichael/skydns container..."
219         $DOCKER rm "skydns" 2>/dev/null
220         echo $DOCKER run -d -p 172.17.42.1:53:53/udp --name skydns crosbymichael/skydns -nameserver 8.8.8.8:53 -domain arvados
221         $DOCKER run -d -p 172.17.42.1:53:53/udp --name skydns crosbymichael/skydns -nameserver 8.8.8.8:53 -domain arvados
222       fi
223       $DOCKER ps | grep skydock >/dev/null
224       if [[ "$?" != "0" ]]; then
225         echo "Starting crosbymichael/skydock container..."
226         $DOCKER rm "skydock" 2>/dev/null
227         echo $DOCKER run -d -v /var/run/docker.sock:/docker.sock --name skydock crosbymichael/skydock -ttl 30 -environment dev -s /docker.sock -domain arvados -name skydns
228         $DOCKER run -d -v /var/run/docker.sock:/docker.sock --name skydock crosbymichael/skydock -ttl 30 -environment dev -s /docker.sock -domain arvados -name skydns
229       fi
230     fi
231
232     if [[ $start_sso != false ]]
233     then
234         start_container "$start_sso:443" "sso_server" '' '' "arvados/sso"
235     fi
236
237     if [[ $start_api != false ]]
238     then
239       if [[ $start_sso != false ]]; then
240         start_container "$start_api:443" "api_server" '' "sso_server:sso" "arvados/api"
241       else
242         start_container "$start_api:443" "api_server" '' '' "arvados/api"
243       fi
244     fi
245
246     if [[ $start_compute != false ]]
247     then
248         for i in `seq 0 $(($start_compute - 1))`; do
249           start_container "" "compute" '' "api_server:api" "arvados/compute"
250         done
251     fi
252
253     if [[ $start_keep != false ]]
254     then
255         # create `keep_volumes' array with a list of keep mount points
256         # remove any stale metadata from those volumes before starting them
257         make_keep_volumes
258         start_container "25107:25107" "keep_server_0" \
259             "keep_data" \
260             "api_server:api" \
261             "arvados/keep"
262         start_container "25108:25107" "keep_server_1" \
263             "keep_data" \
264             "api_server:api" \
265             "arvados/keep"
266     fi
267
268     if [[ $start_keepproxy != false ]]
269     then
270         start_container "9902:9100" "keepproxy_server" '' \
271             "api_server:api" \
272             "arvados/keepproxy"
273     fi
274
275     if [[ $start_doc != false ]]
276     then
277         start_container "$start_doc:80" "doc_server" '' '' "arvados/doc"
278     fi
279
280     if [[ $start_vm != false ]]
281     then
282         start_container "" "shell" '' "api_server:api" "arvados/shell"
283     fi
284
285     if [[ $start_workbench != false ]]
286     then
287         start_container "$start_workbench:80" "workbench_server" '' "api_server:api" "arvados/workbench"
288     fi
289
290     if [[ $start_api != false ]]
291     then
292         if [[ -f "api/generated/superuser_token" ]]
293         then
294           if [ -d $HOME/.config/arvados ] || mkdir -p $HOME/.config/arvados
295           then
296             cat >$HOME/.config/arvados/settings.conf <<EOF
297 ARVADOS_API_HOST=$(ip_address "api_server")
298 ARVADOS_API_HOST_INSECURE=yes
299 ARVADOS_API_TOKEN=$(cat api/generated/superuser_token)
300 EOF
301           fi
302         fi
303     fi
304
305     if [ "$(awk '($1 == "nameserver"){print $2; exit}' </etc/resolv.conf)" != "172.17.42.1" ]; then
306         echo
307         echo "******************************************************************"
308         echo "To access Arvados you must add the Arvados nameserver to the top"
309         echo "of your DNS configuration in /etc/resolv.conf:"
310         echo "nameserver 172.17.42.1"
311         echo
312         echo "Then run '$0 start' again"
313         echo "******************************************************************"
314         echo
315     else
316         while ! $CURL -L -f http://workbench.dev.arvados >/dev/null 2>/dev/null ; do
317             echo "Waiting for Arvados to be ready."
318             sleep 1
319         done
320
321         `$DOCKER ps |grep -P "doc_server[^/]" -q`
322         if [[ "$?" == "0" ]]; then
323             echo
324             echo "******************************************************************"
325             echo "You can access the Arvados documentation at http://doc.dev.arvados"
326             echo "******************************************************************"
327             echo
328         fi
329
330         `$DOCKER ps |grep -P "workbench_server[^/]" -q`
331         if [[ "$?" == "0" ]]; then
332             echo
333             echo "********************************************************************"
334             echo "You can access the Arvados workbench at http://workbench.dev.arvados"
335             echo "********************************************************************"
336             echo
337         fi
338     fi
339
340 }
341
342 function do_stop {
343     local stop_doc=""
344     local stop_sso=""
345     local stop_api=""
346     local stop_compute=""
347     local stop_workbench=""
348     local stop_nameserver=""
349     local stop_vm=""
350     local stop_keep=""
351     local stop_keepproxy=""
352
353     # NOTE: This requires GNU getopt (part of the util-linux package on Debian-based distros).
354     local TEMP=`getopt -o dsacwnkpvh \
355                   --long doc,sso,api,compute,workbench,nameserver,keep,keepproxy,vm,help \
356                   -n "$0" -- "$@"`
357
358     if [ $? != 0 ] ; then echo "Use -h for help"; exit 1 ; fi
359
360     # Note the quotes around `$TEMP': they are essential!
361     eval set -- "$TEMP"
362
363     while [ $# -ge 1 ]
364     do
365         case $1 in
366             -d | --doc)
367                 stop_doc=doc_server ; shift ;;
368             -s | --sso)
369                 stop_sso=sso_server ; shift ;;
370             -a | --api)
371                 stop_api=api_server ; shift ;;
372             -c | --compute)
373                 stop_compute=`$DOCKER ps |grep -P "compute\d+" |grep -v api_server |cut -f1 -d ' '` ; shift ;;
374             -w | --workbench)
375                 stop_workbench=workbench_server ; shift ;;
376             -n | --nameserver )
377                 stop_nameserver="skydock skydns" ; shift ;;
378             -v | --vm )
379                 stop_vm="shell" ; shift ;;
380             -k | --keep )
381                 stop_keep="keep_server_0 keep_server_1" ; shift ;;
382             -p | --keepproxy )
383                 stop_keep="keepproxy_server" ; shift ;;
384             --)
385                 shift
386                 break
387                 ;;
388             *)
389                 usage
390                 exit 1
391                 ;;
392         esac
393     done
394
395     # If no options were selected, then stop all servers.
396     if [[ $stop_doc == "" &&
397           $stop_sso == "" &&
398           $stop_api == "" &&
399           $stop_compute == "" &&
400           $stop_workbench == "" &&
401           $stop_vm == "" &&
402           $stop_nameserver == "" &&
403           $stop_keep == "" &&
404           $stop_keepproxy == "" ]]
405     then
406         stop_doc=doc_server
407         stop_sso=sso_server
408         stop_api=api_server
409         stop_compute=`$DOCKER ps |grep -P "compute\d+" |grep -v api_server |cut -f1 -d ' '`
410         stop_workbench=workbench_server
411         stop_vm=shell
412         stop_nameserver="skydock skydns"
413         stop_keep="keep_server_0 keep_server_1"
414         stop_keepproxy="keepproxy_server"
415     fi
416
417     $DOCKER stop $stop_doc $stop_sso $stop_api $stop_compute $stop_workbench $stop_nameserver $stop_keep $stop_keepproxy $stop_vm \
418         2>/dev/null
419 }
420
421 function do_test {
422     local alltests
423     if [ $# -lt 1 ]
424     then
425         alltests="python-sdk api"
426     else
427         alltests="$@"
428     fi
429
430     for testname in $alltests
431     do
432         echo "testing $testname..."
433         case $testname in
434             python-sdk)
435                 do_start --api --keep --sso
436                 export ARVADOS_API_HOST=$(ip_address "api_server")
437                 export ARVADOS_API_HOST_INSECURE=yes
438                 export ARVADOS_API_TOKEN=$(cat api/generated/superuser_token)
439                 python -m unittest discover ../sdk/python
440                 ;;
441             api)
442                 $DOCKER run -t -i arvados/api \
443                     /usr/src/arvados/services/api/script/rake_test.sh
444                 ;;
445             *)
446                 echo >&2 "unknown test $testname"
447                 ;;
448         esac
449     done
450 }
451
452 function do_reset {
453     for name in skydock skydns workbench_server shell doc_server keepproxy_server keep_server_0 keep_server_1 compute0 compute1 api_server keepproxy keep_data
454     do
455         `$DOCKER ps |grep -P "$name[^/]" -q`
456         if [[ "$?" == "0" ]]; then
457             echo "  $DOCKER stop $name"
458             $DOCKER stop $name
459         fi
460         `$DOCKER ps --all |grep -P "$name[^/]" -q`
461         if [[ "$?" == "0" ]]; then
462             echo "  $DOCKER rm $name"
463             $DOCKER rm $name
464         fi
465     done
466 }
467
468 if [ "$DOCKER" == '' ]
469 then
470   echo "Docker not found. Please install it first."
471   exit 2
472 fi
473
474 if [ "$CURL" == '' ]
475 then
476   echo "Curl not found. Please install it first."
477   exit 3
478 fi
479
480 if [ $# -lt 1 ]
481 then
482   usage
483   exit 1
484 fi
485
486 case $1 in
487     start)
488         shift
489         do_start $@
490         ;;
491     stop)
492         shift
493         do_stop $@
494         ;;
495     restart)
496         shift
497         do_stop $@
498         do_start $@
499         ;;
500     test)
501         shift
502         do_test $@
503         ;;
504     reset)
505         shift
506         do_reset $@
507         ;;
508     *)
509         usage
510         exit 1
511         ;;
512 esac