Skip to content

Commit a761985

Browse files
committed
add table for tmpfs mount options
Signed-off-by: Eric Ernst <eric_ernst@apple.com>
1 parent d5a9947 commit a761985

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

docs/volumes.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,8 @@ container stops, the mount and everything written to it are gone. You can't shar
154154
Use a `tmpfs` mount when you need high-performance storage and don't need the data to
155155
persist after the container stops.
156156
157-
Use either `--tmpfs` or `--mount type=tmpfs`. Both accept the `size` and `mode` options:
158-
`--tmpfs` takes them as a colon-separated suffix on the path, and `--mount` as
159-
comma-separated `key=value` pairs.
157+
Use either `--tmpfs` or `--mount type=tmpfs`. Both accept the `size` and `mode` options;
158+
see [Mount options](#mount-options) for the syntax each one takes.
160159
161160
Mount a `tmpfs` filesystem at `/tmpfsmount1` with `--tmpfs`:
162161
@@ -202,9 +201,9 @@ container run --rm --mount type=tmpfs,target=/tmpfsmount1,size=512M,mode=1777 al
202201

203202
## Mount options
204203

205-
Mount-time options go on `container run` or `container create`, using `--mount` or
206-
`--volume`; for `--tmpfs`, see [Tmpfs mounts](#tmpfs-mounts). Creation-time options go on
207-
`container volume create`, using `--opt`.
204+
Mount-time options go on `container run` or `container create`, using `--mount`,
205+
`--volume`, or `--tmpfs`. Creation-time options go on `container volume create`, using
206+
`--opt`.
208207

209208
### Options for `--mount`
210209

@@ -228,6 +227,15 @@ mount read-only:
228227
container run --rm --volume foo:/mnt/foo:ro alpine sh
229228
```
230229

230+
### Options for `--tmpfs`
231+
232+
`--tmpfs` uses the colon-separated form `destination[:options]`, comma-separated if there
233+
is more than one. It accepts `size` and `mode`, with the same meanings as for `--mount`:
234+
235+
```bash
236+
container run --rm --tmpfs /tmpfsmount1:size=64M,mode=1777 alpine sh
237+
```
238+
231239
### Options for `container volume create`
232240

233241
| Key | Values | Description |

0 commit comments

Comments
 (0)