Skip to content

Commit 5806c35

Browse files
authored
Merge pull request #981 from kinvolk/alban/source-mount
config: clarify source mount
2 parents 5684b8a + f3be7d2 commit 5806c35

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

config.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,9 @@ On all other platforms, this field is REQUIRED.
7373
This value MUST be an absolute path.
7474
* Windows: one mount destination MUST NOT be nested within another mount (e.g., c:\\foo and c:\\foo\\bar).
7575
* Solaris: corresponds to "dir" of the fs resource in [zonecfg(1M)][zonecfg.1m].
76-
* **`source`** (string, OPTIONAL) A device name, but can also be a directory name or a dummy.
77-
Path values are either absolute or relative to the bundle.
76+
* **`source`** (string, OPTIONAL) A device name, but can also be a file or directory name for bind mounts or a dummy.
77+
Path values for bind mounts are either absolute or relative to the bundle.
78+
A mount is a bind mount if it has either `bind` or `rbind` in the options.
7879
* Windows: a local directory on the filesystem of the container host. UNC paths and mapped drives are not supported.
7980
* Solaris: corresponds to "special" of the fs resource in [zonecfg(1M)][zonecfg.1m].
8081
* **`options`** (array of strings, OPTIONAL) Mount options of the filesystem to be used.
@@ -100,7 +101,7 @@ On all other platforms, this field is REQUIRED.
100101
For POSIX platforms the `mounts` structure has the following fields:
101102

102103
* **`type`** (string, OPTIONAL) The type of the filesystem to be mounted.
103-
* Linux: filesystem types supported by the kernel as listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660").
104+
* Linux: filesystem types supported by the kernel as listed in */proc/filesystems* (e.g., "minix", "ext2", "ext3", "jfs", "xfs", "reiserfs", "msdos", "proc", "nfs", "iso9660"). For bind mounts (when `options` include either `bind` or `rbind`), the type is a dummy, often "none" (not listed in */proc/filesystems*).
104105
* Solaris: corresponds to "type" of the fs resource in [zonecfg(1M)][zonecfg.1m].
105106

106107
### Example (Linux)
@@ -115,7 +116,7 @@ For POSIX platforms the `mounts` structure has the following fields:
115116
},
116117
{
117118
"destination": "/data",
118-
"type": "bind",
119+
"type": "none",
119120
"source": "/volumes/testing",
120121
"options": ["rbind","rw"]
121122
}

0 commit comments

Comments
 (0)