Skip to content

Commit ce14487

Browse files
authored
Merge pull request #572 from common-workflow-language/udocker
[WIP] add udocker example
2 parents 028c883 + 435ec22 commit ce14487

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,20 +113,31 @@ and ``--tmp-outdir-prefix`` to somewhere under ``/Users``::
113113
.. |Build Status| image:: https://ci.commonwl.org/buildStatus/icon?job=cwltool-conformance
114114
:target: https://ci.commonwl.org/job/cwltool-conformance/
115115

116-
Running user-space implementations of Docker
117-
--------------------------------------------
116+
Using user-space replacements for Docker
117+
----------------------------------------
118118

119-
Some compute environments disallow user-space installation of Docker due to incompatiblities in libraries or to meet security requirements. The CWL reference supports using a user space implementation with the `--user-space-docker-cmd` option.
119+
Some shared computing environments don't support Docker software containers for technical or policy reasons.
120+
As a work around, the CWL reference runner supports using a alternative ``docker`` implementations on Linux
121+
with the ``--user-space-docker-cmd`` option.
120122

121-
Example using `dx-docker` (https://wiki.dnanexus.com/Developer-Tutorials/Using-Docker-Images):
123+
One such "user space" friendly docker replacement is ``udocker`` https://github.com/indigo-dc/udocker and another
124+
is ``dx-docker`` https://wiki.dnanexus.com/Developer-Tutorials/Using-Docker-Images
122125

123-
For use on Linux, install the DNAnexus toolkit (see https://wiki.dnanexus.com/Downloads for instructions).
126+
udocker installation: https://github.com/indigo-dc/udocker/blob/master/doc/installation_manual.md#22-install-from-indigo-datacloud-repositories
127+
128+
dx-docker installation: start with the DNAnexus toolkit (see https://wiki.dnanexus.com/Downloads for instructions).
124129

125130
Run `cwltool` just as you normally would, but with the new option, e.g. from the conformance tests:
126131

127132
.. code:: bash
128133
129-
cwltool --user-space-docker-cmd=dx-docker --outdir=/tmp/tmpidytmp v1.0/test-cwl-out2.cwl v1.0/empty.json
134+
cwltool --user-space-docker-cmd=udocker https://raw.githubusercontent.com/common-workflow-language/common-workflow-language/master/v1.0/v1.0/test-cwl-out2.cwl https://github.com/common-workflow-language/common-workflow-language/blob/master/v1.0/v1.0/empty.json
135+
136+
or
137+
138+
.. code:: bash
139+
140+
cwltool --user-space-docker-cmd=dx-docker https://raw.githubusercontent.com/common-workflow-language/common-workflow-language/master/v1.0/v1.0/test-cwl-out2.cwl https://github.com/common-workflow-language/common-workflow-language/blob/master/v1.0/v1.0/empty.json
130141
131142
Tool or workflow loading from remote or local locations
132143
-------------------------------------------------------

0 commit comments

Comments
 (0)