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