Skip to content

Commit ef13308

Browse files
committed
EDF: expand all notes
1 parent ff247be commit ef13308

File tree

1 file changed

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

1 file changed

+4
-4
lines changed

docs/software/container-engine/edf.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
2525
base_environment = ["common_env", "ml_pytorch_env1"]
2626
```
2727

28-
??? note
28+
!!! note
2929
* Parameters from the listed environments are evaluated sequentially, adding new entries or overwriting previous ones, before evaluating the parameters from the current EDF. In other words, the current EDF inherits the parameters from the EDFs listed in `base_environment`. When evaluating `mounts` or `env` parameters, values from downstream EDFs are appended to inherited values.
3030
* The individual EDF entries in the array follow the same search rules as the arguments of the `--environment` CLI option for Slurm; they can be either file paths or filenames without extension if the file is located in the [EDF search path][ref-ce-edf-search-path].
3131
* This parameter can be a string if there is only one base environment.
@@ -65,7 +65,7 @@ The container image to use. Can reference a remote Docker/OCI registry or a loca
6565
image = "/path/to/image.squashfs"
6666
```
6767

68-
??? note
68+
!!! note
6969
* The full format for remote references is `[USER@][REGISTRY#]IMAGE[:TAG]`.
7070
* `[REGISTRY#]`: (optional) registry URL, followed by #. Default: Docker Hub.
7171
* `IMAGE`: image name.
@@ -144,7 +144,7 @@ List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are option
144144
mounts = ["${SCRATCH}:/scratch"]
145145
```
146146

147-
??? note
147+
!!! note
148148
* Mount flags are separated with a plus symbol, for example: `ro+private`.
149149
* Optional flags from docker format or OCI (need reference)
150150

@@ -170,7 +170,7 @@ Environment variables to set in the container. Empty string values will unset th
170170
DEBUG = "true"
171171
```
172172

173-
??? note
173+
!!! note
174174
* By default, containers inherit environment variables from the container image and the host environment, with variables from the image taking precedence.
175175
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
176176
* Values of the table entries must be strings. If an entry has a null value, the variable corresponding to the entry key is unset in the container.

0 commit comments

Comments
 (0)