Skip to content

Commit

Permalink
Add paramiko as dependency to allow DOCKER_HOST usage
Browse files Browse the repository at this point in the history
Allow running workflows on remote docker hosts by adding paramiko as a
dependency. Updates the documentation as well.
  • Loading branch information
ivotron committed Jun 27, 2020
1 parent 43493cb commit 6a93f7c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/sections/cn_workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,25 @@ engine-specific configuration options via the `--conf` flag.
### Docker

Docker is the default engine used by the `popper run`. All the
container configuration for the docker engine is supported by Popper.
container configuration for the docker engine is supported by Popper.
Popper also supports running workflows on remote docker daemons by use
of the `DOCKER_HOST`, `DOCKER_TLS_VERIFY` and `DOCKER_CERT_PATH`
variables, as explained in [the official
documentation][docker-remote]. For example:

```bash
export DOCKER_HOST="ssh://myuser@hostname"
popper run -f wf.yml
```

The above runs the workflow on the `hostname` machine instead of
locally. It assumes the following:

1. `myuser` has passwordless access to `hostname`, otherwise the
password to the machine is requested.
2. The `myuser` account can run `docker` on the remote machine.

[docker-remote]: https://docs.docker.com/engine/reference/commandline/dockerd

### Singularity

Expand Down
1 change: 1 addition & 0 deletions src/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"docker==4.2.0",
"dockerpty==0.4.1",
"GitPython==3.1.0",
"paramiko==2.7.1",
"pykwalify==1.7.0",
"python-box==4.2.3",
"pyyaml==5.3.1",
Expand Down

0 comments on commit 6a93f7c

Please sign in to comment.