You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/software/container-engine/edf.md
+27-32Lines changed: 27 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,7 @@ In the following, the default value is none (i.e., the empty value of the corres
11
11
12
12
Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
13
13
14
-
??? note
15
-
* 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.
16
-
* 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].
17
-
* This parameter can be a string if there is only one base environment.
18
-
19
-
??? example
14
+
!!! example
20
15
* Single environment inheritance:
21
16
```bash
22
17
base_environment = "common_env"
@@ -27,18 +22,16 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
* 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.
27
+
* 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].
28
+
* This parameter can be a string if there is only one base environment.
29
+
30
30
### (STRING) image
31
31
32
32
The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
33
33
34
-
??? note
35
-
* The full format for remote references is `[USER@][REGISTRY#]IMAGE[:TAG]`.
36
-
* `[REGISTRY#]`: (optional) registry URL, followed by #. Default: Docker Hub.
37
-
* `IMAGE`: image name.
38
-
* `[:TAG]`: (optional) image tag name, preceded by :.
39
-
* The registry user can also be specified in the `$HOME/.config/enroot/.credentials` file.
40
-
41
-
??? example
34
+
!!! example
42
35
* Reference of Ubuntu image in the Docker Hub registry (default registry)
43
36
```bash
44
37
image = "library/ubuntu:24.04"
@@ -64,11 +57,18 @@ The container image to use. Can reference a remote Docker/OCI registry or a loca
64
57
image = "/path/to/image.squashfs"
65
58
```
66
59
60
+
??? note
61
+
* The full format for remote references is `[USER@][REGISTRY#]IMAGE[:TAG]`.
62
+
* `[REGISTRY#]`: (optional) registry URL, followed by #. Default: Docker Hub.
63
+
* `IMAGE`: image name.
64
+
* `[:TAG]`: (optional) image tag name, preceded by :.
65
+
* The registry user can also be specified in the `$HOME/.config/enroot/.credentials` file.
66
+
67
67
### (STRING) workdir
68
68
69
69
Initial working directory when the container starts. Default: inherited from image.
70
70
71
-
??? example
71
+
!!! example
72
72
* Workdir pointing to a user defined project path
73
73
```bash
74
74
workdir = "/home/user/projects"
@@ -82,7 +82,7 @@ Initial working directory when the container starts. Default: inherited from ima
82
82
83
83
If true, run the entrypoint from the container image. Default: true.
84
84
85
-
??? example
85
+
!!! example
86
86
```bash
87
87
entrypoint = false
88
88
```
@@ -91,7 +91,7 @@ If true, run the entrypoint from the container image. Default: true.
91
91
92
92
If false, the container filesystem is read-only. Default: true.
93
93
94
-
??? example
94
+
!!! example
95
95
```bash
96
96
writable = true
97
97
```
@@ -100,12 +100,7 @@ If false, the container filesystem is read-only. Default: true.
100
100
101
101
List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102
102
103
-
??? note
104
-
* Mount flags are separated with a plus symbol, for example: `ro+private`.
105
-
* Optional flags from docker format or OCI (need reference)
@@ -121,19 +116,15 @@ List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are option
121
116
mounts = ["${SCRATCH}:/scratch"]
122
117
```
123
118
119
+
??? note
120
+
* Mount flags are separated with a plus symbol, for example: `ro+private`.
121
+
* Optional flags from docker format or OCI (need reference)
124
122
125
123
### (TABLE) env
126
124
127
125
Environment variables to set in the container. Null-string values will unset the variable. Default: inherited from the host and the image.
128
126
129
-
??? note
130
-
* By default, containers inherit environment variables from the container image and the host environment, with variables from the image taking precedence.
131
-
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
132
-
* 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.
133
-
134
-
135
-
??? example
136
-
127
+
!!! example
137
128
* Basic `env` block
138
129
```bash
139
130
[env]
@@ -149,12 +140,16 @@ Environment variables to set in the container. Null-string values will unset the
149
140
DEBUG = "true"
150
141
```
151
142
143
+
??? note
144
+
* By default, containers inherit environment variables from the container image and the host environment, with variables from the image taking precedence.
145
+
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
146
+
* 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.
152
147
153
148
### (TABLE) annotations
154
149
155
150
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
0 commit comments