Skip to content

Commit eccaa08

Browse files
Merge pull request #443 from hqhq/hq_config_new_line
Rewrite mounts description in config.md
2 parents 03a6f8c + 1752ce8 commit eccaa08

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

config.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ For example, if an implementation is compliant with version 1.0.1 of the spec, i
2424

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

27-
* **`path`** (string, required) Specifies the path to the root filesystem for the container. A directory MUST exist at the path declared by the field.
28-
* **`readonly`** (bool, optional) If true then the root filesystem MUST be read-only inside the container. Defaults to false.
27+
* **`path`** (string, required) Specifies the path to the root filesystem for the container.
28+
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.
2930

3031
### Example
3132

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

4546
* **`destination`** (string, required) Destination of mount point: path inside container.
46-
For the Windows operating system, one mount destination MUST NOT be nested within another mount. (Ex: c:\\foo and c:\\foo\\bar).
47-
* **`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
48-
* **`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)
49-
* **`options`** (list of strings, optional) in the fstab format [https://wiki.archlinux.org/index.php/Fstab](https://wiki.archlinux.org/index.php/Fstab).
47+
For the Windows operating system, one mount destination MUST NOT be nested within another mount (e.g., c:\\foo and c:\\foo\\bar).
48+
* **`type`** (string, required) The filesystem type of the filesystem to be mounted.
49+
Linux: *filesystemtype* argument supported by the kernel are listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
50+
Windows: ntfs.
51+
* **`source`** (string, required) A device name, but can also be a directory name or a dummy.
52+
Windows: the volume name that is the target of the mount point, \\?\Volume\{GUID}\ (on Windows source is called target).
53+
* **`options`** (list of strings, optional) Mount options of the filesystem to be used.
54+
Linux: [supported][mount.8-filesystem-independent] [options][mount.8-filesystem-specific] are listed in [mount(8)][mount.8].
5055

5156
### Example (Linux)
5257

@@ -85,10 +90,15 @@ See links for details about [mountvol](http://ss64.com/nt/mountvol.html) and [Se
8590

8691
## Process configuration
8792

88-
* **`terminal`** (bool, optional) specifies whether you want a terminal attached to that process. Defaults to false.
89-
* **`cwd`** (string, required) is the working directory that will be set for the executable. This value MUST be an absolute path.
90-
* **`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).
91-
* **`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.
93+
* **`terminal`** (bool, optional) specifies whether you want a terminal attached to that process, defaults to false.
94+
* **`cwd`** (string, required) is the working directory that will be set for the executable.
95+
This value MUST be an absolute path.
96+
* **`env`** (array of strings, optional) contains a list of variables that will be set in the process's environment prior to execution.
97+
Elements in the array are specified as Strings in the form "KEY=value".
98+
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.
92102

93103
For Linux-based systems the process structure supports the following process specific fields:
94104

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

180190
## Hostname
181191

182-
* **`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].
183194

184195
### Example
185196

@@ -677,3 +688,6 @@ Here is a full example `config.json` for reference.
677688
[go-environment]: https://golang.org/doc/install/source#environment
678689
[runtime-namespace]: glossary.md#runtime-namespace
679690
[uts-namespace]: http://man7.org/linux/man-pages/man7/namespaces.7.html
691+
[mount.8-filesystem-independent]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-INDEPENDENT_MOUNT OPTIONS
692+
[mount.8-filesystem-specific]: http://man7.org/linux/man-pages/man8/mount.8.html#FILESYSTEM-SPECIFIC_MOUNT OPTIONS
693+
[mount.8]: http://man7.org/linux/man-pages/man8/mount.8.html

0 commit comments

Comments
 (0)