spiegel_podman/docs/source/markdown/options/read-only-tmpfs.md
Jan Kaluza 7612af4c0e Rewrite the Quadlet documentation
This commit does the following:

- Splits the podman-systemd.unit.5.md into multiple files - one for each quadlet file type.
- Adds the podman-quadlet-basic-usage.7.md for quadlet examples.
- Majority of the text in the new files is copied from the podman-systemd.unit.5.md
- Adds support for very simple condditional in the markdown_preprocess.
- Uses new logic in markdown_preprocess in options/*.md to use a single .md file for both
  podman subcommands man-pages and quadlet man-pages. This deduplicates the Quadlet man-pages a lot.
- Adds new `@@option quadlet:source.md`` preprocess command to import such .md files from options directory.

Signed-off-by: Jan Kaluza <jkaluza@redhat.com>
2026-05-04 10:53:36 +02:00

33 lines
1.8 KiB
Markdown

####> This option file is used in:
####> podman podman-container.unit.5.md.in, create, run
####> If file is edited, make sure the changes
####> are applicable to all of those.
<< if is_quadlet >>
### `ReadOnlyTmpfs=true|false`
<< else >>
#### **--read-only-tmpfs**
<< endif >>
When running --read-only containers, mount a read-write tmpfs on _/dev_, _/dev/shm_, _/run_, _/tmp_, and _/var/tmp_. The default is **true**.
| --read-only | --read-only-tmpfs | / | /run, /tmp, /var/tmp|
| ----------- | ----------------- | ---- | ----------------------------------- |
| true | true | r/o | r/w |
| true | false | r/o | r/o |
| false | false | r/w | r/w |
| false | true | r/w | r/w |
When << '**ReadOnly=true**' if is_quadlet else '**--read-only=true**' >> and
<< '**ReadOnlyTmpfs=true**' if is_quadlet else '**--read-only-tmpfs=true**' >> additional tmpfs are mounted on
the /tmp, /run, and /var/tmp directories.
When << '**ReadOnly=true**' if is_quadlet else '**--read-only=true**' >> and
<< '**ReadOnlyTmpfs=false**' if is_quadlet else '**--read-only-tmpfs=false**' >> /dev and /dev/shm are marked
Read/Only and no tmpfs are mounted on /tmp, /run and /var/tmp. The directories
are exposed from the underlying image, meaning they are read-only by default.
This makes the container totally read-only. No writable directories exist within
the container. In this mode writable directories need to be added via external
volumes or mounts.
By default, when << '**ReadOnly=false**' if is_quadlet else '**--read-only=false**' >> , the /dev and /dev/shm are read/write, and the /tmp, /run, and /var/tmp are read/write directories from the container image.