Skip to content

Commit 1895e07

Browse files
committed
Rewrite mounts description in config.md
Also apply one sentence per line rule for list items. Signed-off-by: Qiang Huang <[email protected]>
1 parent 0dde4f9 commit 1895e07

1 file changed

Lines changed: 24 additions & 11 deletions

File tree

config.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ NOTE that there is no guarantee for forward or backward compatibility for versio
2525

2626
Each container has exactly one *root filesystem*, specified in the *root* object:
2727

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.
3031

3132
### Example
3233

@@ -44,10 +45,14 @@ The runtime MUST mount entries in the listed order.
4445
The parameters are similar to the ones in [the Linux mount system call](http://man7.org/linux/man-pages/man2/mount.2.html).
4546

4647
* **`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].
5156

5257
### Example (Linux)
5358

@@ -86,10 +91,14 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
8691

8792
## Process configuration
8893

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.
93102

94103
For Linux-based systems the process structure supports the following process specific fields:
95104

@@ -180,7 +189,8 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
180189

181190
## Hostname
182191

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].
184194

185195
### Example
186196

@@ -671,3 +681,6 @@ Here is a full example `config.json` for reference.
671681
[runtime-namespace]: glossary.md#runtime-namespace
672682
[uts-namespace]: http://man7.org/linux/man-pages/man7/namespaces.7.html
673683
[go-environment]: https://golang.org/doc/install/source#environment
684+
[mount.8-filesystem-independent]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-INDEPENDENT_MOUNT OPTIONS
685+
[mount.8-filesystem-specific]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-SPECIFIC_MOUNT OPTIONS
686+
[mount.8]: http://man7.org/linux/man-pages/man8/mount.8.html

0 commit comments

Comments
 (0)