10467: Merge branch 'master' into 10467-client-disconnect
[arvados.git] / doc / user / topics / arv-docker.html.textile.liquid
index 5e75661faa0b9e1e9e0c876e8d9c88b287c83b51..5ccd5ac476bdc8e3cda0cb4891869ee68e6cf2d8 100644 (file)
@@ -11,12 +11,12 @@ This page will demonstrate how to:
 # Fetch the arvados/jobs Docker image
 # Manually install additional software into the container
 # Create a new custom image
-# Upload that image to Arvados for use by Crunch jobs.
+# Upload that image to Arvados for use by Crunch jobs
 # Share your image with others
 
-{% include 'tutorial_expectations' %}
+{% include 'tutorial_expectations_workstation' %}
 
-*You also need ensure that "Docker is installed":https://docs.docker.com/installation/ and the Docker daemon is running.  You can test this by running @docker version@.*
+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. Fetch a starting image
 
@@ -25,7 +25,7 @@ The easiest way to begin is to start from the "arvados/jobs" image which already
 Download the latest "arvados/jobs" image from the Docker registry:
 
 <notextile>
-<pre><code>$ <span class="userinput">docker pull arvados/jobs</span>
+<pre><code>$ <span class="userinput">docker pull arvados/jobs:latest</span>
 Pulling repository arvados/jobs
 3132168f2acb: Download complete
 a42b7f2c59b6: Download complete
@@ -47,7 +47,7 @@ c7fd77eedb96: Download complete
 
 h2. Install new packages
 
-Next, enter the container using "docker run", the arvados/jobs image, and the program you want to run (in this case the bash shell).
+Next, enter the container using @docker run@, providing the arvados/jobs image and the program you want to run (in this case the bash shell).
 
 <notextile>
 <pre><code>$ <span class="userinput">docker run --interactive --tty --user root arvados/jobs /bin/bash</span>
@@ -152,7 +152,7 @@ Type 'q()' to quit R.
 </code></pre>
 </notextile>
 
-Note that 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.
+Note that 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.
 
 h2. Create a new image
 
@@ -184,19 +184,19 @@ arvados/jobs-with-r             latest      33ea6b877923  qr1hi-4zz18-3fk2px2ji2
 </code></pre>
 </notextile>
 
-You are now able to specify the runtime environment for your program using the @docker_image@ field of the @runtime_constaints@ section of your pipeline components:
+You are now able to specify the runtime environment for your program using @DockerRequirement@ in your workflow:
 
-<notextile>
-{% code 'example_docker' as javascript %}
-</notextile>
-
-* The @docker_image@ field can be one of: the Docker repository name (as shown above), the Docker image hash, the Arvados collection uuid, or the Arvados collection portable data hash.
+<pre>
+hints:
+  DockerRequirement:
+    dockerPull: arvados/jobs-with-r
+</pre>
 
 h2. Share Docker images
 
 Docker images are subject to normal Arvados permissions.  If wish to share your Docker image with others (or wish to share a pipeline template that uses your Docker image) you will need to use @arv keep docker@ with the @--project-uuid@ option to upload the image to a shared project.
 
 <notextile>
-<pre><code>$ <span class="userinput">arv keep docker --project-uuid zzzzz-j7d0g-u7zg1qdaowykd8d arvados/jobs-with-r</span>
+<pre><code>$ <span class="userinput">arv keep docker --project-uuid qr1hi-j7d0g-xxxxxxxxxxxxxxx arvados/jobs-with-r</span>
 </code></pre>
 </notextile>