Skip to content

Commit a605539

Browse files
committed
Update run.md
1 parent 8e7a6f2 commit a605539

File tree

1 file changed

+15
-15
lines changed
  • docs/software/container-engine

1 file changed

+15
-15
lines changed

docs/software/container-engine/run.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,14 @@ VERSION_ID="12"
3838

3939
The recommended approach is to use `--environment` as part of the Slurm command (e.g., `srun` or `salloc`):
4040

41-
!!! example "Adding `--environment` to `srun`"
42-
```bash
43-
#!/bin/bash
44-
#SBATCH --job-name=edf-example
45-
...
41+
```console
42+
#!/bin/bash
43+
#SBATCH --job-name=edf-example
44+
...
4645

47-
# Run job step
48-
srun --environment=debian cat /etc/os-release
49-
```
46+
# Run job step
47+
srun --environment=debian cat /etc/os-release
48+
```
5049

5150
Alternatively, the `--environment` option can also be specified with an `#SBATCH` option.
5251
However, the support status is still **experimental** and may result in unexpected behaviors.
@@ -94,10 +93,8 @@ To choose an alternative image store path (e.g., to use a directory owned by a g
9493
`EDF_IMAGESTORE` must be an absolute path to an existing folder.
9594

9695
!!! note
97-
If the CE cannot create a directory for the image cache, it operates in cache-free mode, meaning that it pulls an ephemeral image before every container launch and discards it upon termination.
98-
99-
!!! note
100-
Local container images are not cached. See the section below on how to use local images in EDF.
96+
* If the CE cannot create a directory for the image cache, it operates in cache-free mode, meaning that it pulls an ephemeral image before every container launch and discards it upon termination.
97+
* Local container images are not cached. See the section below on how to use local images in EDF.
10198

10299
### Pulling images manually
103100

@@ -126,7 +123,7 @@ After the import is complete, images are available in Squashfs format in the cur
126123
1. Assuming `example.toml` is already written at `${HOME}/.edf`.
127124

128125
!!! note
129-
It is recommended to save images in `/capstor/scratch/cscs/${USER}` or its subdirectories before using them with the CE.
126+
It is recommended to save images in `/capstor/scratch/cscs/${USER}` or its subdirectories before using them.
130127

131128
[](){#ref-ce-third-party-private-registries}
132129
### Third-party and private registries
@@ -140,15 +137,18 @@ After the import is complete, images are available in Squashfs format in the cur
140137

141138
To use an image from a different registry, the corresponding registry URL has to be prepended to the image reference, using a hash character (#) as a separator:
142139

143-
!!! example "Using a third-party registry within an EDF"
140+
!!! example "Using a third-party registry"
141+
* Within an EDF
142+
144143
```bash
145144
$ cat ${HOME}/.edf/example.toml # (1)
146145
image = "nvcr.io#nvidia/nvhpc:23.7-runtime-cuda11.8-ubuntu22.04"
147146
```
148147

149148
1. Assuming `example.toml` is already written at `${HOME}/.edf`.
150149

151-
!!! example "Using a third-party registry on the command line"
150+
* On the command line
151+
152152
```bash
153153
$ enroot import docker://nvcr.io#nvidia/nvhpc:23.7-runtime-cuda11.8-ubuntu22.04
154154
```

0 commit comments

Comments
 (0)