Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add `bind-recursive` mount option 

Follow-up to PR 4316

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
This commit is contained in:
Akihiro Suda 2023-10-16 10:13:18 +09:00
parent 8890a38d42
commit 74bace156c
No known key found for this signature in database
GPG Key ID: 49524C6F9F638F1A
2 changed files with 38 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/reference/commandline/service_create.md
View File

@ -394,7 +394,7 @@ volumes in a service:
<td> <td>
<p>The Engine mounts binds and volumes <tt>read-write</tt> unless <tt>readonly</tt> option <p>The Engine mounts binds and volumes <tt>read-write</tt> unless <tt>readonly</tt> option
is given when mounting the bind or volume. Note that setting <tt>readonly</tt> for a is given when mounting the bind or volume. Note that setting <tt>readonly</tt> for a
bind-mount does not make its submounts <tt>readonly</tt> on the current Linux implementation. See also <tt>bind-nonrecursive</tt>.</p> bind-mount may not make its submounts <tt>readonly</tt> depending on the kernel version. See also <tt>bind-recursive</tt>.</p>
<ul> <ul>
<li><tt>true</tt> or <tt>1</tt> or no value: Mounts the bind or volume read-only.</li> <li><tt>true</tt> or <tt>1</tt> or no value: Mounts the bind or volume read-only.</li>
<li><tt>false</tt> or <tt>0</tt>: Mounts the bind or volume read-write.</li> <li><tt>false</tt> or <tt>0</tt>: Mounts the bind or volume read-write.</li>
@ -432,17 +432,40 @@ The following options can only be used for bind mounts (`type=bind`):
</td> </td>
</tr> </tr>
<tr> <tr>
<td><b>bind-nonrecursive</b></td> <td><b>bind-recursive</b></td>
<td> <td>
By default, submounts are recursively bind-mounted as well. However, this behavior can be confusing when a By default, submounts are recursively bind-mounted as well. However, this behavior can be confusing when a
bind mount is configured with <tt>readonly</tt> option, because submounts are not mounted as read-only. bind mount is configured with <tt>readonly</tt> option, because submounts may not be mounted as read-only,
Set <tt>bind-nonrecursive</tt> to disable recursive bind-mount.<br /> depending on the kernel version.
Set <tt>bind-recursive</tt> to control the behavior of the recursive bind-mount.<br />
<br />
A value is one of:<br />
<br />
<ul>
<li><<tt>enabled</tt>, <tt>true</tt> or <tt>1</tt>: Enables recursive bind-mount.
Read-only mounts are made recursively read-only if kernel is v5.12 or later.
Otherwise they are not made recursively read-only.</li>
<li><<tt>disabled</tt>, <tt>false</tt> or <tt>0</tt>: Disables recursive bind-mount.</li>
<li><<tt>writable</tt>: Enables recursive bind-mount.
Read-only mounts are not made recursively read-only.</li>
<li><<tt>readonly</tt>: Enables recursive bind-mount.
Read-only mounts are made recursively read-only if kernel is v5.12 or later.
Otherwise the Engine raises an error.</li>
</ul>
When the option is not specified, the default behavior correponds to setting <tt>enabled</tt>.
</td>
</tr>
<tr>
<td><b>bind-nonrecursive</b></td>
<td>
<tt>bind-nonrecursive</tt> is deprecated since Docker Engine v25.0.
Use <tt>bind-recursive</tt>instead.<br />
<br /> <br />
A value is optional:<br /> A value is optional:<br />
<br /> <br />
<ul> <ul>
<li><tt>true</tt> or <tt>1</tt>: Disables recursive bind-mount.</li> <li><tt>true</tt> or <tt>1</tt>: Equivalent to <tt>bind-recursive=disabled</tt>.</li>
<li><tt>false</tt> or <tt>0</tt>: Default if you do not provide a value. Enables recursive bind-mount.</li> <li><tt>false</tt> or <tt>0</tt>: Equivalent to <tt>bind-recursive=enabled</tt>.</li>
</ul> </ul>
</td> </td>
</tr> </tr>

14
man/docker-run.1.md
View File

@ -467,16 +467,20 @@ according to RFC4862.
* `dst`, `destination`, `target`: mount destination spec. * `dst`, `destination`, `target`: mount destination spec.
* `ro`, `readonly`: `true` or `false` (default). * `ro`, `readonly`: `true` or `false` (default).
**Note**: setting `readonly` for a bind mount does not make its submounts **Note**: setting `readonly` for a bind mount may not make its submounts
read-only on the current Linux implementation. See also `bind-nonrecursive`. read-only depending on the kernel version. See also `bind-recursive`.
Options specific to `bind`: Options specific to `bind`:
* `bind-propagation`: `shared`, `slave`, `private`, `rshared`, `rslave`, or `rprivate`(default). See also `mount(2)`. * `bind-propagation`: `shared`, `slave`, `private`, `rshared`, `rslave`, or `rprivate`(default). See also `mount(2)`.
* `consistency`: `consistent`(default), `cached`, or `delegated`. Currently, only effective for Docker for Mac. * `consistency`: `consistent`(default), `cached`, or `delegated`. Currently, only effective for Docker for Mac.
* `bind-nonrecursive`: `true` or `false` (default). If set to `true`, * `bind-recursive`: `enabled` (default), `disabled`, `writable`, or `readonly`:
submounts are not recursively bind-mounted. This option is useful for If set to `enabled`, submounts are recursively bind-mounted and attempted to be made recursively read-only.
`readonly` bind mount. If set to `disabled`, submounts are not recursively bind-mounted.
If set to `writable`, submounts are recursively bind-mounted but not made recursively read-only.
If set to `readonly`, submounts are recursively bind-mounted and forcibly made recursively read-only.
* `bind-nonrecursive` (Deprecated): `true` or `false` (default). Setting `true` equates to `bind-recursive=disabled`.
Setting `false` equates to `bind-recursive=enabled`.
Options specific to `volume`: Options specific to `volume`: