Skip to content

Commit b388d37

Browse files
committed
Change EDF entries to monospace font
1 parent 669043b commit b388d37

File tree

1 file changed

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

1 file changed

+8
-8
lines changed

docs/software/container-engine/edf.md

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

88
If not specified, the default value is an empty value of the corresponding type.
99

10-
### base_environment
10+
### `base_environment`
1111

1212
(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

@@ -27,7 +27,7 @@ If not specified, the default value is an empty value of the corresponding type.
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-
### image
30+
### `image`
3131

3232
(STRING) The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
3333

@@ -64,7 +64,7 @@ If not specified, the default value is an empty value of the corresponding type.
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-
### workdir
67+
### `workdir`
6868

6969
(STRING) Initial working directory when the container starts. Default: inherited from image.
7070

@@ -78,7 +78,7 @@ If not specified, the default value is an empty value of the corresponding type.
7878
workdir = "/tmp"
7979
```
8080

81-
### entrypoint
81+
### `entrypoint`
8282

8383
(BOOL) If true, run the entrypoint from the container image. Default: true.
8484

@@ -87,7 +87,7 @@ If not specified, the default value is an empty value of the corresponding type.
8787
entrypoint = false
8888
```
8989

90-
### writable
90+
### `writable`
9191

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

@@ -96,7 +96,7 @@ If not specified, the default value is an empty value of the corresponding type.
9696
writable = true
9797
```
9898

99-
### mounts
99+
### `mounts`
100100

101101
(ARRAY) List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102102

@@ -122,7 +122,7 @@ If not specified, the default value is an empty value of the corresponding type.
122122

123123
## EDF tables
124124

125-
### env
125+
### `env`
126126

127127
Environment variables to set in the container. Empty string values will unset the variable. Default: inherited from the host and the image.
128128

@@ -147,7 +147,7 @@ Environment variables to set in the container. Empty string values will unset th
147147
* The env table can be used to further customize the container environment by setting, modifying, or unsetting variables.
148148
* 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.
149149

150-
### annotations
150+
### `annotations`
151151

152152
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
153153

0 commit comments

Comments
 (0)