X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/635ea4273130253cba3e00f4b0dca7d7734a741d..a795a8801fecdcbe5418c5d631b5b1ba1b22f1d7:/doc/user/topics/arv-docker.html.textile.liquid diff --git a/doc/user/topics/arv-docker.html.textile.liquid b/doc/user/topics/arv-docker.html.textile.liquid index d371400f5c..bb1c7dd53e 100644 --- a/doc/user/topics/arv-docker.html.textile.liquid +++ b/doc/user/topics/arv-docker.html.textile.liquid @@ -11,32 +11,30 @@ SPDX-License-Identifier: CC-BY-SA-3.0 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/ Docker is a tool for building and running containers that isolate applications from other applications running on the same node. For detailed information about Docker, see the "Docker User Guide.":https://docs.docker.com/userguide/ -This page will describe: +This page describes: -# Create a custom image using a Dockerfile -# Uploading an image to Arvados -# Sources of pre-built bioinformatics Docker images +# "Create a custom image using a Dockerfile":#create +# "Uploading an image to Arvados":#upload +# "Sources of pre-built bioinformatics Docker images":#sources {% include 'tutorial_expectations_workstation' %} You also need 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. -h2. Create a custom image using a Dockerfile +h2(#create). Create a custom image using a Dockerfile This example shows how to create a Docker image and add the R package. First, create new directory called @docker-example@, in that directory create a file called @Dockerfile@. -

-$ mkdir docker-example-r-base
-$ cd docker-example-r-base
+
$ mkdir docker-example-r-base
+$ cd docker-example-r-base
 
-

-FROM ubuntu:bionic
+
FROM ubuntu:bionic
 RUN apt-get update && apt-get -yq --no-install-recommends install r-base-core
 
@@ -52,8 +50,7 @@ h3. Create a new image We're now ready to create a new Docker image. Use @docker build@ to create a new image from the Dockerfile. -

-docker-example-r-base$ docker build -t docker-example-r-base .
+
docker-example-r-base$ docker build -t docker-example-r-base .
 
@@ -62,17 +59,16 @@ h3. Verify image Now we can verify that "R" is installed: -
$ docker run -ti docker-example-r-base
+
$ docker run -ti docker-example-r-base
 root@57ec8f8b2663:/# R
 
 R version 3.4.4 (2018-03-15) -- "Someone to Lean On"
 Copyright (C) 2018 The R Foundation for Statistical Computing
 Platform: x86_64-pc-linux-gnu (64-bit)
-
 
-h2. Upload your image +h2(#upload). Upload your image 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. @@ -82,11 +78,11 @@ Finally, we are ready to upload the new Docker image to Arvados. Use @arv-keepd 206M / 206M 100.0% 2020-06-29 13:48:21 arvados.arv_put[769] INFO: 2020-06-29 13:48:21 arvados.arv_put[769] INFO: Collection saved as 'Docker image docker-example-r-base:latest sha256:edd10' -x20vs-4zz18-0tayximqcyb6uf8 +zzzzz-4zz18-0tayximqcyb6uf8 $ arv-keepdocker images REPOSITORY TAG IMAGE ID COLLECTION CREATED -docker-example-r-base latest sha256:edd10 x20vs-4zz18-0tayximqcyb6uf8 Mon Jun 29 17:46:16 2020 +docker-example-r-base latest sha256:edd10 zzzzz-4zz18-0tayximqcyb6uf8 Mon Jun 29 17:46:16 2020
@@ -103,11 +99,11 @@ h3. Uploading Docker images to a shared project 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. -
$ arv-keepdocker docker-example-r-base --project-uuid qr1hi-j7d0g-xxxxxxxxxxxxxxx
+
$ arv-keepdocker docker-example-r-base --project-uuid zzzzz-j7d0g-xxxxxxxxxxxxxxx
 
-h2. Sources of pre-built images +h2(#sources). Sources of pre-built images In addition to creating your own contianers, there are a number of resources where you can find bioinformatics tools already wrapped in container images: