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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ EDF files use the [TOML format](https://toml.io/en/). For details about the data
7
7
8
8
If not specified, the default value is an empty value of the corresponding type.
9
9
10
-
### base_environment
10
+
### `base_environment`
11
11
12
12
(ARRAY or STRING) 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
@@ -27,7 +27,7 @@ If not specified, the default value is an empty value of the corresponding type.
27
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
28
* This parameter can be a string if there is only one base environment.
29
29
30
-
### image
30
+
### `image`
31
31
32
32
(STRING) The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
33
33
@@ -64,7 +64,7 @@ If not specified, the default value is an empty value of the corresponding type.
64
64
* `[:TAG]`: (optional) image tag name, preceded by :.
65
65
* The registry user can also be specified in the `$HOME/.config/enroot/.credentials` file.
66
66
67
-
### workdir
67
+
### `workdir`
68
68
69
69
(STRING) Initial working directory when the container starts. Default: inherited from image.
70
70
@@ -78,7 +78,7 @@ If not specified, the default value is an empty value of the corresponding type.
78
78
workdir = "/tmp"
79
79
```
80
80
81
-
### entrypoint
81
+
### `entrypoint`
82
82
83
83
(BOOL) If true, run the entrypoint from the container image. Default: true.
84
84
@@ -87,7 +87,7 @@ If not specified, the default value is an empty value of the corresponding type.
87
87
entrypoint = false
88
88
```
89
89
90
-
### writable
90
+
### `writable`
91
91
92
92
(BOOL) If false, the container filesystem is read-only. Default: true.
93
93
@@ -96,7 +96,7 @@ If not specified, the default value is an empty value of the corresponding type.
96
96
writable = true
97
97
```
98
98
99
-
### mounts
99
+
### `mounts`
100
100
101
101
(ARRAY) List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102
102
@@ -122,7 +122,7 @@ If not specified, the default value is an empty value of the corresponding type.
122
122
123
123
## EDF tables
124
124
125
-
### env
125
+
### `env`
126
126
127
127
Environment variables to set in the container. Empty string values will unset the variable. Default: inherited from the host and the image.
128
128
@@ -147,7 +147,7 @@ Environment variables to set in the container. Empty string values will unset th
147
147
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
148
148
* 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.
149
149
150
-
### annotations
150
+
### `annotations`
151
151
152
152
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
0 commit comments