Skip to content
Snippets Groups Projects
Commit d7ff1b30 authored by Jan Frenzel's avatar Jan Frenzel
Browse files

Merge branch 'docker' into 'preview'

Fix wording of Docker and Singularity

See merge request !1046
parents 68e7a864 ccbf6e0b
No related branches found
No related tags found
2 merge requests!1055Automated merge from preview to main,!1046Fix wording of Docker and Singularity
......@@ -79,7 +79,7 @@ faster.
Assuming you already have a working Docker installation and have cloned the repository as mentioned
above, a few more steps are necessary.
Build the docker image. This might take a bit longer, as `mkdocs` and other necessary software
Build the Docker image. This might take a bit longer, as `mkdocs` and other necessary software
needs to be downloaded, but you have to run it only once in a while.
Building a container could be done with the following steps:
......@@ -155,9 +155,10 @@ cp doc.zih.tu-dresden.de/util/pre-commit .git/hooks/
```
!!! note
The pre-commit hook only works, if you can use docker without using `sudo`. If this is not
already the case, use the command `adduser $USER docker` to enable docker commands without
`sudo` for the current user. Restart the docker daemons afterwards.
The pre-commit hook only works, if you can use Docker without using `sudo`. If this is not
already the case, use the command `adduser $USER docker` to enable Docker commands without
`sudo` for the current user. Restart the Docker daemons afterwards.
Read on if you want to run a specific check.
......
......@@ -34,9 +34,9 @@ environment.
However, new containers can be created on your local workstation and moved to ZIH systems for
execution. Follow the instructions for [locally installing Singularity](#local-installation) and
[container creation](#container-creation). Moreover, existing Docker container can easily be
converted, see [Import a docker container](#import-a-docker-container).
converted, see [Import a Docker container](#import-a-docker-container).
If you are already familiar with Singularity, you might be more interested in our [singularity
If you are already familiar with Singularity, you might be more interested in our [Singularity
recipes and hints](singularity_recipe_hints.md).
### Local Installation
......@@ -119,7 +119,7 @@ where you choose the base and
[sections](https://sylabs.io/guides/3.2/user-guide/definition_files.html#sections)
where you install your software.
The most common approach is to start from an existing docker image from DockerHub. For example, to
The most common approach is to start from an existing Docker image from DockerHub. For example, to
start from an [Ubuntu image](https://hub.docker.com/_/ubuntu) copy the following into a new file
called `ubuntu.def` (or any other filename of your choice)
......@@ -166,8 +166,8 @@ https://github.com/singularityware/singularity/tree/master/examples.
!!! hint
As opposed to bootstrapping a container, importing from Docker does **not require root
privileges** and therefore works on ZIH systems directly. Please note, that the singularity commands
are only available on the compute nodes and not on the login nodes.
privileges** and therefore works on ZIH systems directly. Please note, that the Singularity
commands are only available on the compute nodes and not on the login nodes.
You can import an image directly from the Docker repository (Docker Hub):
......@@ -175,7 +175,7 @@ You can import an image directly from the Docker repository (Docker Hub):
marie@compute$ singularity build my-container.sif docker://ubuntu:latest
```
Creating a singularity container directly from a local docker image is possible but not
Creating a Singularity container directly from a local Docker image is possible but not
recommended. The steps are:
```console
......@@ -210,7 +210,7 @@ marie@local$ pip3 install -U spython
```
With this you can simply issue the following command to convert a Dockerfile in the current folder
into a singularity definition file:
into a Singularity definition file:
```console
marie@local$ spython recipe Dockerfile myDefinition.def
......@@ -265,9 +265,9 @@ marie@compute$ singularity shell my-container.sif
```
You can write into those folders by default. If this is not desired, add an `:ro` for read-only to
the bind specification (e.g. `-B /data/horse:/data/horse:ro\`). Note that we already defined bind paths
for `/data/horse`, `/projects` and `/sw` in our global `singularity.conf`, so you needn't use the `-B`
parameter for those.
the bind specification (e.g. `-B /data/horse:/data/horse:ro\`). Note that we already defined bind
paths for `/data/horse`, `/projects` and `/sw` in our global `singularity.conf`, so you needn't use
the `-B` parameter for those.
If you wish to install additional packages, you have to use the `-w` parameter to
enter your container with it being writable. This, again, must be done on a system where you have
......@@ -339,7 +339,7 @@ Alternatively you can execute the container directly which is equivalent:
marie@compute$ ./my-container.sif first_arg 2nd_arg
```
With this you can even masquerade an application with a singularity container as if it was an actual
With this you can even masquerade an application with a Singularity container as if it was an actual
program by naming the container just like the binary:
```console
......
......@@ -85,7 +85,7 @@ the [PowerAI container](https://hub.docker.com/r/ibmcom/powerai/) DockerHub repo
!!! note
You could find other versions of software in the container on the "tag" tab on the docker web
You could find other versions of software in the container on the "tag" tab on the Docker web
page of the container.
In the following example, we build a Singularity container with TensorFlow from the DockerHub and
......
......@@ -120,7 +120,7 @@ This will create the `ubuntu_mpich.sif` file that you have to copy to HPC system
At the HPC system run as following:
```console
marie@login$ srun -n 4 --ntasks-per-node 2 --time=00:10:00 singularity exec ubuntu_mpich.sif /opt/mpitest
marie@login$ srun ---nodes=4 --ntasks-per-node=2 --time=00:10:00 singularity exec ubuntu_mpich.sif /opt/mpitest
```
### CUDA + CuDNN + Open MPI
......
......@@ -8,7 +8,7 @@ and a compatible kernel. If some of these requirements cannot be fulfilled, then
option of using the provided virtual machines (VM) on ZIH systems.
Currently, starting VMs is only possible on the cluster `power` (and `hpdlf`?). The VMs on the power
nodes are used to build singularity containers for the Power9 architecture and the HPDLF nodes to
nodes are used to build Singularity containers for the Power9 architecture and the HPDLF nodes to
build Singularity containers for the x86 architecture.
## Create a Virtual Machine
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment