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