Skip to content

Commit

Permalink
Add troubleshooting note to docker directory readme file (#814)
Browse files Browse the repository at this point in the history
* Add troubleshooting/standalone run instructions to docker directory readme file
  • Loading branch information
timaeusx authored Sep 6, 2022
1 parent e46294a commit d228be3
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions dockers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This style guide provides formatting guidelines and best practices for writing D
* [Proper process reaping](#process)
* [Build Scripts and README](#build)
* [Formatting](#formatting)
* [Troubleshooting](#trouble)
* [Troubleshooting and running standalone](#trouble)
## <a name="overview"></a> Overview

WARP maintains a collection of docker images which are used as execution environments for various cloud-optimized data processing pipelines. Many of these image require specific sets of tools and dependencies to run and can be thought of as _custom_ images rather than traditional application images.
Expand Down Expand Up @@ -234,6 +234,12 @@ RUN set -eux; \
ENTRYPOINT [ "/sbin/tini", "--" ]
```

## <a link="trouble"></a> Troubleshooting
## <a link="trouble"></a> Troubleshooting and running standalone

The WARP dockers are designed to be run from their respective WDL pipelines. However, if you need to run a Docker independent of a WDL for testing or troubleshooting, you'll likely need to explicity instruct it to run a `bash` shell in the `run` command. An example of this is shown in the terminal command below:

```bash
docker run -it --rm <docker url> bash
```

If you have any questions or would like some more guidance on writing Dockerfiles please file a [GitHub issue in WARP](https://github.com/broadinstitute/warp/issues/new).

0 comments on commit d228be3

Please sign in to comment.