Skip to content

Commit 7627fef

Browse files
committed
EDF entries: specify default values
1 parent 0bb69f3 commit 7627fef

File tree

1 file changed

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

1 file changed

+8
-5
lines changed

docs/software/container-engine/edf.md

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

66
## EDF entries
77

8-
If not specified, the default value is an empty value of the corresponding type.
9-
108
### `base_environment`
119

1210
* Type: array or string
11+
* Default: `""`
1312

1413
Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
1514

@@ -32,6 +31,7 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
3231
### `image`
3332

3433
* Type: string
34+
* Default: **(mandatory)**
3535

3636
The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
3737

@@ -71,7 +71,7 @@ The container image to use. Can reference a remote Docker/OCI registry or a loca
7171
### `workdir`
7272

7373
* Type: string
74-
* Default: inherited from image
74+
* Default: (inherited from image)
7575

7676
Initial working directory when the container starts.
7777

@@ -100,7 +100,7 @@ If true, run the entrypoint from the container image.
100100
### `writable`
101101

102102
* Type: bool
103-
* Type: `true`
103+
* Default: `true`
104104

105105
If false, the container filesystem is read-only.
106106

@@ -112,6 +112,7 @@ If false, the container filesystem is read-only.
112112
### `mounts`
113113

114114
* Type: array
115+
* Default: `[]`
115116

116117
List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
117118

@@ -139,7 +140,7 @@ List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are option
139140

140141
### `env`
141142

142-
* Default: inherited from the host and the image
143+
* Default: (inherited from the host and the image)
143144

144145
Environment variables to set in the container. Empty string values will unset the variable.
145146

@@ -166,6 +167,8 @@ Environment variables to set in the container. Empty string values will unset th
166167

167168
### `annotations`
168169

170+
* Default: (none)
171+
169172
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
170173

171174
!!! example

0 commit comments

Comments
 (0)