doc/user/topics/arv-docker.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Working with container images"
   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 This page describes how to set up the runtime environment (e.g., the programs, libraries, and other dependencies needed to run a job) that a workflow step will be run in using "Docker":https://www.docker.com/ or "Singularity":https://sylabs.io/singularity/.  Docker and Singularity are tools for building and running containers that isolate applications from other applications running on the same node.  For detailed information, see the "Docker User Guide":https://docs.docker.com/userguide/ and the "Introduction to Singularity":https://sylabs.io/guides/3.5/user-guide/introduction.html.
  13
  14 Note that Arvados always works with Docker images, even when it is configured to use Singularity to run containers. There are some differences between the two runtimes that can affect your containers. See the "Singularity container runtime":{{site.baseurl}}/install/singularity.html page for details.
  15
  16 This page describes:
  17
  18 # "Create a custom image using a Dockerfile":#create
  19 # "Uploading an image to Arvados":#upload
  20 # "Sources of pre-built bioinformatics Docker images":#sources
  21
  22 {% include 'tutorial_expectations_workstation' %}
  23
  24 You also need to ensure that "Docker is installed,":https://docs.docker.com/installation/ the Docker daemon is running, and you have permission to access Docker.  You can test this by running @docker version@.  If you receive a permission denied error, your user account may need to be added to the @docker@ group.  If you have root access, you can add yourself to the @docker@ group using @$ sudo addgroup $USER docker@ then log out and log back in again; otherwise consult your local sysadmin.
  25
  26 h2(#create). Create a custom image using a Dockerfile
  27
  28 This example shows how to create a Docker image and add the R package.
  29
  30 First, create new directory called @docker-example@, in that directory create a file called @Dockerfile@.
  31
  32 <notextile>
  33 <pre><code>$ <span class="userinput">mkdir docker-example-r-base</span>
  34 $ <span class="userinput">cd docker-example-r-base</span>
  35 </code></pre>
  36 </notextile>
  37
  38 <notextile>
  39 <pre><code>FROM ubuntu:bionic
  40 RUN apt-get update && apt-get -yq --no-install-recommends install r-base-core
  41 </code></pre>
  42 </notextile>
  43
  44 The "RUN" command is executed inside the container and can be any shell command line.  You are not limited to installing Debian packages.  You may compile programs or libraries from source and install them, edit systemwide configuration files, use other package managers such as @pip@ or @gem@, and perform any other customization necessary to run your program.
  45
  46 You can also visit the "Docker tutorial":https://docs.docker.com/get-started/part2/ for more information and examples.
  47
  48 You should add your Dockerfiles to the same source control repository as the Workflows that use them.
  49
  50 h3. Create a new image
  51
  52 We're now ready to create a new Docker image.  Use @docker build@ to create a new image from the Dockerfile.
  53
  54 <notextile>
  55 <pre><code>docker-example-r-base$ <span class="userinput">docker build -t docker-example-r-base .</span>
  56 </code></pre>
  57 </notextile>
  58
  59 h3. Verify image
  60
  61 Now we can verify that "R" is installed:
  62
  63 <notextile>
  64 <pre><code>$ <span class="userinput">docker run -ti docker-example-r-base</span>
  65 root@57ec8f8b2663:/# R
  66
  67 R version 3.4.4 (2018-03-15) -- "Someone to Lean On"
  68 Copyright (C) 2018 The R Foundation for Statistical Computing
  69 Platform: x86_64-pc-linux-gnu (64-bit)
  70 </code></pre>
  71 </notextile>
  72
  73 h2(#upload). Upload your image
  74
  75 Finally, we are ready to upload the new Docker image to Arvados.  Use @arv-keepdocker@ with the image repository name to upload the image.  Without arguments, @arv-keepdocker@ will print out the list of Docker images in Arvados that are available to you.
  76
  77 <notextile>
  78 <pre><code>$ <span class="userinput">arv-keepdocker docker-example-r-base</span>
  79 2020-06-29 13:48:19 arvados.arv_put[769] INFO: Creating new cache file at /home/peter/.cache/arvados/arv-put/39ddb51ebf6c5fcb3d713b5969466967
  80 206M / 206M 100.0% 2020-06-29 13:48:21 arvados.arv_put[769] INFO:
  81
  82 2020-06-29 13:48:21 arvados.arv_put[769] INFO: Collection saved as 'Docker image docker-example-r-base:latest sha256:edd10'
  83 zzzzz-4zz18-0tayximqcyb6uf8
  84
  85 $ <span class="userinput">arv-keepdocker images</span>
  86 REPOSITORY                      TAG         IMAGE ID      COLLECTION                     CREATED
  87 docker-example-r-base           latest      sha256:edd10  zzzzz-4zz18-0tayximqcyb6uf8    Mon Jun 29 17:46:16 2020
  88 </code></pre>
  89 </notextile>
  90
  91 You are now able to specify the runtime environment for your program using @DockerRequirement@ in your workflow:
  92
  93 <pre>
  94 hints:
  95   DockerRequirement:
  96     dockerPull: docker-example-r-base
  97 </pre>
  98
  99 h3. Uploading Docker images to a shared project
 100
 101 Docker images are subject to normal Arvados permissions.  If wish to share your Docker image with others you should use @arv-keepdocker@ with the @--project-uuid@ option to add the image to a shared project and ensure that metadata is set correctly.
 102
 103 <notextile>
 104 <pre><code>$ <span class="userinput">arv-keepdocker docker-example-r-base --project-uuid zzzzz-j7d0g-xxxxxxxxxxxxxxx</span>
 105 </code></pre>
 106 </notextile>
 107
 108 h2(#sources). Sources of pre-built images
 109
 110 In addition to creating your own contianers, there are a number of resources where you can find bioinformatics tools already wrapped in container images:
 111
 112 "BioContainers":https://biocontainers.pro/
 113
 114 "Dockstore":https://dockstore.org/
 115
 116 "Docker Hub":https://hub.docker.com/