7695: Docs reflect that docker_image can't be a collection UUID.
authorBrett Smith <brett@curoverse.com>
Thu, 29 Oct 2015 15:14:48 +0000 (11:14 -0400)
committerBrett Smith <brett@curoverse.com>
Thu, 29 Oct 2015 15:14:48 +0000 (11:14 -0400)
We intended to allow this, but it's not actually implemented.  Update
the docs for now.  We'll add the functionality in refs #7695.

doc/api/schema/Job.html.textile.liquid
doc/user/topics/arv-docker.html.textile.liquid

index fd635034b1e8db79b97a1893de07d07f87ed95ee..dba0fe94189034c239389801497cd213b5560919 100644 (file)
@@ -57,7 +57,7 @@ h3. Runtime constraints
 table(table table-bordered table-condensed).
 |_. Key|_. Type|_. Description|_. Implemented|
 |arvados_sdk_version|string|The Git version of the SDKs to use from the Arvados git repository.  See "Specifying Git versions":#script_version for more detail about acceptable ways to specify a commit.  If you use this, you must also specify a @docker_image@ constraint (see below).  In order to install the Python SDK successfully, Crunch must be able to find and run virtualenv inside the container.|&#10003;|
-|docker_image|string|The Docker image that this Job needs to run.  If specified, Crunch will create a Docker container from this image, and run the Job's script inside that.  The Keep mount and work directories will be available as volumes inside this container.  The image must be uploaded to Arvados using @arv keep docker@.  You may specify the image in any format that Docker accepts, such as @arvados/jobs@, @debian:latest@, or the Docker image id.  Alternatively, you may specify the UUID or portable data hash of the image Collection, returned by @arv keep docker@.|&#10003;|
+|docker_image|string|The Docker image that this Job needs to run.  If specified, Crunch will create a Docker container from this image, and run the Job's script inside that.  The Keep mount and work directories will be available as volumes inside this container.  The image must be uploaded to Arvados using @arv keep docker@.  You may specify the image in any format that Docker accepts, such as @arvados/jobs@, @debian:latest@, or the Docker image id.  Alternatively, you may specify the portable data hash of the image Collection.|&#10003;|
 |min_nodes|integer||&#10003;|
 |max_nodes|integer|||
 |min_cores_per_node|integer|Require that each node assigned to this Job have the specified number of CPU cores|&#10003;|
index e6c83affb5d9cb86fab64803027c9f8369c5e673..1a31d126da698495eca853b72e1dcca9424c94a1 100644 (file)
@@ -190,7 +190,7 @@ You are now able to specify the runtime environment for your program using the @
 {% 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.
+* The @docker_image@ field can be one of: the Docker repository name (as shown above), the Docker image hash, or the Arvados collection portable data hash.
 
 h2. Share Docker images