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: config.md
+24-11Lines changed: 24 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,8 +25,9 @@ NOTE that there is no guarantee for forward or backward compatibility for versio
25
25
26
26
Each container has exactly one *root filesystem*, specified in the *root* object:
27
27
28
-
***`path`** (string, required) Specifies the path to the root filesystem for the container. A directory MUST exist at the path declared by the field.
29
-
***`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
28
+
***`path`** (string, required) Specifies the path to the root filesystem for the container.
29
+
A directory MUST exist at the path declared by the field.
30
+
***`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container, defaults to false.
30
31
31
32
### Example
32
33
@@ -44,10 +45,14 @@ The runtime MUST mount entries in the listed order.
44
45
The parameters are similar to the ones in [the Linux mount system call](http://man7.org/linux/man-pages/man2/mount.2.html).
45
46
46
47
***`destination`** (string, required) Destination of mount point: path inside container.
47
-
For the Windows operating system, one mount destination MUST NOT be nested within another mount. (Ex: c:\\foo and c:\\foo\\bar).
48
-
***`type`** (string, required) Linux, *filesystemtype* argument supported by the kernel are listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660"). Windows: ntfs
49
-
***`source`** (string, required) a device name, but can also be a directory name or a dummy. Windows, the volume name that is the target of the mount point. \\?\Volume\{GUID}\ (on Windows source is called target)
50
-
***`options`** (list of strings, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
48
+
For the Windows operating system, one mount destination MUST NOT be nested within another mount. (Ex: c:\\foo and c:\\foo\\bar).
49
+
***`type`** (string, required) The filesystem type of the filesystem to be mounted.
50
+
Linux: *filesystemtype* argument supported by the kernel are listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
51
+
Windows: ntfs.
52
+
***`source`** (string, required) A device name, but can also be a directory name or a dummy.
53
+
Windows: the volume name that is the target of the mount point. \\?\Volume\{GUID}\ (on Windows source is called target).
54
+
***`options`** (list of strings, optional) Mount options of the filesystem to be used.
55
+
Linux: [supported][mount.8-filesystem-independent][options][mount.8-filesystem-specific] are listed in [mount(8)][mount.8].
51
56
52
57
### Example (Linux)
53
58
@@ -86,10 +91,14 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
86
91
87
92
## Process configuration
88
93
89
-
***`terminal`** (bool, optional) specifies whether you want a terminal attached to that process. Defaults to false.
90
-
***`cwd`** (string, required) is the working directory that will be set for the executable. This value MUST be an absolute path.
91
-
***`env`** (array of strings, optional) contains a list of variables that will be set in the process's environment prior to execution. Elements in the array are specified as Strings in the form "KEY=value". The left hand side MUST consist solely of letters, digits, and underscores `_` as outlined in [IEEE Std 1003.1-2001](http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html).
92
-
***`args`** (array of strings, required) executable to launch and any flags as an array. The executable is the first element and MUST be available at the given path inside of the rootfs. If the executable path is not an absolute path then the search $PATH is interpreted to find the executable.
94
+
***`terminal`** (bool, optional) specifies whether you want a terminal attached to that process, defaults to false.
95
+
***`cwd`** (string, required) is the working directory that will be set for the executable.
96
+
This value MUST be an absolute path.
97
+
***`env`** (array of strings, optional) contains a list of variables that will be set in the process's environment prior to execution.
98
+
Elements in the array are specified as Strings in the form "KEY=value", the left hand side MUST consist solely of letters, digits, and underscores `_` as outlined in [IEEE Std 1003.1-2001](http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html).
99
+
***`args`** (array of strings, required) executable to launch and any flags as an array.
100
+
The executable is the first element and MUST be available at the given path inside of the rootfs.
101
+
If the executable path is not an absolute path then the search $PATH is interpreted to find the executable.
93
102
94
103
For Linux-based systems the process structure supports the following process specific fields:
95
104
@@ -180,7 +189,8 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
180
189
181
190
## Hostname
182
191
183
-
***`hostname`** (string, optional) as it is accessible to processes running inside. On Linux, you can only set this if your bundle creates a new [UTS namespace][uts-namespace].
192
+
***`hostname`** (string, optional) as it is accessible to processes running inside.
193
+
On Linux, you can only set this if your bundle creates a new [UTS namespace][uts-namespace].
184
194
185
195
### Example
186
196
@@ -671,3 +681,6 @@ Here is a full example `config.json` for reference.
0 commit comments