Skip to content

Commit e33f86a

Browse files
committed
docker guide cleanup
1 parent 6f984e4 commit e33f86a

File tree

3 files changed

+28
-23
lines changed

3 files changed

+28
-23
lines changed

_uw-research-computing/docker-build.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,15 @@ guide:
77
- htc
88
---
99

10-
Linux containers are a way to build a self-contained environment that
11-
includes software, libraries, and other tools. CHTC currently supports
12-
running jobs inside [Docker](https://www.docker.com/what-docker)
13-
containers. This guide describes how to build a Docker image
10+
This guide describes how to build a Docker image
1411
that you can use for running jobs in CHTC or sharing a common
1512
software environment with collaborators. For information on using
1613
a Docker container image in jobs, see our [Docker Jobs guide](docker-jobs.html).
1714

1815
{% capture content %}
1916
- [Overview](#overview)
20-
- [Step by Step]()
21-
- [Examples]()
17+
- [Step by Step Build Instructions](#step-by-step-build-instructions)
18+
- [Examples]($examples)
2219
- [Related pages](#related-pages)
2320
{% endcapture %}
2421
{% include /components/directory.html title="Table of Contents" %}

_uw-research-computing/docker-jobs.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ submit jobs that use Docker containers.
1515

1616
{% capture content %}
1717
- [Start Here](#start-here)
18+
- [Use a Docker Container in a Job](#use-a-docker-container-in-a-job)
19+
- [Tips for HTCondor integration](#tips-for-htcondor-integration)
20+
- [Find an existing Docker container image](#find-an-existing-docker-container-image)
21+
- [Build your own Docker container image](#build-your-own-docker-container-image)
22+
- [Testing Docker containers](#testing-docker-containers)
1823
- [Related pages](#related-pages)
1924
{% endcapture %}
2025
{% include /components/directory.html title="Table of Contents" %}
@@ -31,8 +36,8 @@ inside, go straight to [Use a Docker Container in a Job](#use-a-docker-container
3136
and [Tips for HTCondor integration](#tips-for-HTCondor-integration)
3237

3338
If you do not have an existing Docker container you can:
34-
* Find one: [Find an existing Docker container image](#find-an-existing-docker-container-image)
35-
* Create one: [Create a Docker Container Image](#create-a-docker-container-image).
39+
* **Find one:** [Find an existing Docker container image](#find-an-existing-docker-container-image)
40+
* **Create one:** [Create a Docker Container Image](#create-a-docker-container-image).
3641
Once you have a container image
3742
ready, circle back to [Use a Docker Container in a Job](#use-a-docker-container-in-a-job).
3843

@@ -88,14 +93,17 @@ Docker commands yourself.
8893
Other pieces of the job (your executable and input files) should be just
8994
like a non-Docker job submission.
9095
96+
<!--
9197
TODO:
9298
- transfer executable?
99+
- NON root
93100
- tag versions
101+
-->
94102
95-
Similarly, we recommend using container tags. Importantly, whenever you make a significant change
103+
We recommend using container tags. Importantly, whenever you make a significant change
96104
to your container, you will want to use a new tag name to ensure that your jobs are getting an
97105
updated version of the container, and not an 'old' version that has been cached by DockerHub
98-
or CHTC.
106+
or CHTC.
99107
100108
## Find an existing Docker container image
101109
@@ -128,12 +136,12 @@ If you want to test your jobs or container, you have two options:
128136
* We have a guide on exploring and testing Docker containers on your own computer here:
129137
* [Exploring and Testing Docker Containers](docker-test.html)
130138
* You can test a container interactively in CHTC by using a normal Docker job submit file and using the
131-
interactive flag with `condor_submit`:
132-
```
133-
[alice@ap]$ condor_submit -i docker.sub
134-
```
135-
{: .cmd}
136-
This should start a session inside the indicated Docker container and connect you to it using ssh. Type `exit` to end the interactive job. *Note*: Files generated during your interactive job with Docker will not be transfered back to the submit node. If you have a directory on `staging`, you can transfer the files there instead; if you have questions about this, please contact a facilitator.
139+
interactive flag with `condor_submit`:
140+
```
141+
[alice@ap]$ condor_submit -i docker.sub
142+
```
143+
{:.term}
144+
This should start a session inside the indicated Docker container and connect you to it using ssh. Type `exit` to end the interactive job. *Note*: Files generated during your interactive job with Docker will not be transfered back to the submit node. If you have a directory on `staging`, you can transfer the files there instead; if you have questions about this, please contact a facilitator.
137145
138146
## Related Pages
139147

_uw-research-computing/docker-test.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ explore and test a Docker container on your own computer.
1414

1515
{% capture content %}
1616
- [Overview](#overview)
17-
- [Set up Docker on your computer]()
18-
- [Explore Docker containers]()
19-
- [Simulate a CHTC Docker Job]()
17+
- [Set up Docker on your computer](#set-up-docker-on-your-computer)
18+
- [Explore Docker containers](#explore-docker-containers)
19+
- [Simulate a CHTC docker job](#simulate-a-chtc-docker-job)
2020
- [Related pages](#related-pages)
2121
{% endcapture %}
2222
{% include /components/directory.html title="Table of Contents" %}
@@ -28,8 +28,8 @@ in CHTC.**
2828

2929
This guide has two sections:
3030

31-
* [Explore Docker Containers](#b-explore-docker-containers)
32-
* [Simulate a CHTC Docker Job](#c-simulate-a-chtc-docker-job)
31+
* [Explore Docker containers](#explore-docker-containers)
32+
* [Simulate a CHTC docker job](#simulate-a-chtc-docker-job)
3333

3434
If you've never used Docker before, and/or are getting ready to build your own
3535
container image, we recommend starting with the first part of the
@@ -264,5 +264,5 @@ your Docker job to run on CHTC.
264264

265265
## Related Pages
266266

267-
- [Build a Docker Container Image](docker-build.html)
268-
- [Explore and Test Docker Containers](docker-test.html)
267+
- [Use Custom Software in Jobs Using Docker](docker-jobs.html)
268+
- [Build a Docker Container Image](docker-build.html)

0 commit comments

Comments
 (0)