Skip to content

Commit

Permalink
Merge pull request containers#15758 from edsantiago/docs_dedup_rootfs
Browse files Browse the repository at this point in the history
[CI:DOCS] Man pages: refactor common options: --rootfs
  • Loading branch information
openshift-merge-robot authored Sep 13, 2022
2 parents 4aeaeaf + 09ba2e0 commit 0f39129
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 35 deletions.
19 changes: 19 additions & 0 deletions docs/source/markdown/options/rootfs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#### **--rootfs**

If specified, the first argument refers to an exploded container on the file system.

This is useful to run a container without requiring any image management, the rootfs
of the container is assumed to be managed externally.

`Overlay Rootfs Mounts`

The `:O` flag tells Podman to mount the directory from the rootfs path as
storage using the `overlay file system`. The container processes
can modify content within the mount point which is stored in the
container storage in a separate directory. In overlay terms, the source
directory will be the lower, and the container storage directory will be the
upper. Modifications to the mount point are destroyed when the container
finishes executing, similar to a tmpfs mount point being unmounted.

Note: On **SELinux** systems, the rootfs needs the correct label, which is by default
**unconfined_u:object_r:container_file_t:s0**.
17 changes: 1 addition & 16 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -418,22 +418,7 @@ Suppress output information when pulling images

Automatically remove the container when it exits. The default is *false*.

#### **--rootfs**

If specified, the first argument refers to an exploded container on the file system.

This is useful to run a container without requiring any image management, the rootfs
of the container is assumed to be managed externally.

`Overlay Rootfs Mounts`

The `:O` flag tells Podman to mount the directory from the rootfs path as
storage using the `overlay file system`. The container processes
can modify content within the mount point which is stored in the
container storage in a separate directory. In overlay terms, the source
directory will be the lower, and the container storage directory will be the
upper. Modifications to the mount point are destroyed when the container
finishes executing, similar to a tmpfs mount point being unmounted.
@@option rootfs

@@option sdnotify

Expand Down
20 changes: 1 addition & 19 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -455,25 +455,7 @@ Automatically remove the container when it exits. The default is **false**.
After exit of the container, remove the image unless another
container is using it. The default is *false*.

#### **--rootfs**

If specified, the first argument refers to an exploded container on the file system.

This is useful to run a container without requiring any image management, the rootfs
of the container is assumed to be managed externally.

`Overlay Rootfs Mounts`

The `:O` flag tells Podman to mount the directory from the rootfs path as
storage using the `overlay file system`. The container processes
can modify content within the mount point which is stored in the
container storage in a separate directory. In overlay terms, the source
directory will be the lower, and the container storage directory will be the
upper. Modifications to the mount point are destroyed when the container
finishes executing, similar to a tmpfs mount point being unmounted.

Note: On **SELinux** systems, the rootfs needs the correct label, which is by default
**unconfined_u:object_r:container_file_t**.
@@option rootfs

@@option sdnotify

Expand Down

0 comments on commit 0f39129

Please sign in to comment.