Skip to content

Commit bfcae2f

Browse files
committed
Update edf.md
1 parent d207aaf commit bfcae2f

File tree

1 file changed

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

1 file changed

+16
-16
lines changed

docs/software/container-engine/edf.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ EDF files use the [TOML format](https://toml.io/en/). For details about the data
77

88
In the following, the default value is none (i.e., the empty value of the corresponding type) if not specified.
99

10-
### (ARRAY or STRING) base_environment
10+
### base_environment
1111

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.
1313

1414
!!! example
1515
* Single environment inheritance:
@@ -27,9 +27,9 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
2727
* 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].
2828
* This parameter can be a string if there is only one base environment.
2929

30-
### (STRING) image
30+
### image
3131

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.
3333

3434
!!! example
3535
* 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
6464
* `[:TAG]`: (optional) image tag name, preceded by :.
6565
* The registry user can also be specified in the `$HOME/.config/enroot/.credentials` file.
6666

67-
### (STRING) workdir
67+
### workdir
6868

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.
7070

7171
!!! example
7272
* Workdir pointing to a user defined project path 
@@ -78,27 +78,27 @@ Initial working directory when the container starts. Default: inherited from ima
7878
workdir = "/tmp"
7979
```
8080

81-
### (BOOL) entrypoint
81+
### entrypoint
8282

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.
8484

8585
!!! example
8686
```bash
8787
entrypoint = false
8888
```
8989

90-
### (BOOL) writable
90+
### writable
9191

92-
If false, the container filesystem is read-only. Default: true.
92+
(BOOL) If false, the container filesystem is read-only. Default: true.
9393

9494
!!! example
9595
```bash
9696
writable = true
9797
```
9898

99-
### (ARRAY) mounts
99+
### mounts
100100

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.
102102

103103
!!! example
104104
* Literal fixed mount map
@@ -120,9 +120,9 @@ List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are option
120120
* Mount flags are separated with a plus symbol, for example: `ro+private`.
121121
* Optional flags from docker format or OCI (need reference)
122122

123-
### (TABLE) env
123+
### env
124124

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.
126126

127127
!!! example
128128
* Basic `env` block
@@ -145,9 +145,9 @@ Environment variables to set in the container. Null-string values will unset the
145145
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
146146
* 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.
147147

148-
### (TABLE) annotations
148+
### annotations
149149

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.
151151

152152
!!! example
153153

0 commit comments

Comments
 (0)