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
+24-8Lines changed: 24 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ If not specified, the default value is an empty value of the corresponding type.
9
9
10
10
### `base_environment`
11
11
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.
12
+
* Type: array or string
13
+
14
+
Ordered list of EDFs that this file inherits from. Parameters from listed environments are evaluated sequentially. Supports up to 10 levels of recursion.
13
15
14
16
!!! example
15
17
* Single environment inheritance:
@@ -29,7 +31,9 @@ If not specified, the default value is an empty value of the corresponding type.
29
31
30
32
### `image`
31
33
32
-
(STRING) The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
34
+
* Type: string
35
+
36
+
The container image to use. Can reference a remote Docker/OCI registry or a local Squashfs file as a filesystem path.
33
37
34
38
!!! example
35
39
* Reference of Ubuntu image in the Docker Hub registry (default registry)
@@ -66,7 +70,10 @@ If not specified, the default value is an empty value of the corresponding type.
66
70
67
71
### `workdir`
68
72
69
-
(STRING) Initial working directory when the container starts. Default: inherited from image.
73
+
* Type: string
74
+
* Default: inherited from image
75
+
76
+
Initial working directory when the container starts.
70
77
71
78
!!! example
72
79
* Workdir pointing to a user defined project path
@@ -80,7 +87,10 @@ If not specified, the default value is an empty value of the corresponding type.
80
87
81
88
### `entrypoint`
82
89
83
-
(BOOL) If true, run the entrypoint from the container image. Default: true.
90
+
* Type: bool
91
+
* Default: `true`
92
+
93
+
If true, run the entrypoint from the container image.
84
94
85
95
!!! example
86
96
```toml
@@ -89,7 +99,10 @@ If not specified, the default value is an empty value of the corresponding type.
89
99
90
100
### `writable`
91
101
92
-
(BOOL) If false, the container filesystem is read-only. Default: true.
102
+
* Type: bool
103
+
* Type: `true`
104
+
105
+
If false, the container filesystem is read-only.
93
106
94
107
!!! example
95
108
```toml
@@ -98,7 +111,9 @@ If not specified, the default value is an empty value of the corresponding type.
98
111
99
112
### `mounts`
100
113
101
-
(ARRAY) List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
114
+
* Type: array
115
+
116
+
List of bind mounts in the format `SOURCE:DESTINATION[:FLAGS]`. Flags are optional and can include `ro`, `private`, etc.
102
117
103
118
!!! example
104
119
* Literal fixed mount map
@@ -124,7 +139,9 @@ If not specified, the default value is an empty value of the corresponding type.
124
139
125
140
### `env`
126
141
127
-
Environment variables to set in the container. Empty string values will unset the variable. Default: inherited from the host and the image.
142
+
* Default: inherited from the host and the image
143
+
144
+
Environment variables to set in the container. Empty string values will unset the variable.
128
145
129
146
!!! example
130
147
* Basic `env` block
@@ -152,7 +169,6 @@ Environment variables to set in the container. Empty string values will unset th
152
169
OCI-like annotations for the container. For more details, refer to the [Annotations][ref-ce-annotations] section.
0 commit comments