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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ EDF files use the [TOML format](https://toml.io/en/). For details about the data
7
7
8
8
In the following, the default value is none (i.e., the empty value of the corresponding type) if not specified.
9
9
10
-
### (ARRAY or STRING) base_environment
10
+
### base_environment
11
11
12
-
Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
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
14
14
!!! example
15
15
* Single environment inheritance:
@@ -27,9 +27,9 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
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
-
### (STRING) image
30
+
### image
31
31
32
-
The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
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
34
34
!!! example
35
35
* Reference of Ubuntu image in the Docker Hub registry (default registry)
@@ -64,9 +64,9 @@ The container image to use. Can reference a remote Docker/OCI registry or a loca
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
-
### (STRING) workdir
67
+
### workdir
68
68
69
-
Initial working directory when the container starts. Default: inherited from image.
69
+
(STRING) Initial working directory when the container starts. Default: inherited from image.
70
70
71
71
!!! example
72
72
* Workdir pointing to a user defined project path
@@ -78,27 +78,27 @@ Initial working directory when the container starts. Default: inherited from ima
78
78
workdir = "/tmp"
79
79
```
80
80
81
-
### (BOOL) entrypoint
81
+
### entrypoint
82
82
83
-
If true, run the entrypoint from the container image. Default: true.
83
+
(BOOL) If true, run the entrypoint from the container image. Default: true.
84
84
85
85
!!! example
86
86
```bash
87
87
entrypoint = false
88
88
```
89
89
90
-
### (BOOL) writable
90
+
### writable
91
91
92
-
If false, the container filesystem is read-only. Default: true.
92
+
(BOOL) If false, the container filesystem is read-only. Default: true.
93
93
94
94
!!! example
95
95
```bash
96
96
writable = true
97
97
```
98
98
99
-
### (ARRAY) mounts
99
+
### mounts
100
100
101
-
List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
101
+
(ARRAY) List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102
102
103
103
!!! example
104
104
* Literal fixed mount map
@@ -120,9 +120,9 @@ List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are option
120
120
* Mount flags are separated with a plus symbol, for example: `ro+private`.
121
121
* Optional flags from docker format or OCI (need reference)
122
122
123
-
### (TABLE) env
123
+
### env
124
124
125
-
Environment variables to set in the container. Null-string values will unset the variable. Default: inherited from the host and the image.
125
+
(TABLE) Environment variables to set in the container. Null-string values will unset the variable. Default: inherited from the host and the image.
126
126
127
127
!!! example
128
128
* Basic `env` block
@@ -145,9 +145,9 @@ Environment variables to set in the container. Null-string values will unset the
145
145
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
146
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.
147
147
148
-
### (TABLE) annotations
148
+
### annotations
149
149
150
-
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
150
+
(TABLE) OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
0 commit comments