Skip to content

Commit d1b729d

Browse files
committed
EDF: convert 'type' and 'default' to tables
1 parent 57e234c commit d1b729d

File tree

1 file changed

+13
-17
lines changed
  • docs/software/container-engine

1 file changed

+13
-17
lines changed

docs/software/container-engine/edf.md

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

88
### `base_environment`
99

10-
* Type: array or string
11-
* Default: `""`
10+
| Type | array or string |
11+
| Default | `""` |
1212

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

@@ -30,8 +30,8 @@ Ordered list of EDFs that this file inherits from. Parameters from listed enviro
3030

3131
### `image`
3232

33-
* Type: string
34-
* Default: **(mandatory)**
33+
| 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

@@ -70,8 +70,8 @@ The container image to use. Can reference a remote Docker/OCI registry or a loca
7070

7171
### `workdir`
7272

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

7676
Initial working directory when the container starts.
7777

@@ -87,8 +87,8 @@ Initial working directory when the container starts.
8787

8888
### `entrypoint`
8989

90-
* Type: bool
91-
* Default: `true`
90+
| Type | bool |
91+
| Default | `true` |
9292

9393
If true, run the entrypoint from the container image.
9494

@@ -99,8 +99,8 @@ If true, run the entrypoint from the container image.
9999

100100
### `writable`
101101

102-
* Type: bool
103-
* Default: `true`
102+
| Type | bool |
103+
| Default | `true` |
104104

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

@@ -111,8 +111,8 @@ If false, the container filesystem is read-only.
111111

112112
### `mounts`
113113

114-
* Type: array
115-
* Default: `[]`
114+
| Type | array |
115+
| Default | `[]` |
116116

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

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

141141
### `env`
142142

143-
* Default: (inherited from the host and the image)
144-
145-
Environment variables to set in the container. Empty string values will unset the variable.
143+
Environment variables to set in the container. Empty string values will unset the variable. Inherited from the host and the image by default.
146144

147145
!!! example
148146
* Basic `env` block
@@ -167,8 +165,6 @@ Environment variables to set in the container. Empty string values will unset th
167165

168166
### `annotations`
169167

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

174170
!!! example

0 commit comments

Comments
 (0)